切换语言

Graylog 扩展格式日志驱动程序

目录

gelf 日志驱动是一种方便的格式，被许多工具理解，例如 Graylog、 Logstash 和 Fluentd。许多工具使用这种格式。

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

  • 版本
  • 主机（最初发送消息的一方）
  • 时间戳
  • 消息的短版本和长版本
  • 您自己配置的任何自定义字段

用法

要将 gelf 驱动程序用作默认日志驱动程序，请在 Linux 主机上的 /etc/docker/ 或 Windows Server 上的 C:\ProgramData\docker\config\daemon.json 中的 daemon.json 文件中，将 log-driver 和 log-opt 键设置为适当的值。有关使用 daemon.json 配置 Docker 的更多信息，请参阅 daemon.json。

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

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

重启 Docker 以使更改生效。

注意

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 Only GELF驱动程序用于压缩每条日志消息的压缩类型。允许的值为gzip、zlib和none。默认值为gzip。请注意，启用压缩会导致CPU使用率过高，因此强烈建议将其设置为none。--log-opt gelf-compression-type=gzip
gelf-compression-level可选UDP Only 当 gzip 或 zlib 是 gelf-compression-type 时的压缩级别。一个在 -1 到 9（最佳压缩）范围内的整数。默认值为 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可选追加到 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 保护的输入的消息可能会静默失败。

示例

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

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