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

日志记录驱动程序是一种方便的格式,许多工具(如 GraylogLogstashFluentd)都可以理解它。许多工具都使用这种格式。gelf

在 GELF 中,每条日志消息都是一个 dict,其中包含以下字段:

  • 版本
  • Host(最初发送消息的人)
  • 时间戳
  • 消息的简短版本和长期版本
  • 您自己配置的任何自定义字段

用法

要将驱动程序用作默认日志记录驱动程序,请在位于 在 Linux 主机或 Windows Server 上。有关使用 配置 Docker 的更多信息,请参阅 daemon.jsongelflog-driverlog-optdaemon.json/etc/docker/C:\ProgramData\docker\config\daemon.jsondaemon.json

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

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

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

注意

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

您可以通过在使用 或 时设置标志来为特定容器设置日志记录驱动程序:--log-driverdocker container createdocker 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 服务器的地址。 并且是唯一受支持的 URI 说明符,您必须指定端口。tcpudp--log-opt gelf-address=udp://192.168.0.42:12201
gelf-compression-type自选UDP OnlyGELF 驱动程序用于压缩每条日志消息的压缩类型。允许的值为 , 和 。默认值为 .请注意,启用压缩会导致 CPU 使用率过高,因此强烈建议将其设置为 。gzipzlibnonegzipnone--log-opt gelf-compression-type=gzip
gelf-compression-level自选UDP Only当 或 为 时,压缩级别为 。到 (BestCompression) 范围内的整数。默认值为 1 (BestSpeed)。较高的级别以较低的速度提供更多的压缩。或 禁用压缩。gzipzlibgelf-compression-type-19-10--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自选附加到消息中的 的字符串。默认情况下,Docker 使用容器 ID 的前 12 个字符来标记日志消息。请参阅 log tag option 文档 以自定义日志标签格式。APP-NAMEgelf--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)

注意

驱动程序不支持 TCP 连接的 TLS。发送到受 TLS 保护的输入的消息可能会失败,且不会提示失败。gelf

例子

此示例将容器配置为使用在 on port 上运行的 GELF 服务器。192.168.0.4212201

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