Graylog Extended Format 日志驱动程序

目录

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 保护的输入的消息可能会静默失败。

示例

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

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