Graylog 扩展格式日志记录驱动程序
目录
这gelflogging 驱动程序是一种方便的格式,许多工具(如 Graylog、Logstash 和 Fluentd)都可以理解它。许多工具都使用这种格式。
在 GELF 中,每条日志消息都是一个 dict,其中包含以下字段:
- 版本
- Host(最初发送消息的人)
- 时间戳
- 消息的简短版本和长期版本
- 您自己配置的任何自定义字段
用法
要使用gelfdriver 作为默认的日志记录驱动程序,将log-driver和log-optkeys 添加到daemon.json文件,该文件位于
在/etc/docker/在 Linux 主机上或C:\ProgramData\docker\config\daemon.json在 Windows Server 上。有关使用 Docker 配置 Docker 的更多信息daemon.json,请参阅 daemon.json。
以下示例将日志驱动程序设置为gelf并设置gelf-address选择。
{
"log-driver": "gelf",
"log-opts": {
"gelf-address": "udp://1.2.3.4:12201"
}
}重新启动 Docker 以使更改生效。
注意
log-opts配置选项中的daemon.json配置文件必须 以字符串形式提供。布尔值和数值(例如gelf-tcp-max-reconnect) 必须用引号 () 括起来。"
您可以通过设置--log-driver标志docker container create或docker run:
$ docker run \
--log-driver gelf --log-opt gelf-address=udp://1.2.3.4:12201 \
alpine echo hello world
GELF 选项
这gelf日志记录驱动程序支持以下选项:
| 选择 | 必填 | 描述 | 示例值 |
|---|---|---|---|
gelf-address | 必填 | GELF 服务器的地址。tcp和udp是唯一受支持的 URI 说明符,您必须指定端口。 | --log-opt gelf-address=udp://192.168.0.42:12201 |
gelf-compression-type | 自选 | UDP OnlyGELF 驱动程序用于压缩每条日志消息的压缩类型。允许的值为gzip,zlib和none.默认值为gzip.请注意,启用压缩会导致 CPU 使用率过高,因此强烈建议将其设置为none. | --log-opt gelf-compression-type=gzip |
gelf-compression-level | 自选 | UDP Only压缩级别gzip或zlib是gelf-compression-type.范围为-1自9(最佳压缩)。默认值为 1 (BestSpeed)。较高的级别以较低的速度提供更多的压缩。也-1或0禁用压缩。 | --log-opt gelf-compression-level=2 |
gelf-tcp-max-reconnect | 自选 | TCP Only连接断开时的最大重新连接尝试次数。一个正整数。默认值为 3。 | --log-opt gelf-tcp-max-reconnect=3 |
gelf-tcp-reconnect-delay | 自选 | TCP Only两次重新连接尝试之间等待的秒数。正整数。默认值为 1。 | --log-opt gelf-tcp-reconnect-delay=1 |
tag | 自选 | 附加到APP-NAME在gelf消息。默认情况下,Docker 使用容器 ID 的前 12 个字符来标记日志消息。请参阅 log tag option 文档以自定义日志标签格式。 | --log-opt tag=mailer |
labels | 自选 | 在启动 Docker 守护程序时应用。此守护程序接受的与日志记录相关的标签的逗号分隔列表。在extra字段,前缀为下划线 ()。用于高级日志标记选项。_ | --log-opt labels=production_status,geo |
labels-regex | 自选 | 与 类似并兼容labels.用于匹配与日志记录相关的标签的正则表达式。用于高级日志标记选项。 | --log-opt labels-regex=^(production_status|geo) |
env | 自选 | 在启动 Docker 守护程序时应用。此守护程序接受的与日志记录相关的环境变量的逗号分隔列表。在extra字段,前缀为下划线 ()。用于高级日志标记选项。_ | --log-opt env=os,customer |
env-regex | 自选 | 与 类似并兼容env.用于匹配与日志记录相关的环境变量的正则表达式。用于高级日志标记选项。 | --log-opt env-regex=^(os|customer) |
注意
这
gelf驱动程序不支持 TCP 连接的 TLS。发送到受 TLS 保护的输入的消息可能会失败,且不会提示失败。
例子
此示例将容器配置为使用运行在192.168.0.42在端口12201.
$ docker run -dit \
--log-driver=gelf \
--log-opt gelf-address=udp://192.168.0.42:12201 \
alpine sh