Message Processor の keep-alive タイムアウトを構成する

ここに表示されているのは Apigee Edge のドキュメントです。
Go to the Apigee X のドキュメントに移動します。 info

このドキュメントでは、Apigee Edge Message Processor の keep-alive タイムアウトを構成する方法について説明します。

Message Processor の keep-alive タイムアウトを使用すると、リクエスト / レスポンスごとに新しい接続を開くのではなく、単一の TCP 接続でバックエンド サーバーとの間で複数の HTTP リクエスト / レスポンスを送受信できます。

Message Processor の keep-alive タイムアウト プロパティのデフォルト値は 60 秒です。このタイムアウト期間は、ターゲット エンドポイント構成と API プロキシの ServiceCallout ポリシーで構成されたバックエンド サーバーに適用されます。

Message Processor の keep-alive タイムアウトは、必要に応じてデフォルト値 の 60 秒から増減できます。次の方法で構成できます。

  • API プロキシ:
    • ターゲット エンドポイント
    • ServiceCallout ポリシー
  • Message Processor

Message Processor の keep-alive タイムアウトは、次のプロパティによって制御されます。

プロパティ名 ロケーション 説明
keepalive.timeout.millis API プロキシ:
  • ターゲット エンドポイント
  • ServiceCallout ポリシー

これは、リクエスト/レスポンスごとに新しい接続を開くのではなく、単一の TCP 接続で複数の HTTP リクエスト/レスポンスを送受信できる Message Processor の最大アイドル時間です。

デフォルトでは、このプロパティは Message Processor の HTTPClient.keepalive.timeout.millis プロパティに設定された値を取得します。デフォルト値は 60 秒です。

特定の API プロキシのターゲット エンドポイントまたは ServiceCallout ポリシーで使用されるターゲット サーバーの新しいタイムアウト値でこのプロパティを変更すると、その特定のターゲット サーバーの keep-alive 時間のみが影響を受けます。
HTTPClient.keepalive.timeout.millis Message Processor

これは、リクエスト/レスポンスごとに新しい接続を開くのではなく、単一の TCP 接続で複数の HTTP リクエスト/レスポンスを送受信できる Message Processor の最大アイドル時間です。

このプロパティは、この Message Processor で実行されているすべての API プロキシで使用されます。

このプロパティのデフォルト値は 60 秒です。

このプロパティは、以下の Message Processor の keep-alive タイムアウトを構成する で説明されているように変更できます。また、API プロキシ レベルで keepalive.timeout.millis プロパティを設定して、この値を上書きすることもできます。

始める前に

このドキュメントの手順を行う前に、次のトピックを理解しておいてください。

API プロキシで keep-alive タイムアウトを構成する

keep-alive タイムアウトは、API プロキシの次の場所で構成できます。

  • ターゲット エンドポイント
  • ServiceCallout ポリシー

API プロキシのターゲット エンドポイントで keep-alive タイムアウトを構成する

このセクションでは、API プロキシのターゲット エンドポイントで keep-alive タイムアウトを構成する方法について説明します。 keep-alive タイムアウトは、keep-alive タイムアウト値を ミリ秒単位で表すプロパティ keepalive.timeout.millis を使用して構成できます。

  1. Edge UI で、新しい keep-alive タイムアウト値を構成する特定の API プロキシを選択します。
  2. 変更する特定のターゲット エンドポイントを選択します。

  3. TargetEndpoint 構成の <HTTPTargetConnection> 要素の下に、適切な値を持つプロパティ keepalive.timeout.millis を追加します。

    たとえば、keep-alive タイムアウトを 30 秒に変更するには、次のコードブロックを追加します。

    <Properties>
  <Property name="keepalive.timeout.millis">30000</Property>
</Properties>

    keepalive.timeout.millis プロパティはミリ秒単位であるため、 30 秒の値は 30000 です。

    次の例は、API プロキシのターゲット エンドポイント 構成で keep-alive タイムアウトを構成する方法を示しています:

    バックエンド サーバーの URL を使用したターゲット エンドポイント構成の例 

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

    ターゲット サーバーを使用したターゲット エンドポイント構成の例 

    <TargetEndpoint name="default">
  <HTTPTargetConnection>
    <LoadBalancer>
      <Server name="target1" />
      <Server name="target2" />
    </LoadBalancer>
    <Properties>
      <Property name="keepalive.timeout.millis">30000</Property>
    </Properties>
    <Path>/test</Path>
  </HTTPTargetConnection>
</TargetEndpoint>
  4. API プロキシに対する変更を保存します。

API プロキシの ServiceCallout ポリシーで keep-alive タイムアウトを構成する

このセクションでは、API プロキシの ServiceCallout ポリシーで keep-alive タイムアウトを構成する方法について説明します。keep-alive タイムアウトは、 プロパティ the keepalive.timeout.millisを使用して構成できます。これは、 keep-alive タイムアウト値をミリ秒単位で表します。

