sam logs

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

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

sam logs コマンドは、AWS Lambda 関数によって生成されたログを取得します。

使用方法

$ sam logs <options>

オプション

--config-env TEXT

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

--config-file PATH

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

--cw-log-group LIST

指定した CloudWatch Logs ロググループからのログを含めます。name とともにこのオプションを指定した場合、AWS SAM は、その名前のリソースからのログに加えて、指定されたロググループのログも含めます。

--debug

デバッグロギングをオンにして、AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

---end-time, e TEXT

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

--filter TEXT

式を指定して、ログイベントの用語、フレーズ、または値に一致するログをすばやく検索できるようにします。これは、シンプルなキーワード (「error」など)、または Amazon CloudWatch Logs でサポートされるパターンにすることができます。構文については、Amazon CloudWatch Logs ドキュメントを参照してください。

--help

このメッセージを表示して終了します。

--include-traces

ログ出力に X-Ray トレースを含めます。

--name, -n TEXT

ログを取得するリソースの名前。このリソースが AWS CloudFormation スタックの一部である場合、これは AWS CloudFormation/AWS SAM テンプレート内の関数リソースの論理 ID であることが可能です。パラメータを再度繰り返すことで、複数の名前を指定できます。リソースがネストされたスタックにある場合、そのリソースからログをプルするために、ネストされたスタック名の前に名前を付加できます (NestedStackLogicalId/ResourceLogicalId)。リソース名が指定されていない場合、指定されたスタックがスキャンされ、サポートされているすべてのリソースのログ情報が取得されます。このオプションを指定しない場合、AWS SAM は、指定したスタック内のすべてのリソースのログを取得します。以下のリソースタイプがサポートされています。

• AWS::Serverless::Function

• AWS::Lambda::Function

• AWS::Serverless::Api

• AWS::ApiGateway::RestApi

• AWS::Serverless::HttpApi

• AWS::ApiGatewayV2::Api

• AWS::Serverless::StateMachine

• AWS::StepFunctions::StateMachine

--output TEXT

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

--profile TEXT

AWS 認証情報を取得する、認証情報ファイルから特定のプロファイルです。

--region TEXT

デプロイ先の AWS リージョンです。例えば、us-east-1 などです。

--save-params

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

--stack-name TEXT

このリソースが一部を成す AWS CloudFormation スタックの名前です。

--start-time, -s TEXT

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

--tail, -t

ログ出力を tail します。これにより、終了時間引数は無視され、ログが使用可能になった時点で引き続き取得されます。

例

関数が AWS CloudFormation スタックの一部である場合、スタック名を指定するときに、関数の論理 ID を使用してログを取得できます。

$ sam logs -n HelloWorldFunction --stack-name myStack

-s (--start-time) と-e (--end-time) オプションを使用して、特定の時間範囲のログを表示します。

$ sam logs -n HelloWorldFunction --stack-name myStack -s '10min ago' -e '2min ago'

--tail オプションを追加して、新しいログを待機し、到着するたびにそれらを表示することもできます。

$ sam logs -n HelloWorldFunction --stack-name myStack --tail

--filter オプションを使用して、ログイベントの語句、フレーズ、または値が一致するログをすばやく検索します。

$ sam logs -n HelloWorldFunction --stack-name myStack --filter "error"

子スタック内のリソースのログを表示します。

$ sam logs --stack-name myStack -n childStack/HelloWorldFunction

アプリケーションでサポートされているすべてのリソースのログを追跡します。

$ sam logs --stack-name sam-app --tail

アプリケーション内の特定の Lambda 関数および API Gateway API のログを取得します。

$ sam logs --stack-name sam-app --name HelloWorldFunction --name HelloWorldRestApi

アプリケーション内のサポートされているすべてのリソースのログを取得し、さらに指定したロググループからログを取得します。

$ sam logs --cw-log-group /aws/lambda/myfunction-123 --cw-log-group /aws/lambda/myfunction-456