設定訊息處理器的連線逾時

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

本文說明如何設定 Apigee Edge 訊息處理器的連線逾時。

連線逾時代表訊息處理器等待與目標伺服器建立連線的時間。訊息處理器的連線逾時屬性的預設值是 3 秒。這項逾時期間適用於目標端點設定中指定的後端伺服器,以及 API Proxy 的 ServiceCallout 政策中。

您可以根據自己的需求,增加或減少訊息處理工具的連線逾時時間,做法為 3 秒的預設值。您可以用以下方式設定:

  • 在 API Proxy 中
    • 在目標端點中
    • ServiceCallout 政策中
  • 在訊息處理器上

下列屬性可控制訊息處理器的連線逾時:

資源名稱 位置 說明
connect.timeout.millis API Proxy:
  • 目標端點
  • ServiceCallout 政策

這是訊息處理器等待連線目標伺服器的時間上限。

根據預設,這個屬性會採用針對訊息處理器設定的 HTTPClient.connect.timeout.millis 屬性值,其中預設值為 3 秒。

如果針對與 API Proxy 相關聯的目標伺服器使用新的逾時值修改這項屬性,則只有該目標伺服器的連線時間會受到影響。

HTTPClient.connect.timeout.millis 訊息處理器

這是訊息處理器等待連線至目標伺服器的時間上限。

這項屬性會用於這個訊息處理器中執行的所有 API Proxy。

此屬性的預設值為 3 秒。

您可以依照下方的「 設定訊息處理器的連線逾時」一節來修改這個屬性,也可以在 API Proxy 層級設定 connect.timeout.millis 屬性來覆寫這個值。

事前準備

使用本文件中的步驟前,請務必瞭解下列主題:

設定 API Proxy 的連線逾時

您可以在 API Proxy 中的下列位置設定連線逾時:

  • 目標端點
  • ServiceCallout」政策

設定 API Proxy 目標端點的連線逾時

本節說明如何在 API Proxy 的目標端點中設定連線逾時。您可以透過屬性 connect.timeout.millis (代表連線逾時值 (毫秒)) 設定連線逾時。

  1. 在 Edge UI 中,選取要用來設定新連線逾時值的特定 API Proxy。
  2. 選取您要修改的特定目標端點。
  3. TargetEndpoint 設定的 <HTTPTargetConnection> 元素下方,為含有適當值的屬性新增 connect.timeout.millis

    舉例來說,如要將連線逾時時間變更為 5 秒,請新增下列程式碼區塊:

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

    由於 connect.timeout.millis 屬性以毫秒為單位,因此 5 秒的值為 5000

    以下範例說明如何在 API Proxy 的目標端點設定中設定連線逾時:

    使用後端伺服器的網址設定目標端點設定範例

    <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 Proxy 所做的變更。

在 API Proxy 的服務呼叫政策中設定連線逾時

本節說明如何在 API Proxy 的 ServiceCallout 政策中設定連線逾時。您可以透過 connect.timeout.millis 屬性設定連線逾時,屬性代表連線時間值 (以毫秒為單位)。

如要在 ServiceCallout 政策中使用 connect.timeout.millis 屬性設定連線逾時,請執行下列操作:

  1. 在 Edge UI 中,選取要為 ServiceCallout 政策設定新連線逾時值的特定 API Proxy。
  2. 選取要修改的特定 ServiceCallout 政策。
  3. TargetEndpoint 設定的 <HTTPTargetConnection> 元素下方,為含有適當值的屬性 connect.timeout.millis

    舉例來說,如要將連線逾時時間變更為 5 秒,請加入下列程式碼區塊:

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

    由於 connect.timeout.millis 屬性以毫秒為單位,因此 5 秒的值為 5000

    以下範例說明如何在 API Proxy 的 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>
    

    使用目標伺服器的 Service Call 政策設定範例

    <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 Proxy 所做的變更。

設定訊息處理器的連線逾時

本節說明如何設定「訊息處理器」的連線逾時。您可以透過 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
    

    請注意,在上述輸出範例中,請注意 http.properties 中的新值 5000 已設為 HTTPClient.connect.timeout.millis 屬性。這表示訊息處理器的連線逾時已成功設為 5 秒。

  3. 如果還是看到屬性 HTTPClient.connect.timeout.millis 的舊值,請確認您已正確遵循「設定訊息處理器的連線逾時」一文所述的所有步驟。如果您錯過任何步驟,請再次正確重複所有步驟。
  4. 如果仍無法修改連線逾時,請與 Google Cloud Apigee Edge 支援團隊聯絡。