API Gateway API の AWS X-Ray サンプリングルールの設定 - Amazon API Gateway
API Gateway の API に関連する X-Ray のサンプリングルールのオプション値X-Ray のサンプリングルールの例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

API Gateway API の AWS X-Ray サンプリングルールの設定

AWS X-Ray コンソールまたは SDK を使用して、Amazon API Gateway API のサンプリングルールを設定できます。サンプリングルールでは、API で X-Ray が記録するリクエストを指定します。サンプリングルールをカスタマイズすることで、コードを変更または再デプロイすることなく、その場で、記録するレコードの量を制御したり、サンプリング動作を変更したりできます。

X-Ray のサンプリングルールを指定する前に、X-Ray デベロッパーガイドの以下のトピックを参照してください。

API Gateway の API に関連する X-Ray のサンプリングルールのオプション値

API Gateway に関連する X-Ray のサンプリングのオプションを以下に示します。文字列値では、ワイルドカードを使用して、1 つの文字列 (?) またはゼロ以上の文字 (*) に一致させることができます。[リザーバ] および [レート] 設定の使用に関する詳細な説明を含む詳細については、「AWS X-Ray コンソールでのサンプリングルールの設定」を参照してください。

  • [Rule name (ルール名)] (文字列) - ルールの一意の名前。

  • [Priority (優先度)] (1～9999 の整数) - サンプリングルールの優先度。サービスでは、優先度の昇順でルールが評価され、一致する最初のルールを使用してサンプリングの決定が行われます。

  • [Reservoir (リザーバ)] (負ではない整数) - 固定レートを適用するまでに 1 秒あたりの一致するリクエストを計測する上限の固定数。リザーバはサービスで直接使用されませんが、ルールを一括して使用するすべてのサービスに適用されます。

  • [Rate (レート)] (0～100) - リザーバの上限に達した後に一致するリクエストを計測するサンプリング率。

  • [Service name (サービス名)] (文字列) - {api-name}/{stage-name} 形式の API のステージ名。たとえば、PetStore サンプル API を test というステージにデプロイする場合、サンプリングルールで指定する [サービス名] の値は pets/test となります。

  • [Service type (サービスタイプ)] (文字列) - API Gateway の API では、AWS::ApiGateway::Stage または AWS::ApiGateway::* を指定できます。

  • [Host (ホスト)] (文字列) - HTTP ヘッダーの Host のホスト名。これを * に設定すると、すべてのホスト名に対して一致します。または、一致させる完全なホスト名または部分的なホスト名を指定できます (例: api.example.com または *.example.com)。

  • [Resource ARN] (リソース ARN) (文字列) - API ステージの ARN (arn:aws:apigateway:region::/restapis/api-id/stages/stage-name など)。

    ステージ名は、コンソールや API Gateway の CLI または API から取得できます。ARN 形式の詳細については、「Amazon Web Services 全般のリファレンス」を参照してください。

  • [HTTP method (HTTP メソッド)] (文字列) - サンプリングするメソッド (例: GET)。

  • [URL path] (URL パス) (文字列) — リクエストの URL パス。

  • (オプション) [Attributes (属性)] (キーと値) - 元の HTTP リクエストのヘッダー (例: Connection、Content-Length、Content-Type)。各属性の値は、最大 32 文字とすることができます。

X-Ray のサンプリングルールの例

サンプリングルールの例 1

このルールでは、GET ステージの testxray API に対するすべての test リクエストをサンプリングします。

  • ルール名 - test-sampling

  • 優先度 - 17

  • リザーバのサイズ - 10

  • 固定レート - 10

  • サービス名 - testxray/test

  • サービスタイプ - AWS::ApiGateway::Stage

  • HTTP メソッド - GET

  • リソース ARN - *

  • ホスト - *

サンプリングルールの例 2

このルールでは、testxray ステージの prod API に対するすべてのリクエストをサンプリングします。

  • ルール名 - prod-sampling

  • 優先度 - 478

  • リザーバのサイズ - 1

  • 固定レート - 60

  • サービス名 - testxray/prod

  • サービスタイプ - AWS::ApiGateway::Stage

  • HTTP メソッド - *

  • リソース ARN - *

  • ホスト - *

  • 属性 - {}