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

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
信息

<ph type="x-smartling-placeholder">

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

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

根据您的需要,消息处理器的连接超时可在 3 秒的默认值的基础上增加或减少。可以通过以下方式进行配置:

  • 在 API 代理中 <ph type="x-smartling-placeholder">
      </ph>
    • 在目标端点中
    • ServiceCallout 政策中
  • 在消息处理器上
。 <ph type="x-smartling-placeholder">

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

属性名称 位置 说明
connect.timeout.millis API 代理: <ph type="x-smartling-placeholder">
    </ph>
  • 目标端点
  • ServiceCallout政策

这是消息处理器等待与目标服务器连接的最长时间。

默认情况下,此属性采用为 消息处理器上的 HTTPClient.connect.timeout.millis 属性, 其中默认值为 3 秒。

修改此属性时,如果为关联的目标服务器设置新的超时值, 那么只有该目标服务器的连接时间会受到影响。

HTTPClient.connect.timeout.millis 消息处理器

这是消息处理器等待连接到目标服务器的最长时间。

此属性用于此消息处理器上运行的所有 API 代理。

此属性的默认值为 3 秒。

您可以按照中的说明修改此属性。 配置消息处理器的连接超时(见下文),您也可以覆盖此值 方法是在 API 代理级别设置 connect.timeout.millis 属性。

准备工作

在使用本文档中的步骤之前,请确保您了解以下主题:

在 API 代理中配置连接超时

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

  • 目标端点
  • ServiceCallout政策

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

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

<ph type="x-smartling-placeholder">。 <ph type="x-smartling-placeholder">
  1. 在 Edge 界面中,选择您要在其中配置新 API 代理的特定 API 代理 连接超时值。
  2. 选择要修改的特定目标端点。
  3. 将属性 connect.timeout.millis 添加到 TargetEndpoint 配置中的 <HTTPTargetConnection> 元素。

    例如,如需将连接超时时间更改为 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 政策中配置连接超时

本部分介绍了如何在 ServiceCallout 中配置连接超时。 API 代理政策。您可以通过 connect.timeout.millis 属性:表示连接时间值, 毫秒。

<ph type="x-smartling-placeholder">。 <ph type="x-smartling-placeholder">

如需使用ServiceCallout connect.timeout.millis 属性:

  1. 在 Edge 界面中,选择您要在其中配置新 API 代理的特定 API 代理 ServiceCallout 政策的连接超时值。
  2. 选择要修改的特定 ServiceCallout 政策。
  3. 将属性 connect.timeout.millis 添加到 TargetEndpoint 配置中的 <HTTPTargetConnection> 元素。

    例如,如需将连接超时时间更改为 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

<ph type="x-smartling-placeholder">。 <ph type="x-smartling-placeholder">

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

  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. 在消息处理器计算机上,搜索属性 HTTPTransport.connect.timeout.millis/opt/apigee/edge-message-processor/conf 目录,并检查其是否 新值,如下所示:
    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 支持团队联系。