为 HTTP API 配置日志记录 - Amazon API Gateway
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

为 HTTP API 配置日志记录

您可以启用日志记录以将日志写入 CloudWatch Logs。您可以使用日志记录变量来自定义日志的内容。

要为 HTTP API 启用日志记录,您必须执行以下操作。

  1. 确保您的 IAM 用户具有启用日志记录所需的权限。

  2. 创建 CloudWatch Logs 日志组。

  3. 为 API 的某个阶段提供 CloudWatch Logs 日志组的 ARN。

启用日志记录的权限

要启用 API 的日志记录,您的 IAM 用户必须具有以下权限。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "logs:DescribeLogGroups", "logs:DescribeLogStreams", "logs:GetLogEvents", "logs:FilterLogEvents" ], "Resource": "arn:aws:logs:us-west-2:123456789012:log-group:*" }, { "Effect": "Allow", "Action": [ "logs:CreateLogDelivery", "logs:PutResourcePolicy", "logs:UpdateLogDelivery", "logs:DeleteLogDelivery", "logs:CreateLogGroup", "logs:DescribeResourcePolicies", "logs:GetLogDelivery", "logs:ListLogDeliveries" ], "Resource": "*" } ] }

使用 AWS 管理控制台启用日志记录

  1. 打开 API Gateway 控制台

  2. 选择一个 API。

  3. Monitor (监控) 下,选择 Logging (日志记录)

  4. 选择要为其启用日志记录的阶段。

  5. 选择 Edit

  6. 使用 Access logging (访问日志记录) 开关启用访问日志记录。

  7. 对于 Log destination (日志目标),输入 CloudWatch Logs 日志组的 ARN。ARN 格式为 arn:aws:logs:region:account-id:log-group:log-group-name

  8. Log format (日志格式) 中输入日志格式。您可以选择 CLFJSONXMLCSV 以使用提供的示例之一作为指南。

  9. 选择 Save