Graylog 扩展格式日志记录驱动程序

日志记录驱动程序gelf是一种方便的格式，许多工具（例如 Graylog、 Logstash和 Fluentd ）都可以理解它。许多工具都使用这种格式。

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

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

用法

要将gelf驱动程序用作默认日志记录驱动程序，请将log-driver和 log-opt键设置为文件中的适当值daemon.json，该文件位于/etc/docker/Linux 主机或C:\ProgramData\docker\config\daemon.json Windows Server 上。有关使用配置 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 Onlygzip当或zlib为 时的压缩级别gelf-compression-type。范围为-1到9(BestCompression) 的整数。默认值为 1（最佳速度）。较高的级别以较低的速度提供更多的压缩。或禁用压缩-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-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.42port 上运行的 GELF 服务器12201。

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