sam traces

このページでは、AWS Serverless Application Model コマンドラインインタフェイス (AWS SAM CLI) の sam traces コマンドのリファレンス情報を提供します。

AWS SAM CLI の概要については、「とは何ですか? AWS SAMCLI」を参照してください。

sam traces コマンドは、AWS X-Ray で AWS アカウント 内の AWS リージョン トレースを取得します。

使用方法

$ sam traces <options>

オプション

--config-env TEXT

使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--config-file PATH

使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--end-time TEXT

この時刻までのトレースを取得します。時刻には、「5mins ago」、「tomorrow」などの相対的な値、または「2018-01-01 10:10:10」のような形式化されたタイムスタンプにすることができます。

--output TEXT

ログの出力形式を指定します。フォーマットされたログを印刷するには、text を指定します。ログを JSON として印刷するには、json を指定します。

--save-params

コマンドラインで指定したパラメータを AWS SAM 設定ファイルに保存します。

--start-time TEXT

この時刻以降のトレースを取得します。時刻には、「5mins ago」、「yesterday」などの相対的な値、または「2018-01-01 10:10:10」のような形式化されたタイムスタンプにすることができます。デフォルトは「10mins ago」です。

--tail

トレース出力の末尾を表示します。これにより、終了時間引数は無視され、トレースが使用可能になった時点で引き続き取得されます。

--trace-id TEXT

X-Ray トレースの固有の識別子。

例

次のコマンドを実行して、X-Ray トレースを ID で取得します。

$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2

次のコマンドを実行して、X-Ray トレースが使用可能になったら末尾を表示します。

$ sam traces --tail