配置 HTTP API 的日志记录
您可以启用日志记录以将日志写入 CloudWatch Logs。您可以使用日志记录变量来自定义日志的内容。
要为 HTTP API 启用日志记录,您必须执行以下操作。
确保您的 IAM 用户具有启用日志记录所需的权限。
创建 CloudWatch Logs 日志组。
为 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-east-2
:123456789012
:log-group:*" }, { "Effect": "Allow", "Action": [ "logs:CreateLogDelivery", "logs:PutResourcePolicy", "logs:UpdateLogDelivery", "logs:DeleteLogDelivery", "logs:CreateLogGroup", "logs:DescribeResourcePolicies", "logs:GetLogDelivery", "logs:ListLogDeliveries" ], "Resource": "*" } ] }
创建日志组
以下 Amazon CLI 命令创建日志组。
aws logs create-log-group --log-group-name
my-log-group
您需要日志组的 Amazon Resource Name (ARN) 才能启用日志记录。ARN 格式为 arn:aws:logs:region
:account-id
:log-group:log-group-name
。
为阶段启用日志记录
以下 Amazon CLI 命令会为 HTTP API 的 $default
阶段启用日志记录。
aws apigatewayv2 update-stage --api-id
abcdef
\ --stage-name '$default
' \ --access-log-settings '{"DestinationArn": "arn:aws:logs:region
:account-id
:log-group:log-group-name
", "Format": "$context.identity.sourceIp - - [$context.requestTime] \"$context.httpMethod $context.routeKey $context.protocol\" $context.status $context.responseLength $context.requestId"}'
日志格式示例
一些常用的访问日志格式的示例在 API Gateway 控制台中显示,下面列出了这些格式。
-
CLF
(常用日志格式): $context.identity.sourceIp - - [$context.requestTime] "$context.httpMethod $context.routeKey $context.protocol" $context.status $context.responseLength $context.requestId
-
JSON
:{ "requestId":"$context.requestId", "ip": "$context.identity.sourceIp", "requestTime":"$context.requestTime", "httpMethod":"$context.httpMethod","routeKey":"$context.routeKey", "status":"$context.status","protocol":"$context.protocol", "responseLength":"$context.responseLength" }
-
XML
:<request id="$context.requestId"> <ip>$context.identity.sourceIp</ip> <requestTime>$context.requestTime</requestTime> <httpMethod>$context.httpMethod</httpMethod> <routeKey>$context.routeKey</routeKey> <status>$context.status</status> <protocol>$context.protocol</protocol> <responseLength>$context.responseLength</responseLength> </request>
-
CSV
(逗号分隔值):$context.identity.sourceIp,$context.requestTime,$context.httpMethod,$context.routeKey,$context.protocol,$context.status,$context.responseLength,$context.requestId