メニュー
AWS X-Ray
開発者ガイド

AWS X-Ray の概念

AWS X-Ray は、サービスからセグメント形式でデータを受け取ります。X-Ray は、トレースへの共通リクエストを含むセグメントをグループ化します。X-Ray は、トレースを処理して、アプリケーションのビジュアル表現を提供するサービスグラフを生成します。

セグメント

アプリケーションロジックを実行しているコンピューティングリソースは、セグメントとしての動作に関するデータを送信します。セグメントには、リソース名、リクエストの詳細、行った作業の詳細が含まれています。たとえば、HTTP リクエストがアプリケーションに到達すると、次のデータが記録されます。

  • ホスト – ホスト名、エイリアスまたは IP アドレス

  • リクエスト – メソッド、クライアントアドレス、パス、ユーザーエージェント

  • レスポンス – ステータス、コンテンツ

  • 行った作業 – 開始および終了時刻、サブセグメント

  • 発生する問題 エラー、障害、例外 (例外スタックの自動取得を含む)

 Scorekeep のセグメントデータ

X-Ray SDK はリクエストおよびレスポンスのヘッダー、アプリケーションのコード、およびそれを実行する AWS リソースに関するメタデータから情報を収集します。収集するデータを選択するには、アプリケーション設定、または受信リクエスト、ダウンストリームリクエスト、AWS SDK クライアントを計測するコードを変更します。

転送されたリクエスト

ロードバランサーなどを仲介してリクエストがアプリケーションに転送される場合、X-Ray では、IP パケットのソース IP からではなくリクエストの X-Forwarded-For ヘッダーからクライアント IP を取得します。転送されたリクエストに記録されているクライアント IP は偽造されている可能性があるため、信頼すべきではありません。

X-Ray SDK を使用して、注釈やメタデータなどの追加情報を記録します。セグメントおよびサブセグメントで記録されている構造および情報に関する詳細については、「AWS X-Ray セグメントドキュメント」を参照してください。セグメントのドキュメントのサイズは最大 64 kB まで可能です。

サブセグメント

セグメントでは、完了した作業に関するデータをサブセグメントに分けることができます。サブセグメントには、詳細なタイミング情報や、元のリクエストを満たすためにアプリケーションが実行したダウンストリーム呼び出しに関する詳細を含みます。サブセグメントには、AWS のサービス、外部 HTTP API、SQL データベースに対する呼び出しに関する追加の詳細を含めることができます。アプリケーションのコードの特定の関数または行を計測する任意のサブセグメントを定義することもできます。

 サブセグメントに含まれる詳細情報

Amazon DynamoDB のような独自のセグメントを送信しないサービスでは、X-Ray はサブマップを使用してサービスマップ上に推測セグメント とダウンストリームノードを生成します。これにより、トレースをサポートしていない場合でも、外部の場合でも、すべてのダウンストリーム依存関係を表示することができます。

サブセグメントは、クライアントとしてのダウンストリーム呼び出しのアプリケーションビューを表します。ダウンストリームサービスも計測されている場合、送信するセグメントは、アップストリームクライアントのサブセグメントから生成された推測セグメントを置き換えます。利用可能であれば、サービスグラフのノードはサービスのセグメントからの情報を常に使用しますが、2 つのノード間のエッジはアップストリームサービスのサブセグメントを使用します。

たとえば、実装された AWS SDK クライアントで DynamoDB を呼び出すと、X-Ray SDK はその呼び出しのサブセグメントを記録します。DynamoDB はセグメントを送信しないので、トレースの推測セグメント、サービスグラフの DynamoDB ノード、サービスと DynamoDB の間のエッジにはサブセグメントの情報が含まれます。

実装されたアプリケーションと DynamoDB の間のエッジ。

実装されたアプリケーションを使用して実装された別のサービスを呼び出すと、ダウンストリームサービスは、サブセグメントに記録されたアップストリームサービスと同じ呼び出しのビューを記録するために、独自のセグメントを送信します。サービスグラフでは、両方のサービスのノードに、それらのサービスのセグメントからのタイミング情報とエラー情報が含まれています。その間には、アップストリームサービスのサブセグメントの情報が含まれています。

 他の計測アプリケーションを呼び出す計測アプリケーション。

