Syslog 日志驱动程序

syslog 日志驱动将日志路由到 syslog 服务器。syslog 协议使用原始字符串作为日志消息,并支持有限的元数据集。Syslog 消息必须以特定方式格式化才能有效。从有效消息中,接收器可以提取以下信息

  • 优先级:日志级别,例如 debugwarningerrorinfo
  • 时间戳:事件发生的时间。
  • 主机名:事件发生的位置。
  • 设施:记录消息的子系统,例如 mailkernel
  • 进程名称和进程 ID (PID):生成日志的进程的名称和 ID。

格式在 RFC 5424 中定义,Docker 的 syslog 驱动程序以以下方式实现 ABNF 引用

                TIMESTAMP SP HOSTNAME SP APP-NAME SP PROCID SP MSGID
                    +          +             +           |        +
                    |          |             |           |        |
                    |          |             |           |        |
       +------------+          +----+        |           +----+   +---------+
       v                            v        v                v             v
2017-04-01T17:41:05.616647+08:00 a.vm {taskid:aa,version:} 1787791 {taskid:aa,version:}

用法

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

以下示例将日志驱动程序设置为 syslog 并设置 syslog-address 选项。syslog-address 选项支持 UDP 和 TCP;此示例使用 UDP。

{
  "log-driver": "syslog",
  "log-opts": {
    "syslog-address": "udp://1.2.3.4:1111"
  }
}

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

注意

daemon.json 配置文件中的 log-opts 配置选项必须作为字符串提供。因此,数字和布尔值(例如 syslog-tls-skip-verify 的值)必须用引号 (") 括起来。

你可以使用 --log-driver 标志为特定容器设置日志驱动程序,以 docker container createdocker run

$ docker run \
      --log-driver syslog --log-opt syslog-address=udp://1.2.3.4:1111 \
      alpine echo hello world

选项

以下日志选项作为 syslog 日志驱动程序的选项受支持。它们可以作为默认值在 daemon.json 中设置,方法是将它们作为键值对添加到 log-opts JSON 数组中。它们也可以在启动容器时通过为每个选项添加一个 --log-opt <key>=<value> 标志,为给定容器设置。

选项描述示例值
syslog-address外部 syslog 服务器的地址。URI 说明符可以是 [tcp|udp|tcp+tls]://host:portunix://pathunixgram://path。如果传输是 tcpudptcp+tls,则默认端口为 514--log-opt syslog-address=tcp+tls://192.168.1.3:514--log-opt syslog-address=unix:///tmp/syslog.sock
syslog-facility要使用的 syslog 设施。可以是任何有效 syslog 设施的数字或名称。请参阅 syslog 文档--log-opt syslog-facility=daemon
syslog-tls-ca-certCA 签署的信任证书的绝对路径。如果地址协议不是 tcp+tls,则忽略。--log-opt syslog-tls-ca-cert=/etc/ca-certificates/custom/ca.pem
syslog-tls-certTLS 证书文件的绝对路径。如果地址协议不是 tcp+tls,则忽略。--log-opt syslog-tls-cert=/etc/ca-certificates/custom/cert.pem
syslog-tls-keyTLS 密钥文件的绝对路径。如果地址协议不是 tcp+tls,则忽略。--log-opt syslog-tls-key=/etc/ca-certificates/custom/key.pem
syslog-tls-skip-verify如果设置为 true,则在连接到 syslog 守护程序时跳过 TLS 验证。默认为 false。如果地址协议不是 tcp+tls,则忽略。--log-opt syslog-tls-skip-verify=true
tag追加到 syslog 消息中的 APP-NAME 的字符串。默认情况下,Docker 使用容器 ID 的前 12 个字符来标记日志消息。有关自定义日志标签格式的更多信息,请参阅 日志标签选项文档--log-opt tag=mailer
syslog-format要使用的 syslog 消息格式。如果未指定,则使用本地 Unix syslog 格式,没有指定主机名。指定 rfc3164 以获得与 RFC-3164 兼容的格式,指定 rfc5424 以获得与 RFC-5424 兼容的格式,或者指定 rfc5424micro 以获得具有微秒时间戳分辨率的与 RFC-5424 兼容的格式。--log-opt syslog-format=rfc5424micro
labels适用于启动 Docker 守护程序时。此守护程序接受的与日志相关的标签的逗号分隔列表。用于高级 日志标签选项--log-opt labels=production_status,geo
labels-regex适用于启动 Docker 守护程序时。类似于并与 labels 兼容。与日志相关的标签的正则表达式。用于高级 日志标签选项--log-opt labels-regex=^(production_status|geo)
env适用于启动 Docker 守护程序时。此守护程序接受的与日志相关的环境变量的逗号分隔列表。用于高级 日志标签选项--log-opt env=os,customer
env-regex适用于启动 Docker 守护程序时。类似于并与 env 兼容。与日志相关的环境变量的正则表达式。用于高级 日志标签选项--log-opt env-regex=^(os|customer)