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（最佳压缩）之间的整数。默认值为 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 daemon 时应用。daemon 接受的日志相关标签的逗号分隔列表。在 extra 字段上添加附加键，前缀为下划线 (_)。用于高级日志标签选项。--log-opt labels=production_status,geo
labels-regex可选类似于 labels 并与之兼容。用于匹配日志相关标签的正则表达式。用于高级日志标签选项。--log-opt labels-regex=^(production_status|geo)
env可选在启动 Docker daemon 时应用。daemon 接受的日志相关环境变量的逗号分隔列表。在 extra 字段上添加附加键，前缀为下划线 (_)。用于高级日志标签选项。--log-opt env=os,customer
env-regex可选类似于 env 并与之兼容。用于匹配日志相关环境变量的正则表达式。用于高级日志标签选项。--log-opt env-regex=^(os|customer)

注意

gelf 驱动程序不支持 TCP 连接的 TLS。发送到受 TLS 保护的输入的邮件可能会静默失败。

示例

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

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