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

您正在查看 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 属性说明。
• 如果您不熟悉如何为 Edge Private Cloud 配置属性，请参阅如何配置 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. 在消息处理器机器上，通过编辑器打开以下文件。如果该目录尚不存在，则创建该目录。

   /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 支持团队联系。