ダウンストリームサービスは要求の処理を開始および終了した時点を正確に記録し、アップストリームサービスは要求が 2 つのサービス間を移動した時間を含めて往復遅延を記録するため、両方の視点が役立ちます。

サービスグラフ

X-Ray はアプリケーションが送信したデータを使用してサービスグラフを生成します。X-Ray にデータを送信する各 AWS リソースは、グラフのサービスとして表示されます。エッジは、リクエスト処理に一緒に使用するサービスに接続されています。エッジは、クライアントをアプリケーションに接続し、アプリケーションを、使用しているダウンストリームサービスおよびリソースに接続します。

サービス名

セグメントの name は、セグメントを生成したサービスのドメイン名や論理名と一致させるのが適切です。ただし、これは強制されません。PutTraceSegments へのアクセス権限を持つどのアプリケーションでも、任意の名前でセグメントを送信できます。

サービスグラフは、アプリケーションを構成するサービスおよびリソースに関する情報を含む JSON ドキュメントです。X-Ray コンソールでは、サービスグラフを使用して、視覚化またはサービスマップ を生成します。

 サービスマップ

分散アプリケーションの場合、X-Ray は、同一のトレース ID を含むリクエストを処理するすべてのサービスのノードを、単一のサービスグラフに組み合わせます。リクエストがヒットする最初のサービスによって、フロントエンドと呼び出すサービスの間で伝達される「トレースヘッダー」が追加されます。

たとえば、「Scorekeep」は、マイクロサービス (AWS Lambda 関数) を呼び出し、Node.js ライブラリを使用してランダム名を生成する ウェブ API を実行します。X-Ray SDK for Java はトレース ID を生成し、Lambda への呼び出しにそれを含めます。Lambda はトレースデータを送信し、トレース ID を関数に渡します。また、X-Ray SDK for Node.js は、トレース ID を使用してデータを送信します。その結果、API、Lambda サービス、Lambda 関数のノードはすべて別々ですが、接続されたノードとしてサービスマップに表示されます。

 API、Lambda サービス、Lambda 関数は別々だが、接続されたノードとして表示される

サービスグラフのデータは 30 日間 用に保持されます。

トレース

トレース ID はアプリケーションを経由するリクエストのパスを追跡します。 トレースでは、1 つのリクエストで生成されたセグメントをすべて収集します。このリクエストは、通常ロードバランサーを経由してやり取りされる HTTP GET または POST リクエストですが、アプリケーションコードにヒットし、他の AWS サービスまたは外部の ウェブ API のダウンストリーム呼び出しを生成します。HTTP リクエストでやり取りされる最初にサポートされたサービスでは、トレース ID のヘッダーをリクエストに追加し、ダウンストリームに伝達して、レイテンシー、処理、その他のリクエストデータを追跡します。

 トレースのタイムライン表示。単一のリクエストによって生成されるすべてのセグメントを収集する

サービスグラフのデータは 30 days 用に保持されます。

サンプリング

効率的にトレースし、アプリケーションが処理するリクエストの代表的なサンプルを提供するには、X-Ray SDK によってサンプリングアルゴリズムが適用され、トレースするリクエストが決定されます。デフォルトでは、X-Ray SDK は 1 秒ごとに最初のリクエストと、追加リクエストの 5% を記録します。

開始時にサービス料がかからないように、デフォルトのサンプリングレートは控えめになっています。SDK を設定して、デフォルトのサンプリングルールを変更し、アプリケーションが処理するルートが異なる場合は、異なるサンプリングレートを設定します。

たとえば、サンプリングを無効にして、状態を変更したり、ユーザーアカウントやトランザクションを処理するコールのすべての要求をトレースすることができます。バックグラウンドポーリング、ヘルスチェック、接続保守などの大量の読み取り専用コールでは、低いレートでサンプリングしても、問題が発生した場合にも十分なデータを得ることができます。

