X-Ray API を使用する

フォーカスモード

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

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

事前フォーマットされたコマンドを使用するか、リクエスト内のオプションを使用して、よりシンプルな構文 AWS CLI にを使用します。
X-Ray API を直接使用して、X-Ray に対するリクエストの柔軟性とカスタマイズを最大限活用します。

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

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

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 とやり取りすることもできます。は、他のの関数を含め、X-Ray SDK で使用できるすべての関数 AWS CLI をサポートします AWS のサービス。次の関数は以前にリストされた API オペレーションのバージョンで、より単純な形式になっています。

put-trace-segments - セグメントのドキュメントを X-Ray にアップロードします。
batch-get-traces - トレース ID のリスト内のトレースのリストを取得します。取得した各トレースは、単一のリクエストからのセグメントドキュメントのコレクションです。
get-trace-summaries - トレースの ID と注釈を取得します。FilterExpression を指定するとトレース概要のサブセットを取得できます。
get-trace-graph - 特定のトレース ID のサービスグラフを取得します。
get-service-graph - 受信リクエストを処理してダウンストリームリクエストを呼び出すサービスを説明する、JSON 形式のドキュメントを取得します。

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