Journald 日志驱动

journald 日志驱动将容器日志发送到 systemd journal。 可以通过 journalctl 命令、journal API 或 docker logs 命令来检索日志条目。

除了日志消息的文本内容外,journald 日志驱动还会将以下元数据与每条消息一起存储在 journal 中:

字段 描述
CONTAINER_ID 容器 ID,截断为 12 个字符。
CONTAINER_ID_FULL 完整的 64 字符容器 ID。
CONTAINER_NAME 容器启动时的名称。如果您使用 docker rename 重命名容器,新名称不会反映在 journal 条目中。
CONTAINER_TAG, SYSLOG_IDENTIFIER 容器标签(log tag 选项文档)。
CONTAINER_PARTIAL_MESSAGE 用于标记日志完整性的字段。用于改进长日志行的记录。
IMAGE_NAME 容器镜像的名称。

使用方法

要将 journald 驱动用作默认日志驱动,请在 daemon.json 文件中将 log-driverlog-opts 键设置为适当的值。该文件在 Linux 主机上位于 /etc/docker/,在 Windows Server 上位于 C:\ProgramData\docker\config\daemon.json。有关使用 daemon.json 配置 Docker 的更多信息,请参阅 daemon.json

以下示例将日志驱动设置为 journald

{
  "log-driver": "journald"
}

重新启动 Docker 以使更改生效。

要为特定容器配置日志驱动,请在 docker run 命令上使用 --log-driver 标志。

$ docker run --log-driver=journald ...

选项

使用 --log-opt NAME=VALUE 标志来指定额外的 journald 日志驱动选项。

选项 是否必需 描述
tag 可选 指定用于在 journald 日志中设置 CONTAINER_TAGSYSLOG_IDENTIFIER 值的模板。请参阅 log tag 选项文档 以自定义日志标签格式。
labels 可选 以逗号分隔的标签键列表,如果容器指定了这些标签,则应包含在消息中。
labels-regex 可选 与 labels 类似且兼容。用于匹配日志相关标签的正则表达式。用于高级 log tag 选项
env 可选 以逗号分隔的环境变量键列表,如果容器指定了这些变量,则应包含在消息中。
env-regex 可选 env 类似且兼容。用于匹配日志相关环境变量的正则表达式。用于高级 log tag 选项

如果 labelenv 选项之间发生冲突,env 的值优先。每个选项都会向日志消息的属性添加额外的字段。

以下是记录到 journald 所需的日志选项示例。

$ docker run \
    --log-driver=journald \
    --log-opt labels=location \
    --log-opt env=TEST \
    --env "TEST=false" \
    --label location=west \
    your/application

此配置还指示驱动在有效负载中包含标签 location 和环境变量 TEST。如果省略了 --env "TEST=false"--label location=west 参数,则相应的键将不会在 journald 日志中设置。

关于容器名称的说明

CONTAINER_NAME 字段中记录的值是容器启动时设置的名称。如果您使用 docker rename 重命名容器,新名称不会反映在 journal 条目中。Journal 条目将继续使用原始名称。

使用 journalctl 检索日志消息

使用 journalctl 命令检索日志消息。您可以应用过滤表达式将检索到的消息限制为与特定容器相关的消息:

$ sudo journalctl CONTAINER_NAME=webserver

您可以使用其他过滤器来进一步限制检索到的消息。-b 标志仅检索自上次系统启动以来生成的消息:

$ sudo journalctl -b CONTAINER_NAME=webserver

-o 标志指定检索到的日志消息的格式。使用 -o json 以 JSON 格式返回日志消息。

$ sudo journalctl -o json CONTAINER_NAME=webserver

查看启用了 TTY 的容器的日志

如果容器上启用了 TTY,在检索日志消息时,您可能会在输出中看到 [10B blob data]。 原因是行尾附加了 \r,而 journalctl 不会自动将其剥离,除非设置了 --all

$ sudo journalctl -b CONTAINER_NAME=webserver --all

使用 journal API 检索日志消息

此示例使用 systemd Python 模块来检索容器日志:

import systemd.journal

reader = systemd.journal.Reader()
reader.add_match('CONTAINER_NAME=web')

for msg in reader:
    print '{CONTAINER_ID_FULL}: {MESSAGE}'.format(**msg)