在消息处理器上配置连接超时

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

本文档介绍如何为 Apigee Edge 消息处理器配置连接超时。

连接超时表示消息处理器等待与目标服务器建立连接的时间。在消息处理器上，连接超时属性的默认值为 3 秒。此超时期限适用于在目标端点配置和 API 代理的 ServiceCallout 政策中配置的后端服务器。

您可以根据自己的需求，将消息处理器的连接超时时长从默认值（3 秒）增加或缩短。它可以通过以下方式进行配置：

• 在 API 代理中
  • 在目标端点中
  • 在 ServiceCallout 政策中
• 在消息处理器上

以下属性用于控制消息处理器上的连接超时：

属性名称	位置	说明
connect.timeout.millis	API 代理： 目标端点 ServiceCallout 政策	这是消息处理器与目标服务器连接时等待的最长时间。 默认情况下，此属性采用为消息处理器上的 HTTPClient.connect.timeout.millis 属性设置的值，其中默认值为 3 秒。 如果使用与 API 代理关联的目标服务器的新超时值修改此属性，则仅该目标服务器的连接时间会受到影响。
HTTPClient.connect.timeout.millis	消息处理器	这是消息处理器连接到目标服务器时等待的最长时间。 此属性用于此消息处理器上运行的所有 API 代理。 此属性的默认值为 3 秒。 您可以按照下方 在消息处理器上配置连接超时中的说明修改此属性，也可以通过在 API 代理级别设置 connect.timeout.millis 属性来覆盖此值。

准备工作

在使用本文档中的步骤之前，请务必了解以下主题：

• 如果您不熟悉连接超时，请参阅 TargetEndpoint 传输属性规范中的 connect.timeout.millis 属性说明。
• 如果您不熟悉如何在 Private Cloud 上配置 Edge 的属性，请参阅如何配置 Edge。

在 API 代理中配置连接超时

您可以在 API 代理中的以下位置配置连接超时：

• 目标端点
• ServiceCallout 政策

在 API 代理的目标端点中配置连接超时

本部分介绍如何在 API 代理的目标端点中配置连接超时。 您可以通过 connect.timeout.millis 属性配置连接超时，该属性表示连接超时值（以毫秒为单位）。

1. 在 Edge 界面中，选择要配置新的连接超时值的具体 API 代理。
2. 选择您要修改的特定目标端点。
3. 在 TargetEndpoint 配置中的 <HTTPTargetConnection> 元素下，添加具有适当值的 connect.timeout.millis 属性。

   例如，如需将连接超时更改为 5 秒，请添加以下代码块：

   <Properties>
     <Property name="connect.timeout.millis">5000</Property>
   </Properties>
   

   由于 connect.timeout.millis 属性以毫秒为单位，因此 5 秒的值为 5000。

   以下示例展示了如何在 API 代理的目标端点配置中配置连接超时：

   使用后端服务器网址的目标端点配置示例

   <TargetEndpoint name="default">
     <HTTPTargetConnection>
       <URL>https://mocktarget.apigee.net/json</URL>
       <Properties>
         <Property name="connect.timeout.millis">5000</Property>
       </Properties>
     </HTTPTargetConnection>
   </TargetEndpoint>
   

   使用目标服务器配置目标端点的示例

   <TargetEndpoint name="default">
     <HTTPTargetConnection>
       <LoadBalancer>
         <Server name="target1" />
         <Server name="target2" />
       </LoadBalancer>
       <Properties>
         <Property name="connect.timeout.millis">5000</Property>
       </Properties>
       <Path>/test</Path>
     </HTTPTargetConnection>
   </TargetEndpoint>
   

4. 保存对 API 代理所做的更改。

在 API 代理的 ServiceCallout 政策中配置连接超时

本部分介绍如何在 API 代理的 ServiceCallout 政策中配置连接超时。您可以通过 connect.timeout.millis 属性配置连接超时，该属性表示连接时间值（以毫秒为单位）。

如需使用 connect.timeout.millis 属性在 ServiceCallout 政策中配置连接超时，请执行以下操作：

