sam logs - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

sam logs

获取由您的 Lambda 函数生成的日志。

当您的函数是Amazon CloudFormation堆栈的一部分时,您可以在指定堆栈名称时使用该函数的逻辑 ID 来获取日志。

用法:

sam logs [OPTIONS]

示例:

sam logs -n HelloWorldFunction --stack-name mystack # You can view logs for a specific time range using the -s (--start-time) and -e (--end-time) options sam logs -n HelloWorldFunction --stack-name mystack -s '10min ago' -e '2min ago' # You can also add the --tail option to wait for new logs and see them as they arrive. sam logs -n HelloWorldFunction --stack-name mystack --tail # Use the --filter option to quickly find logs that match terms, phrases or values in your log events. sam logs -n HelloWorldFunction --stack-name mystack --filter "error" # View the logs for a resource in a child stack. sam logs --stack-name mystack -n childstack/HelloWorldFunction # Tail logs for all supported resources in your application. sam logs --stack-name sam-app --tail # Fetch logs for a specific Lambda function and API Gateway API in your application. sam logs --stack-name sam-app --name HelloWorldFunction --name HelloWorldRestApi # Fetch logs for all supported resources in your application, and additionally from the specified log groups. sam logs --cw-log-group /aws/lambda/myfunction-123 --cw-log-group /aws/lambda/myfunction-456

选项:

选项 描述
-n, --name TEXT 要为其提取日志的资源的名称。如果此资源是Amazon CloudFormation堆栈的一部分,则这可以是Amazon CloudFormation/Amazon SAM模板中函数资源的逻辑 ID。再次重复该参数可以提供多个名称。如果资源位于嵌套堆栈中,则可以在名称前面加上嵌套堆栈名称以从该资源提取日志 (NestedStackLogicalId/ResourceLogicalId)。如果未给出资源名称,则将扫描给定的堆栈,并提取所有支持的资源的日志信息。如果您未指定此选项,则会Amazon 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

--stack-name TEXT 资源所Amazon CloudFormation属堆栈的名称。
--filter TEXT 允许您指定表达式以快速查找与日志事件中的术语、短语或值相匹配的日志。这可以是一个简单的关键字(例如,“错误”),也可以是 Amazon Logs 支持的 CloudWatch 模式。有关语法,请参阅亚马逊 CloudWatch 日志文档
-s, --start-time TEXT 从这个时候开始获取日志。时间可以是相对值,例如 “5 分钟前”、“昨天”,也可以是格式化的时间戳,例如 “2018-01-01 10:10:10”。默认为 “10 分钟前”。
-e, --end-time TEXT 获取到目前为止的日志。时间可以是相对值,例如 “5 分钟前”、“明天”,也可以是格式化的时间戳,例如 “2018-01-01 10:10:10”。
--profile TEXT 您的凭证文件中用于获取Amazon凭证的特定个人资料。
--region TEXT 要部署到的Amazon区域。例如,us-east-1。
-t, --tail 尾随日志输出。这会忽略结束时间参数,并在日志可用时继续获取日志。
--include-traces

在日志输出中包含 X-Ray 轨迹。

--output TEXT

指定日志的输出格式。要打印格式化的日志,请指定text。要以 JSON 格式打印日志,请指定json

--cw-log-group LIST 包括您指定的 CloudWatch 日志日志组中的日志。如果同时指定此选项name,则除了来自指定资源的日志外,还Amazon SAM包括来自指定日志组的日志。
--config-file PATH 包含要使用的默认参数值的配置文件的路径和文件名。项目目录根目录中的默认值为 “samconfig.toml”。有关配置文件的详细信息,请参阅 Amazon SAMCLI配置文件
--config-env TEXT 在配置文件中指定要使用的默认参数值的环境名称。默认值为 “默认”。有关配置文件的详细信息,请参阅 Amazon SAMCLI配置文件
--debug 启用调试日志记录以打印生成的调试消息Amazon SAMCLI并显示时间戳。
--help 显示此消息并退出。