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 日志驱动程序的选项。可以通过将它们作为键值对添加到 log-opts JSON 数组中,将其设置为 daemon.json 中的默认值。也可以通过在启动容器时为每个选项添加 --log-opt = 标志,在给定容器上设置它们。

选项描述示例值
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 格式,不指定主机名。对于与 RFC-3164 兼容的格式,指定 rfc3164;对于与 RFC-5424 兼容的格式,指定 rfc5424;对于具有微秒时间戳分辨率的与 RFC-5424 兼容的格式,指定 rfc5424micro--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)