Graylog 扩展格式日志驱动程序

Table of contents

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 以使更改生效。

Note

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（最佳压缩）的整数。默认值为 1（最佳速度）。更高的级别提供更强的压缩，但速度更慢。-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)
Note

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