X-Ray API を使用する - AWS X-Ray

X-Ray API を使用する

X-Ray SDK がご使用のプログラミング言語をサポートしていない場合は、X-Ray API を直接使用、または AWS Command Line Interface (AWS CLI) を使用して X-Ray API コマンドを呼び出せます。次のガイダンスを使用して、API の操作方法を選択します。

  • 事前フォーマットされたコマンドを使用した、またはリクエスト内のオプションを使用した、単純な構文の AWS CLI を使用します。

  • X-Ray API を直接使用して、X-Ray に対するリクエストの柔軟性とカスタマイズを最大限活用します。

AWS CLI の代わりに X-Ray API を直接使用する場合は、リクエストを正しいデータ形式でパラメータ化し、認証およびエラー処理を設定する必要があります。

次の図は、X-Ray API の操作方法の選択のためのガイダンスを示しています。

X-Ray は、アプリケーションリクエストに関する詳細情報を表示します。

X-Ray API を使用してトレースデータを X-Ray に直接送信します。X-Ray API は、以下の一般的なアクションを含む、X-Ray SDK で使用可能なすべての関数をサポートしています。

  • PutTraceSegments - セグメントのドキュメントを X-Ray にアップロードします。

  • BatchGetTraces - トレース ID のリスト内のトレースのリストを取得します。取得した各トレースは、単一のリクエストからのセグメントドキュメントのコレクションです。

  • GetTraceSummaries - トレースの ID と注釈を取得します。FilterExpression を指定するとトレース概要のサブセットを取得できます。

  • GetTraceGraph - 特定のトレース ID のサービスグラフを取得します。

  • GetServiceGraph - 受信リクエストを処理してダウンストリームリクエストを呼び出すサービスを説明する、JSON 形式のドキュメントを取得します。

アプリケーションコード内の AWS Command Line Interface (AWS CLI) を使用して、プログラムで X-Ray を操作することもできます。AWS CLI は、他の AWS のサービス 用の関数を含む、X-Ray SDK で使用できるすべての関数をサポートします。次の関数は以前にリストされた API オペレーションのバージョンで、より単純な形式になっています。

  • put-trace-segments - セグメントのドキュメントを X-Ray にアップロードします。

  • batch-get-traces - トレース ID のリスト内のトレースのリストを取得します。取得した各トレースは、単一のリクエストからのセグメントドキュメントのコレクションです。

  • get-trace-summary - トレースの ID と注釈を取得します。FilterExpression を指定するとトレース概要のサブセットを取得できます。

  • get-trace-graph - 特定のトレース ID のサービスグラフを取得します。

  • get-service-graph - 受信リクエストを処理してダウンストリームリクエストを呼び出すサービスを説明する、JSON 形式のドキュメントを取得します。

使用するには、オペレーティングシステムに AWS CLI をインストールする必要があります。AWS は Linux、macOS、Windows の各オペレーティングシステムをサポートしています。X-Ray コマンドのリストの詳細については、「X-Ray の AWS CLI コマンドリファレンスガイド」を参照してください。

トピック