Syslog 日志记录驱动程序
这syslog
logging 驱动程序将日志路由到syslog
服务器。这syslog
协议用途
原始字符串作为日志消息,并支持一组有限的元数据。syslog
消息必须以特定方式格式化才能有效。在有效消息中,
接收方可以提取以下信息:
- 优先级:日志记录级别,例如
debug
,warning
,error
,info
. - 时间戳:事件发生的时间。
- 主机名:事件发生的位置。
- Facility:哪个子系统记录了消息,例如
mail
或kernel
. - 进程名称和进程 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
driver 作为默认的日志记录驱动程序,将log-driver
和log-opt
keys 添加到daemon.json
文件,即
位于/etc/docker/
在 Linux 主机上或C:\ProgramData\docker\config\daemon.json
在 Windows Server 上。有关
使用 配置 Dockerdaemon.json
,请参阅 daemon.json。
以下示例将日志驱动程序设置为syslog
并设置syslog-address
选择。这syslog-address
选项同时支持 UDP 和 TCP;
此示例使用 UDP。
{
"log-driver": "syslog",
"log-opts": {
"syslog-address": "udp://1.2.3.4:1111"
}
}
重新启动 Docker 以使更改生效。
注意
log-opts
配置选项中的daemon.json
配置文件必须 以字符串形式提供。数值和布尔值(例如syslog-tls-skip-verify
) 必须用引号 () 括起来。"
您可以使用--log-driver
flag 设置为docker container create
或docker 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>
flag 时
启动容器。
选择 | 描述 | 示例值 |
---|---|---|
syslog-address | 外部syslog 服务器。URI 说明符可以是[tcp|udp|tcp+tls]://host:port ,unix://path 或unixgram://path .如果传输是tcp ,udp 或tcp+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-cert | 由 CA 签名的信任证书的绝对路径。如果地址协议不是,则忽略tcp+tls . | --log-opt syslog-tls-ca-cert=/etc/ca-certificates/custom/ca.pem |
syslog-tls-cert | TLS 证书文件的绝对路径。如果地址协议不是 Ignore,则忽略tcp+tls . | --log-opt syslog-tls-cert=/etc/ca-certificates/custom/cert.pem |
syslog-tls-key | TLS 密钥文件的绝对路径。如果地址协议不是 Ignore,则忽略tcp+tls . | --log-opt syslog-tls-key=/etc/ca-certificates/custom/key.pem |
syslog-tls-skip-verify | 如果设置为true ,则在连接到syslog 守护 进程。默认为false .如果地址协议不是 Ignore,则忽略tcp+tls . | --log-opt syslog-tls-skip-verify=true |
tag | 附加到APP-NAME 在syslog 消息。默认情况下,Docker 使用容器 ID 的前 12 个字符来标记日志消息。请参阅 log tag option 文档 以自定义日志标签格式。 | --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) |