Journald 日志驱动程序
journald
日志驱动程序将容器日志发送到 systemd
日志。可以使用 journalctl
命令,通过使用 journal
API 或使用 docker logs
命令检索日志条目。
除了日志消息本身的文本之外,journald
日志驱动程序还会在每次消息中将以下元数据存储在日志中
字段 | 描述 |
---|---|
CONTAINER_ID | 容器 ID 截断为 12 个字符。 |
CONTAINER_ID_FULL | 完整的 64 个字符容器 ID。 |
CONTAINER_NAME | 容器启动时的容器名称。如果你使用 docker rename 重命名容器,则新名称不会反映在日志条目中。 |
CONTAINER_TAG , SYSLOG_IDENTIFIER | 容器标签(日志标签选项文档)。 |
CONTAINER_PARTIAL_MESSAGE | 一个标记日志完整性的字段。改进长日志行的日志记录。 |
用法
要使用 journald
驱动程序作为默认日志驱动程序,请在 daemon.json
文件中将 log-driver
和 log-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 | 可选 | 指定模板以设置 CONTAINER_TAG 和 SYSLOG_IDENTIFIER 的值在 journald 日志中。请参阅 日志标签选项文档 以自定义日志标签格式。 |
labels | 可选 | 标签键的逗号分隔列表,如果为容器指定了这些标签,则应将这些标签包含在消息中。 |
labels-regex | 可选 | 类似于并与标签兼容。与日志相关的标签的正则表达式。用于高级 日志标签选项。 |
env | 可选 | 环境变量键的逗号分隔列表,如果为容器指定了这些变量,则应将这些变量包含在消息中。 |
env-regex | 可选 | 类似于并与 env 兼容。用于匹配日志相关环境变量的正则表达式。用于高级 日志标签选项。 |
如果 label
和 env
选项之间发生冲突,则 env
的值优先。每个选项都会在日志消息的属性中添加其他字段。
以下是对日志到 journald 所需的日志选项的示例。
$ docker run \
--log-driver=journald \
--log-opt labels=location \
--log-opt env=TEST \
--env "TEST=false" \
--label location=west \
your/application
此配置还指示驱动程序在有效负载中包含标签位置和环境变量 TEST
。如果省略了 --env "TEST=false"
或 --label location=west
参数,则相应的键不会在 journald 日志中设置。
关于容器名称的说明
CONTAINER_NAME
字段中记录的值是在启动时设置的容器的名称。如果你使用 docker rename
重命名容器,则新名称不会反映在日志条目中。日志条目将继续使用原始名称。
使用 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)