実際のサンプルを使ったサンプリング設定の詳細は、「入門ガイドチュートリアル」を参照してください。

トレースヘッダー

構成可能な最小値まではすべてのリクエストがトレースされます。その後はリクエストの一定の割合がトレースされ、不要なコストを避けます。サンプリングデシジョンおよびトレース ID は、HTTP リクエストの X-Amzn-Trace-Id という名前のトレースヘッダーに追加されます。トレースヘッダーは、リクエストがヒットした最初の X-Ray 組み込みサービスによって追加されます。また、X-Ray SDK によって読み取られ、レスポンスに含まれます。

例 ルートトレース ID 突きのトレースヘッダーおよびサンプリングデシジョン

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

トレースヘッダーのセキュリティ

トレースヘッダーは、X-RaySDK、AWS サービス、またはクライアントリクエストから発信されます。アプリケーションで受信リクエストから X-Amzn-Trace-Id を削除し、ユーザーが自分のリクエストにトレース ID またはサンプリングデシジョンを追加することで発生する問題を回避できます。

計測対象アプリケーションからのリクエストの場合は、親セグメント ID をトレースヘッダーに含めることもできます。たとえば、アプリケーションで計測対象 HTTP クライアントを使用してダウンストリーム HTTP ウェブ API を呼び出す場合、X-Ray SDK は元のリクエストのセグメントの ID をダウンストリームリクエストのトレースヘッダーに追加します。ダウンストリームリクエストを処理する計測対象アプリケーションで、親セグメント ID を記録して 2 つのリクエストを接続できます。

例 ルートトレース ID、親セグメント ID およびサンプリングデシジョンを含むトレースヘッダー

X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1

フィルタ式

サンプリングされている場合でも、複雑なアプリケーションでは大量のデータが生成されます。AWS X-Ray コンソールでは、操作が簡単なサービスグラフのビューを提供します。問題を識別しアプリケーションを最適化するために役立つ健全性とパフォーマンス情報が表示されます。高度なトレースでは、個別のリクエストのトレースを掘り下げたり、フィルタ式を使用して特定のパスまたはユーザーに関連するトレースを検索したりできます。

 個別のリクエストのトレースを掘り下げる

注釈とメタデータ

アプリケーションを計測すると、X-Ray SDK は、受信リクエストおよび発信リクエスト、AWS リソース、アプリケーションそのものに関する情報を記録します。その他の情報を注釈およびメタデータとして、セグメントドキュメントに追加することもできます。

注釈は、「フィルタ式」で使用するためにインデックス化されたシンプルなキーと値のペアです。注釈を使用して、コンソールでトレースをグループ化するため、または GetTraceSummariesAPI を呼び出すときに使用するデータを記録します。

X-Ray は、トレースごとに 50 の注釈までインデックスを付けます。

メタデータは、オブジェクトとリストを含む、任意のタイプの値を持つことができるキーと値のペアですが、フィルタ式に使用するためにインデックスは作成されません。メタデータを使用してトレースに保存するデータを記録しますが、トレースの検索用に使用する必要はありません。

セグメントまたはサブセグメントの注釈およびメタデータは、X-Ray コンソールで詳細を表示できます。

 セグメントまたはサブセグメントの注釈およびメタデータは X-Ray コンソールで詳細を確認できる

エラー、障害、および例外

X-Ray は、アプリケーションコードで発生するエラーと、ダウンストリームサービスから返されるエラーをトレースします。エラーは次のように分類されます。

  • Error – クライアントエラー (400 系のエラー)

  • Fault – サーバー障害 (500 系のエラー)

  • Throttle –スロットリングエラー (429 リクエストが多すぎる)

アプリケーションが実装されたリクエストを処理しているときに例外が発生すると、X-Ray SDK はスタックトレースを含む例外に関する詳細を記録します (利用可能な場合)。X-Ray コンソールで セグメント詳細 の例外を表示できます。