AWS X-Ray の Amazon API Gateway のアクティブトレースサポート - AWS X-Ray

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

AWS X-Ray の Amazon API Gateway のアクティブトレースサポート

X-Ray を使用すると、Amazon API Gateway API から基盤となるサービスへのユーザーリクエストのトレースと分析を行うことができます。API Gateway では、API Gateway のエンドポイントタイプすべてに対して X-Ray リージョン、エッジ最適化、プライベート。X-Ray と Amazon API Gateway は、X-Ray を利用できるすべての AWS リージョンで一緒に使用できます。詳細については、「」を参照してください。AWS X-Ray を使用した API Gateway API 実行のトレースAmazon API Gateway 開発者ガイドの「」を参照してください。

注記

X-Rayは、APIAPI Gateway を介したREST APIのトレースのみをサポートしています。

Amazon API Gateway では、アクティブトレースAWS X-Ray のサポート。API ステージのアクティブトレースを有効にして、受信リクエストをサンプリングし、X-Ray にトレースを送信します。

API ステージでアクティブトレースを有効にするには

  1. API Gateway (https://console.aws.amazon.com/apigateway) コンソールを開きます。

  2. API の選択

  3. ステージを選択します。

  4. [Logs/Tracing] タブで、[X-Ray トレースを有効にする] を選択します。

  5. 左側のナビゲーションパネルで、[Resources] を選択します。

  6. 新しい設定で API を再デプロイするには、[Actions][Deploy API] の順に選択します。

API Gateway では、X-Ray コンソールで定義したサンプリングルールを使用し、記録するリクエストが決定されます。API のみに適用されるルールを作成する、または特定のヘッダーを含むリクエストにのみ適用されるルールを作成することができます。API Gateway は、ステージおよびリクエストの詳細と共に、セグメントの属性にあるヘッダーを記録します。詳細については、「X-Ray コンソールでのサンプリングルールの設定」を参照してください。

すべての受信リクエストについて、API Gateway はトレースヘッダーまだない場合、受信 HTTP リクエストに適用されます。

X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793

トレース ID 形式

trace_id は 3 つの数字で構成され、ハイフンで区切られます。例:1-58406520-a006649127e371903a2de979。ここでは次の点について説明します。

  • バージョン番号。1 です。

  • 元のリクエストの時刻。Unix エポック時間で、8 桁の 16 進数です。

    たとえば、2016 年 12 月 1 日 10:00 AM PST のエポック時間は 1480615200 秒、または 16 進数で 58406520 です。

  • トレースの 96 ビットの識別子。グローバルに一意であり、24 桁の 16 進数です。

アクティブなトレースが無効になっている場合でも、リクエストがサンプリングされ、かつトレースが開始されているサービスからのリクエストが送信された場合は、ステージによりセグメントが記録されます。たとえば、搭載されたウェブアプリケーションが HTTP クライアントを使用して API Gateway API を呼び出すことができます。X-Ray SDK を使用して HTTP クライアントを導入すると、サンプリングデシジョンを含む発信リクエストにトレースヘッダーが追加されます。API Gateway は、トレーシングヘッダーを読み取り、サンプリングされたリクエストのセグメントを作成します。

API Gateway を使用してAPI用のJava SDKを生成するAWS SDK クライアントを手動で計測するのと同じ方法で、クライアントビルダーでリクエストハンドラーを追加して SDK クライアントを計測できます。手順については、「AWS SDK for Java 用 Java 用」を参照してください。