翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# sam logs
<a name="sam-cli-command-reference-sam-logs"></a>

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

の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)

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

## 使用方法
<a name="sam-cli-command-reference-sam-logs-usage"></a>

```
$ sam logs <options>
```

## オプション
<a name="sam-cli-command-reference-sam-logs-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-logs-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-logs-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--cw-log-group LIST`  <a name="sam-cli-command-reference-sam-logs-options-cw-log-group"></a>
指定した CloudWatch Logs ロググループからのログを含めます。このオプションを とともに指定すると`name`、 は指定されたリソースからのログに加えて、指定されたロググループのログ AWS SAM を含めます。

`--debug`  <a name="sam-cli-command-reference-sam-logs-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

`---end-time, e TEXT`  <a name="sam-cli-command-reference-sam-logs-options-end-time"></a>
この時刻までのログを取得します。時刻には、「5mins ago」、「tomorrow」などの相対的な値、または「2018-01-01 10:10:10」のような形式化されたタイムスタンプにすることができます。

`--filter TEXT`  <a name="sam-cli-command-reference-sam-logs-options-filter"></a>
式を指定して、ログイベントの用語、フレーズ、または値に一致するログをすばやく検索できるようにします。これは、シンプルなキーワード (「error」など)、または Amazon CloudWatch Logs でサポートされるパターンにすることができます。構文については、[Amazon CloudWatch Logs ドキュメント](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)を参照してください。

`--help`  <a name="sam-cli-command-reference-sam-logs-options-help"></a>
このメッセージを表示して終了します。

`--include-traces`  <a name="sam-cli-command-reference-sam-logs-options-include-traces"></a>
ログ出力に X-Ray トレースを含めます。

`--name, -n TEXT`  <a name="sam-cli-command-reference-sam-logs-options-name"></a>
ログを取得するリソースの名前。このリソースが CloudFormation スタックの一部である場合、これは 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`  <a name="sam-cli-command-reference-sam-logs-options-output"></a>
ログの出力形式を指定します。フォーマットされたログを印刷するには、`text` を指定します。ログを JSON として印刷するには、`json` を指定します。

`--profile TEXT`  <a name="sam-cli-command-reference-sam-logs-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-sam-logs-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--save-params`  <a name="sam-cli-command-reference-sam-logs-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-logs-options-stack-name"></a>
リソースが属する CloudFormation スタックの名前。

`--start-time, -s TEXT`  <a name="sam-cli-command-reference-sam-logs-options-start-time"></a>
この時刻以降のログを取得します。時刻には、「5mins ago」、「yesterday」などの相対的な値、または「2018-01-01 10:10:10」のような形式化されたタイムスタンプにすることができます。デフォルトは「10mins ago」です。

` --tail, -t`  <a name="sam-cli-command-reference-sam-logs-options-tail"></a>
ログ出力を tail します。これにより、終了時間引数は無視され、ログが使用可能になった時点で引き続き取得されます。

## 例
<a name="sam-cli-command-reference-sam-logs-examples"></a>

関数が 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
```