1. 在 Edge 界面中，选择要为 ServiceCallout 政策配置新连接超时值的特定 API 代理。
2. 选择要修改的特定 ServiceCallout 政策。
3. 在 TargetEndpoint 配置中的 <HTTPTargetConnection> 元素下，添加具有适当值的 connect.timeout.millis 属性。

   例如，要将连接超时更改为 5 秒，请添加以下代码块：

   <Properties>
     <Property name="connect.timeout.millis">5000</Property>
   </Properties>
   

   由于 connect.timeout.millis 属性以毫秒为单位，因此 5 秒的值为 5000。

   以下示例展示了如何在 API 代理的 ServiceCallout 政策中配置连接超时：

   使用后端服务器网址的 ServiceCallout 政策配置示例

   <ServiceCallout name="Service-Callout-1">
     <DisplayName>Service Callout-1</DisplayName>
     <HTTPTargetConnection>
       <Properties>
         <Property name="connect.timeout.millis">5000</Property>
       </Properties>
       <URL>https://mocktarget.apigee.net/json</URL>
     </HTTPTargetConnection>
   </ServiceCallout>
   

   使用目标服务器的 ServiceCallout 政策配置示例

   <ServiceCallout enabled="true" name="Service-Callout-1">
     <DisplayName>Service Callout-1</DisplayName>
     <Response>calloutResponse</Response>
     <HTTPTargetConnection>
       <LoadBalancer>
         <Server name="target1" />
         <Server name="target2" />
       </LoadBalancer>
       <Properties>
         <Property name="connect.timeout.millis">5000</Property>
       </Properties>
     <Path>/test</Path>
     </HTTPTargetConnection>
   </ServiceCallout>
   

4. 保存对 API 代理所做的更改。

在消息处理器上配置连接超时

本部分介绍如何在消息处理器上配置连接超时。 连接超时可通过属性 conf_http_HTTPClient.connect.timeout.millis 进行配置，该属性表示消息处理器组件上的连接超时值（以毫秒为单位），使用相应令牌（根据 如何配置 Edge 中所述）。

如需在消息处理器上配置连接超时，请执行以下操作：

1. 在 Message Processor 计算机上，在编辑器中打开以下文件。如果不存在，则创建它。

   /opt/apigee/customer/application/message-processor.properties
   

   例如，要使用 vi 打开文件，请输入以下命令：

   vi /opt/apigee/customer/application/message-processor.properties
   

2. 按以下格式向属性文件添加一行代码，并将 TIME_IN_MILLISECONDS 替换成一个值：

   conf_http_HTTPClient.connect.timeout.millis=TIME_IN_MILLISECONDS
   

   例如，如需将消息处理器上的连接超时更改为 5 秒，请添加以下行：

   conf_http_HTTPClient.connect.timeout.millis=5000
   

3. 保存更改。
4. 确保属性文件归 apigee 用户所有，如下所示：

   chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
   

5. 重启消息处理器，如下所示：

   /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart
   

6. 如果您有多个消息处理器，请对所有消息处理器重复上述步骤。

验证消息处理器上的连接超时

本部分介绍如何验证消息处理器上的连接超时是否已成功修改。

即使您使用令牌 conf_http_HTTPClient.connect.timeout.millis 在消息处理器上设置连接超时，您也需要验证实际属性 HTTPClient.connect.timeout.millis 是否已设置为新值。

1. 在消息处理器机器上，在 /opt/apigee/edge-message-processor/conf 目录中搜索属性 HTTPTransport.connect.timeout.millis，并检查它是否已使用新值进行设置，如下所示：

   grep -ri "HTTPClient.connect.timeout.millis" /opt/apigee/edge-message-processor/conf
   

2. 如果在消息处理器上成功设置了新的连接超时值，则上述命令会在 http.properties 文件中显示新值。

   将连接超时配置为 5 秒后，上述命令产生的示例结果如下所示：

   /opt/apigee/edge-message-processor/conf/http.properties:HTTPClient.connect.timeout.millis=5000
   

   在上面的示例输出中，请注意 HTTPClient.connect.timeout.millis 属性已在 http.properties 中使用新值 5000 进行设置。这表示消息处理器上的连接超时已成功配置为 5 秒。

3. 如果您仍然看到属性 HTTPClient.connect.timeout.millis 的旧值，请验证是否已正确按照在消息处理器上配置连接超时中所述的所有步骤进行操作。如果您遗漏了任何步骤，请重新正确重复所有步骤。
4. 如果您仍无法修改连接超时设置，请与 Google Cloud Apigee Edge 支持团队联系。