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

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

sam log

获取 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堆栈,这可以是中函数资源的逻辑 IDAmazon CloudFormation/Amazon SAMTemplate。通过再次重复参数可以提供多个名称。如果资源位于嵌套堆栈中,则可以在该名称前面加上嵌套堆栈名称的名称,以便从该资源中提取日志(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 The name of the Amazon CloudFormation资源所属的堆栈。
--filter TEXT 您需指定表达式以在日志事件中快速查找匹配字词、短语或值的日志。这可以是简单的关键字(例如 “错误”)或亚马逊支持的模式 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 SAM CLI 配置文件
--config-env TEXT 指定配置文件中要使用的默认参数值的环境名称。默认值为 “默认值”。有关配置文件的详细信息,请参阅 Amazon SAM CLI 配置文件
--debug 打开调试日志记录以打印由Amazon SAMCLI 并显示时间戳。
--help 显示此消息并退出。