ルーターの I/O タイムアウトを構成する

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

このドキュメントでは、Apigee Edge の Router で I/O タイムアウトを構成する方法について説明します。

Router の I/O タイムアウトは、接続を確立してリクエストを Message Processor に送信した後、Router が Message Processor からレスポンスを 受信するまで待機する時間を表します。Router の I/O タイムアウトのデフォルト値は 57 秒です。

Router の I/O タイムアウトは、必要に応じてデフォルト値の 57 秒 から増減できます。次の方法で構成できます。

• 仮想ホスト
• Router

Router の I/O タイムアウトは、次のプロパティによって制御されます。

ms: milliseconds
s:  seconds (default)
m:  minutes
h:  hours
d:  days
w:  weeks
M:  months (length of 30 days)
y:  years (length of 365 days)

始める前に

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

• 仮想ホストのプロパティに慣れていない場合は、 仮想ホストのプロパティ リファレンスをご覧ください。
• Edge for Private Cloud のプロパティの構成に慣れていない場合は、 Edge を構成する方法 をご覧ください。
• I/O タイムアウトの構成に関するベスト プラクティスの推奨事項 に従ってください。

仮想ホストで I/O タイムアウトを構成する

このセクションでは、組織と環境に関連付けられた仮想ホストで I/O タイムアウトを構成する方法について説明します。I/O タイムアウトは、仮想ホストで プロパティ proxy_read_timeout を使用して構成できます。これは、I/O タイムアウト値を秒単位で表します。

仮想ホストは、次のいずれかの方法で構成できます。

• Edge UI
• Edge API

仮想ホストの I/O タイムアウトを確認する

このセクションでは、Edge API を使用して仮想ホストの I/O タイムアウトが正常に変更されたことを確認する方法について説明します。

1. Get virtual host API を実行して、次の例に示すように virtualhost 構成を取得します。

   Public Cloud ユーザー

   curl -v -X GET https://api.enterprise.apigee.com/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>
                 

   Private Cloud ユーザー

   curl -v -X GET http://<management server-host>:<port #>/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>
                 

   ここで

   {organization-name} は組織の名前です

   {environment-name} は環境の名前です。

   {virtualhost-name} は仮想ホストの名前です

2. プロパティ proxy_read_timeout が新しい値に設定されていることを確認します。

   更新された仮想ホスト構成のサンプル

   {
     "hostAliases": [
       "api.myCompany,com",
     ],
     "interfaces": [],
     "listenOptions": [],
     "name": "secure",
     "port": "443",
     "retryOptions": [],
     "properties": {
       "property": [
         {
           "name": "proxy_read_timeout",
           "value": "120"
         }
       ]
     },
     "sSLInfo": {
       "ciphers": [],
       "clientAuthEnabled": "false",
       "enabled": "true",
       "ignoreValidationErrors": false,
       "keyAlias": "myCompanyKeyAlias",
       "keyStore": "ref://myCompanyKeystoreref",
       "protocols": []
     },
     "useBuiltInFreeTrialCert": false
   }

   上記の例では、proxy_read_timeout が新しい値の 120 秒に設定されています。

3. proxy_read_timeout, の古い値が表示される場合は、 仮想ホストで I/O タイムアウトを構成するで説明されているすべての手順を正しく行っていることを確認します。 手順が抜けている場合は、すべての手順をもう一度正しく繰り返します。
4. I/O タイムアウトを変更できない場合は、Apigee Edge サポートにお問い合わせください。

Router で I/O タイムアウトを構成する

このセクションでは、Router で I/O タイムアウトを構成する方法について説明します。I/O タイムアウトは、Router プロパティ conf_load_balancing_load.balancing.driver.proxy.read.timeout を使用して構成できます。これは、I/O タイムアウト値を秒単位で表します。

Router で I/O タイムアウトを構成するには、次の操作を行います。

1. Router マシンで、エディタで次のファイルを開きます。まだ存在しない場合は、作成します。

   /opt/apigee/customer/application/router.properties

   たとえば、 vi でファイルを開くには、次のコマンドを入力します。

   vi /opt/apigee/customer/application/router.properties

2. properties ファイルに次の形式で 1 行を追加し、time_in_seconds の値を置き換えます。

conf_load_balancing_load.balancing.driver.proxy.read.timeout=time_in_seconds

たとえば、Router の I/O タイムアウトを 120 秒に変更するには、次の行を追加します。

conf_load_balancing_load.balancing.driver.proxy.read.timeout=120

I/O タイムアウトを分単位で変更することもできます。たとえば、タイムアウトを 2 分に変更するには、次の行を追加します。

conf_load_balancing_load.balancing.driver.proxy.read.timeout=2m

3. 変更を保存します。
4. 次の例に示すように、このプロパティ ファイルが apigee ユーザーによって所有されていることを確認します。

   chown apigee:apigee /opt/apigee/customer/application/router.properties

5. 次の例に示すように、Router を再起動します。

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

6. 複数の Router がある場合は、すべての Router で上記の手順を繰り返します。

Router の I/O タイムアウトを確認する

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

トークン conf_load_balancing_load.balancing.driver.proxy.read.timeout を使用して Router の I/O タイムアウト を設定しても、実際のプロパティ proxy_read_timeout が 新しい値に設定されているかどうかを確認する必要があります。

1. /opt/nginx/conf.d ディレクトリでプロパティ proxy_read_timeout を検索し、次の例に示すように新しい値に設定されているかどうかを確認します。

   grep -ri "proxy_read_timeout" /opt/nginx/conf.d

2. 新しい I/O タイムアウト値が Router に正常に設定されると、上記のコマンド はすべての仮想ホスト構成ファイルに新しい値を表示します。

   I/O タイムアウトが 120 秒の場合の、上記の grep コマンドの出力例を次に示します。

   /opt/nginx/conf.d/0-default.conf:proxy_read_timeout 120;
   /opt/nginx/conf.d/0-edge-health.conf:proxy_read_timeout 1s;

   上記の出力例では、デフォルトの仮想ホストの構成ファイルである 0-default.conf で、プロパティ proxy_read_timeout が新しい値 120 に設定されています。これは、Router で I/O タイムアウト が 120 秒に正常に構成されていることを示します。

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

次のステップ

Message Processor で I/O タイムアウトを構成する方法について学習する