Amazon CloudWatch 日志日志驱动程序
awslogs
日志驱动程序将容器日志发送到 Amazon CloudWatch 日志。可以通过 AWS 管理控制台 或 AWS SDK 和命令行工具 获取日志条目。
使用
要将 awslogs
驱动程序用作默认日志驱动程序,请在 daemon.json
文件中将 log-driver
和 log-opt
键设置为适当的值,该文件位于 Linux 主机上的 /etc/docker/
或 Windows Server 上的 C:\ProgramData\docker\config\daemon.json
中。有关使用 daemon.json
配置 Docker 的更多信息,请参阅 daemon.json。以下示例将日志驱动程序设置为 awslogs
并设置 awslogs-region
选项。
{
"log-driver": "awslogs",
"log-opts": {
"awslogs-region": "us-east-1"
}
}
重新启动 Docker 以使更改生效。
您可以使用 --log-driver
选项到 docker run
设置特定容器的日志驱动程序
$ docker run --log-driver=awslogs ...
如果您使用的是 Docker Compose,请使用以下声明示例设置 awslogs
myservice:
logging:
driver: awslogs
options:
awslogs-region: us-east-1
Amazon CloudWatch 日志选项
您可以将日志选项添加到 daemon.json
中以设置 Docker 范围的默认值,或者使用 --log-opt NAME=VALUE
标志在启动容器时指定 Amazon CloudWatch 日志日志驱动程序选项。
awslogs-region
awslogs
日志驱动程序将您的 Docker 日志发送到特定区域。使用 awslogs-region
日志选项或 AWS_REGION
环境变量设置区域。默认情况下,如果您的 Docker 守护程序在 EC2 实例上运行且未设置区域,则驱动程序将使用实例的区域。
$ docker run --log-driver=awslogs --log-opt awslogs-region=us-east-1 ...
awslogs-endpoint
默认情况下,Docker 使用 awslogs-region
日志选项或检测到的区域来构建远程 CloudWatch 日志 API 端点。使用 awslogs-endpoint
日志选项使用提供的端点覆盖默认端点。
注意
awslogs-region
日志选项或检测到的区域控制用于签名的区域。如果您使用awslogs-endpoint
指定的端点使用不同的区域,您可能会遇到签名错误。
awslogs-group
您必须指定一个 日志组 awslogs
日志驱动程序。您可以使用 awslogs-group
日志选项指定日志组
$ docker run --log-driver=awslogs --log-opt awslogs-region=us-east-1 --log-opt awslogs-group=myLogGroup ...
awslogs-stream
要配置要使用哪个 日志流,您可以指定 awslogs-stream
日志选项。如果未指定,则容器 ID 将用作日志流。
注意
给定日志组中的日志流一次只能由一个容器使用。同时为多个容器使用同一个日志流会导致日志性能下降。
awslogs-create-group
如果日志组不存在,日志驱动程序默认情况下会返回错误。但是,您可以将 awslogs-create-group
设置为 true
以根据需要自动创建日志组。awslogs-create-group
选项默认为 false
。
$ docker run \
--log-driver=awslogs \
--log-opt awslogs-region=us-east-1 \
--log-opt awslogs-group=myLogGroup \
--log-opt awslogs-create-group=true \
...
注意
在您尝试使用
awslogs-create-group
之前,您的 AWS IAM 策略必须包含logs:CreateLogGroup
权限。
awslogs-datetime-format
awslogs-datetime-format
选项定义了一个 Python strftime
格式 中的多行起始模式。日志消息由匹配模式的行以及任何不匹配模式的后续行组成。因此,匹配的行是日志消息之间的分隔符。
使用此格式的一个用例示例是解析诸如堆栈转储之类的输出,否则这些输出可能在多个条目中记录。正确的模式允许它在一个条目中捕获。
如果配置了 awslogs-datetime-format
和 awslogs-multiline-pattern
,则此选项始终优先。
注意
多行日志记录对所有日志消息执行正则表达式解析和匹配,这可能会对日志记录性能产生负面影响。
考虑以下日志流,其中新的日志消息以时间戳开头
[May 01, 2017 19:00:01] A message was logged
[May 01, 2017 19:00:04] Another multi-line message was logged
Some random message
with some random words
[May 01, 2017 19:01:32] Another message was logged
该格式可以表示为 strftime
表达式 [%b %d, %Y %H:%M:%S]
,awslogs-datetime-format
值可以设置为该表达式
$ docker run \
--log-driver=awslogs \
--log-opt awslogs-region=us-east-1 \
--log-opt awslogs-group=myLogGroup \
--log-opt awslogs-datetime-format='\[%b %d, %Y %H:%M:%S\]' \
...
这将日志解析为以下 CloudWatch 日志事件
# First event
[May 01, 2017 19:00:01] A message was logged
# Second event
[May 01, 2017 19:00:04] Another multi-line message was logged
Some random message
with some random words
# Third event
[May 01, 2017 19:01:32] Another message was logged
以下 strftime
代码受支持
代码 | 含义 | 示例 |
---|---|---|
%a | 星期几缩写名称。 | Mon |
%A | 星期几全称。 | Monday |
%w | 星期几作为十进制数,其中 0 是星期日,6 是星期六。 | 0 |
%d | 月份中的日期作为零填充的十进制数。 | 08 |
%b | 月份缩写名称。 | Feb |
%B | 月份全称。 | February |
%m | 月份作为零填充的十进制数。 | 02 |
%Y | 带世纪的年份作为十进制数。 | 2008 |
%y | 不带世纪的年份作为零填充的十进制数。 | 08 |
%H | 小时(24 小时制)作为零填充的十进制数。 | 19 |
%I | 小时(12 小时制)作为零填充的十进制数。 | 07 |
%p | 上午或下午。 | AM |
%M | 分钟作为零填充的十进制数。 | 57 |
%S | 秒作为零填充的十进制数。 | 04 |
%L | 毫秒作为零填充的十进制数。 | .123 |
%f | 微秒作为零填充的十进制数。 | 000345 |
%z | UTC 偏移量,格式为 +HHMM 或 -HHMM。 | +1300 |
%Z | 时区名称。 | PST |
%j | 一年中的第几天,用零填充的十进制数表示。 | 363 |
awslogs-multiline-pattern
awslogs-multiline-pattern
选项使用正则表达式定义多行开始模式。日志消息由匹配模式的一行以及任何不匹配模式的后续行组成。因此,匹配的行是日志消息之间的分隔符。
如果也配置了 awslogs-datetime-format
,则会忽略此选项。
注意
多行日志记录会对所有日志消息执行正则表达式解析和匹配。这可能会对日志记录性能产生负面影响。
请考虑以下日志流,其中每条日志消息应以模式 INFO
开头
INFO A message was logged
INFO Another multi-line message was logged
Some random message
INFO Another message was logged
可以使用 ^INFO
的正则表达式
$ docker run \
--log-driver=awslogs \
--log-opt awslogs-region=us-east-1 \
--log-opt awslogs-group=myLogGroup \
--log-opt awslogs-multiline-pattern='^INFO' \
...
这将日志解析为以下 CloudWatch 日志事件
# First event
INFO A message was logged
# Second event
INFO Another multi-line message was logged
Some random message
# Third event
INFO Another message was logged
tag
指定 tag
作为 awslogs-stream
选项的替代方案。tag
解释 Go 模板标记,例如 {{.ID}}
、{{.FullID}}
或 {{.Name}}
docker.{{.ID}}
。有关支持的模板替换的详细信息,请参阅 tag 选项文档。
同时指定 awslogs-stream
和 tag
时,为 awslogs-stream
提供的值将覆盖使用 tag
指定的模板。
如果未指定,则容器 ID 用作日志流。
注意
CloudWatch 日志 API 不支持日志名称中的
:
。这在将{{ .ImageName }}
用作标记时会导致一些问题,因为 Docker 镜像的格式为IMAGE:TAG
,例如alpine:latest
。模板标记可用于获取正确的格式。要获取镜像名称和容器 ID 的前 12 个字符,可以使用--log-opt tag='{{ with split .ImageName ":" }}{{join . "_"}}{{end}}-{{.ID}}'
输出类似于:
alpine_latest-bf0072049c76
awslogs-force-flush-interval-seconds
awslogs
驱动程序会定期将日志刷新到 CloudWatch。
awslogs-force-flush-interval-seconds
选项更改日志刷新间隔秒数。
默认值为 5 秒。
awslogs-max-buffered-events
awslogs
驱动程序会缓冲日志。
awslogs-max-buffered-events
选项更改日志缓冲区大小。
默认值为 4K。
凭据
您必须向 Docker 守护程序提供 AWS 凭据才能使用 awslogs
日志记录驱动程序。您可以使用 AWS_ACCESS_KEY_ID
、AWS_SECRET_ACCESS_KEY
和 AWS_SESSION_TOKEN
环境变量,默认 AWS 共享凭据文件(根用户的 ~/.aws/credentials
)提供这些凭据,或者如果您在 Amazon EC2 实例上运行 Docker 守护程序,则可以提供 Amazon EC2 实例配置文件。
凭据必须应用允许 logs:CreateLogStream
和 logs:PutLogEvents
操作的策略,如以下示例所示。
{
"Version": "2012-10-17",
"Statement": [
{
"Action": ["logs:CreateLogStream", "logs:PutLogEvents"],
"Effect": "Allow",
"Resource": "*"
}
]
}