ServiceCallout ポリシーで keep-alive タイムアウトを構成するには、 keepalive.timeout.millis プロパティを使用します:

  1. Edge UI で、ServiceCallout ポリシーの新しい keep-alive タイムアウト値を構成する特定の API プロキシを選択します。
  2. 変更する特定の ServiceCallout ポリシーを選択します。
  3. TargetEndpoint 構成の <HTTPTargetConnection> 要素の下に、適切な値を持つプロパティ keepalive.timeout.millis を追加します。

    たとえば、keep-alive タイムアウトを 30 秒に変更するには、次のコードブロックを追加します。

    <Properties>
  <Property name="keepalive.timeout.millis">30000</Property>
</Properties>

    keepalive.timeout.millis プロパティはミリ秒単位であるため、 30 秒の値は 30000 です。

    次の例は、API プロキシの ServiceCallout ポリシーで keep-alive タイムアウトを構成する方法を示しています:

    バックエンド サーバーの URL を使用した ServiceCallout ポリシー構成の例 

    <ServiceCallout name="Service-Callout-1">
  <DisplayName>Service Callout-1</DisplayName>
  <HTTPTargetConnection>
    <Properties>
      <Property name="keepalive.timeout.millis">30000</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="keepalive.timeout.millis">30000</Property>
    </Properties>
    <Path>/test</Path>
  </HTTPTargetConnection>
</ServiceCallout>
  4. API プロキシに対する変更を保存します。

Message Processor の keep-alive タイムアウトを構成する

このセクションでは、Message Processor の keep-alive タイムアウトを構成する方法について説明します。keep-alive タイムアウトは、Message Processor コンポーネントの keep-alive タイムアウト値をミリ秒単位で表すプロパティ HTTPClient.keepalive.timeout.millis を使用して構成できます。このプロパティは Message Processor でコメントアウトされているため、 Edge を構成する方法の 現在コメントアウトされているトークンを設定するで説明されているように、特殊な構文 conf/http.properties+HTTPClient.keepalive.timeout.millis を使用する必要があります。

Message Processor の keep-alive タイムアウトを構成するには、次の操作を行います。

  1. Message Processor マシンで、エディタで次のファイルを開きます。まだ存在しない場合は、作成します。 
    /opt/apigee/customer/application/message-processor.properties

    たとえば、 vi を使用してファイルを開くには、次のように入力します。

    vi /opt/apigee/customer/application/message-processor.properties
  2. プロパティ ファイルに次の形式で 1 行を追加し、 TIME_IN_MILLISECONDS の値を置き換えます。 
    conf/http.properties+HTTPClient.keepalive.timeout.millis=TIME_IN_MILLISECONDS

    たとえば、Message Processor の keep-alive タイムアウトを 30 秒に変更するには、次の行を追加します: 

    conf/http.properties+HTTPClient.keepalive.timeout.millis=30000
  3. 変更を保存します。
  4. プロパティ ファイルが、次のように apigee ユーザーによって所有されていることを確認します。 
    chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
  5. 次のように Message Processor を再起動します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart
  6. 複数の Message Processor がある場合は、すべての Message Processor で上記の手順を繰り返します。

Message Processor の keep-alive タイムアウトを確認する

このセクションでは、Message Processor で keep-alive タイムアウトが正常に変更されたことを確認する方法について説明します。

特殊な構文 conf/http.properties+HTTPClient.keepalive.timeout.millis を使用して Message Processor の keep-alive タイムアウトを設定しても、実際のプロパティ HTTPClient.keepalive.timeout.millis が新しい値で設定されているかどうかを確認する必要があります。

  1. Message Processor マシンで、 HTTPClient.keepalive.timeout.millis ディレクトリ内のプロパティ /opt/apigee/edge-message-processor/conf を検索し、次のように新しい値で設定されているかどうかを確認します。 
    grep -ri "HTTPClient.keepalive.timeout.millis" /opt/apigee/edge-message-processor/conf

  2. Message Processor で新しい keep-alive タイムアウト値が正常に設定されると、 上記のコマンドで http.properties ファイルに新しい値が表示されます。

    keep-alive タイムアウトを 30 秒に構成した後の上記のコマンドの出力例は次のとおりです。

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

    上記の出力例では、プロパティ HTTPClient.keepalive.timeout.millis が http.properties の新しい値 30000 で設定されています。これは、Message Processor で keep-alive タイムアウトが 30 秒に正常に構成されたことを示します。

  3. プロパティ HTTPClient.keepalive.timeout.millis の古い値が表示される場合は、 Message Processor の keep-alive タイムアウトを構成する で説明されているすべての手順を正しく行っていることを確認してください。手順が抜けている場合は、すべての手順をもう一度正しく繰り返します。
  4. keep-alive タイムアウトを変更できない場合は、 Google Cloud Apigee Edge サポートにお問い合わせください。