Graylog 扩展格式日志驱动程序

目录

gelf日志驱动是一个方便的格式，许多工具都支持它，例如Graylog，Logstash和Fluentd。许多工具都使用此格式。

在GELF中，每条日志消息都是一个包含以下字段的字典：

  • 版本
  • 主机（最初发送消息的主机）
  • 时间戳
  • 消息的短版本和长版本
  • 您自己配置的任何自定义字段

用法

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

以下示例将日志驱动程序设置为gelf并设置gelf-address选项。

{
  "log-driver": "gelf",
  "log-opts": {
    "gelf-address": "udp://1.2.3.4:12201"
  }
}

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

注意

daemon.json配置文件中的log-opts配置选项必须以字符串形式提供。因此，布尔值和数值（例如gelf-tcp-max-reconnect的值）必须用引号 (") 括起来。

您可以通过在使用docker container create或docker run时设置--log-driver标志来为特定容器设置日志驱动程序。

$ 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 GELF驱动程序用于压缩每条日志消息的压缩类型。允许的值为gzip、zlib和none。默认为gzip。请注意，启用压缩会导致CPU使用率过高，因此强烈建议将其设置为none。--log-opt gelf-compression-type=gzip
gelf-compression-level可选仅限UDP 当gelf-compression-type为gzip或zlib时的压缩级别。-1到9（BestCompression）范围内的整数。默认值为1（BestSpeed）。较高的级别在较低速度下提供更多压缩。-1或0禁用压缩。--log-opt gelf-compression-level=2
gelf-tcp-max-reconnect可选仅限TCP 连接断开时的最大重新连接尝试次数。正整数。默认值为3。--log-opt gelf-tcp-max-reconnect=3
gelf-tcp-reconnect-delay可选仅限TCP 重新连接尝试之间等待的秒数。正整数。默认值为1。--log-opt gelf-tcp-reconnect-delay=1
tag 标签可选附加到gelf消息中APP-NAME的字符串。默认情况下，Docker 使用容器 ID 的前 12 个字符作为日志消息的标签。请参考日志标签选项文档以自定义日志标签格式。--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 保护的输入的消息可能会静默失败。

示例

此示例配置容器以使用在端口12201上192.168.0.42运行的 GELF 服务器。

$ docker run -dit \
    --log-driver=gelf \
    --log-opt gelf-address=udp://192.168.0.42:12201 \
    alpine sh