Gelf 输出插件

编辑
  • 插件版本:v3.1.7
  • 发布日期:2018-04-06
  • 更新日志

有关其他版本,请参阅版本化插件文档

安装

编辑

对于默认未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-gelf 轻松安装。有关更多详细信息,请参阅使用插件

获取帮助

编辑

有关插件的问题,请在Discuss论坛中开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵

描述

编辑

此输出以 GELF 格式生成消息。如果您想使用 Logstash 将事件输出到 Graylog2,这将非常有用。

更多信息请访问Graylog2 GELF 规范页面

Gelf 输出配置选项

编辑

此插件支持以下配置选项以及稍后描述的通用选项

另请参阅通用选项,了解所有输出插件支持的选项列表。

 

chunksize

编辑
  • 值类型为数字
  • 默认值为1420

分块大小。通常不需要更改此项。

custom_fields

编辑
  • 值类型为哈希
  • 默认值为{}

GELF 自定义字段映射。GELF 支持将任意属性作为自定义字段。这暴露了这一点。排除字段名称的_部分,例如,custom_fields => ['foo_field', 'some_value'] 设置 _foo_field = some_value

full_message

编辑
  • 值类型为字符串
  • 默认值为"%{message}"

GELF 完整消息。此处允许使用%{foo}等动态值。

host

编辑
  • 这是一个必需的设置。
  • 值类型为字符串
  • 此设置没有默认值。

Graylog2 服务器 IP 地址或主机名。

ignore_metadata

编辑
  • 值类型为数组
  • 默认值为 ["@timestamp", "@version", "severity", "host", "source_host", "source_path", "short_message"]

设置 ship_metadata 时忽略这些字段。通常,这将列出用于 GELF 字段动态值的字段。

level

编辑
  • 值类型为数组
  • 默认值为["%{severity}", "INFO"]

GELF 消息级别。此处允许使用%{level}等动态值;如果您想从事件中解析 日志级别 并将其用作 GELF 级别/严重性,这将非常有用。

此处的值可以是整数 [0..7](包括),也可以是 "debug"、"info"、"warn"、"error"、"fatal"(不区分大小写)。这些的单字符版本也是有效的,例如 "d"、"i"、"w"、"e"、"f"、"u"。还接受来自 Logstash 的 syslog_pri 筛选器的以下附加 severity_labels:"emergency"、"alert"、"critical"、"warning"、"notice" 和 "informational"。

port

编辑
  • 值类型为数字
  • 默认值为12201

Graylog2 服务器端口号。

protocol

编辑

默认情况下,此插件通过 UDP 传输协议输出,但可以配置为改用 TCP。

此处的值可以是“TCP”或“UDP”。

sender

编辑
  • 值类型为字符串
  • 默认值为"%{host}"

允许覆盖 GELF sender 字段。如果您想使用除事件源主机之外的其他内容作为事件的“发送者”,这将非常有用。这种情况通常是使用应用程序名称而不是主机名。

ship_metadata

编辑

Logstash 是否应发送事件对象中的元数据?这将导致 Logstash 在 GELF 消息中发送事件中的任何字段(例如 grok 创建的字段)。这些将作为带下划线的“附加字段”发送。

ship_tags

编辑

发送事件中的标记。这将导致 Logstash 将事件的标记作为字段\_tags发送。

short_message

编辑
  • 值类型为字符串
  • 默认值为"short_message"

GELF 短消息字段名称。如果该字段不存在或为空,则改为使用事件消息。

通用选项

编辑

所有输出插件都支持这些配置选项

设置 输入类型 必需

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑
  • 值类型为codec
  • 默认值为"plain"

用于输出数据的编解码器。输出编解码器是一种方便的方法,可以在数据离开输出之前对其进行编码,而无需在 Logstash 管道中使用单独的过滤器。

enable_metric

编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下,我们会记录所有可以记录的指标,但您可以禁用特定插件的指标收集。

  • 值类型为字符串
  • 此设置没有默认值。

向插件配置添加唯一的ID。如果未指定 ID,Logstash 将生成一个 ID。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用。例如,如果您有 2 个 gelf 输出。在这种情况下添加一个命名的 ID 将有助于在使用监控 API 时监控 Logstash。

output {
  gelf {
    id => "my_plugin_id"
  }
}

id字段中的变量替换仅支持环境变量,不支持使用来自密钥存储的值。