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

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

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

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

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

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

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

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

プロパティ名 ロケーション 説明
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 の keep-alive タイムアウトを構成する方法について説明します。キープアライブ タイムアウトは、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 で keep-alive タイムアウトが正しく変更されていることを確認する方法について説明します。

Message Processor でキープアライブ タイムアウトを設定するのに特別な構文 conf/http.properties+HTTPClient.keepalive.timeout.millis を使用する場合でも、実際のプロパティ 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
    

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

  3. プロパティ HTTPClient.keepalive.timeout.millis に古い値が引き続き表示される場合は、Message Processor のキープアライブ タイムアウトの構成で説明されているすべての手順が正しく行われていることを確認します。ステップを見逃した場合は、すべてのステップをもう一度正しくやり直します。
  4. それでもキープアライブ タイムアウトを変更できない場合は、Google Cloud Apigee Edge サポートにお問い合わせください。