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

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報

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

Message Processor のキープアライブ タイムアウトを使用すると、リクエストとレスポンスのペアごとに新しい接続を開かなくても、1 つの TCP 接続でバックエンド サーバーとの間で複数の HTTP リクエスト / レスポンスを送受信できます。

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

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

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

Message Processor のキープアライブ タイムアウトを制御するプロパティは次のとおりです。

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

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

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

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

これは、Message Processor がリクエスト/レスポンスのペアごとに新しい接続を開かずに、1 つの TCP 接続で複数の HTTP リクエスト/レスポンスを送受信できるようにする最大アイドル時間です。

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

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

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

始める前に

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

API プロキシでキープアライブ タイムアウトを構成する

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

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

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

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

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

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

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

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

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

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

    バックエンド サーバーの 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 ポリシーでキープアライブ タイムアウトを構成する

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

keepalive.timeout.millis プロパティを使用して ServiceCallout ポリシーでキープアライブ タイムアウトを構成するには:

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

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

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

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

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

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

Message Processor でキープアライブ タイムアウトを構成するには、次の操作を行います。

  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.properties+HTTPClient.keepalive.timeout.millis=TIME_IN_MILLISECONDS

    たとえば、Message Processor のキープアライブ タイムアウトを 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 でキープアライブ タイムアウトが正しく変更されていることを確認する方法について説明します。

特殊な構文 conf/http.properties+HTTPClient.keepalive.timeout.millis を使用して Message Processor でキープアライブ タイムアウトを設定した場合でも、実際のプロパティ HTTPClient.keepalive.timeout.millis に新しい値が設定されていることを確認する必要があります。

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

  2. Message Processor で新しいキープアライブ タイムアウト値が正常に設定されると、上記のコマンドによって http.properties ファイルに新しい値が表示されます。

    キープアライブ タイムアウトを 30 秒に構成した後の上記のコマンドの結果のサンプルは次のとおりです。 

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

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

  3. プロパティ HTTPClient.keepalive.timeout.millis に古い値が引き続き表示される場合は、Message Processor の keep-alive タイムアウトの構成に記載されているすべての手順を正しく実行しているか確認してください。見落とした手順がある場合は、すべての手順を正しく繰り返します。
  4. それでもキープアライブ タイムアウトを変更できない場合は、Google Cloud Apigee Edge サポートにお問い合わせください。