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。当您有两个或多个相同类型的插件时,这尤其有用。例如,如果您有两个 gelf 输出。在这种情况下,添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

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

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