Gelf 输入插件编辑

  • 插件版本: v3.3.2
  • 发布时间: 2022-08-22
  • 变更日志

对于其他版本,请参阅 版本化插件文档

获取帮助编辑

如果您对插件有任何疑问,请在 讨论 论坛中发布主题。对于错误或功能请求,请在 Github 中打开问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵

描述编辑

此输入将通过网络读取 GELF 消息作为事件,如果您今天已经使用 Graylog2,那么它是一个不错的选择。

此输入的主要用例是利用现有的 GELF 日志记录库,例如 GELF log4j 附加程序。

Gelf 输入配置选项编辑

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

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

 

host编辑

  • 值类型为 字符串
  • 默认值为 "0.0.0.0"

要监听的 IP 地址或主机名。

use_udp编辑

是否监听通过 udp 发送的 gelf 消息

use_tcp编辑

是否监听通过 tcp 发送的 gelf 消息

port编辑

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

要监听的端口。请记住,小于 1024 的端口(特权端口)可能需要 root 才能使用。port_tcp 和 port_udp 可用于为每个协议设置特定端口。

port_tcp编辑

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

要监听的 Tcp 端口。除非您需要与 tcp 不同的 udp 端口,否则请使用 port 而不是此设置。

port_udp编辑

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

要监听的 Udp 端口。除非您需要与 tcp 不同的 udp 端口,否则请使用 port 而不是此设置。

remap编辑

是否将 GELF 消息字段重新映射到 Logstash 事件字段,或保持原样。

重新映射将以下 GELF 字段转换为 Logstash 等效项

  • full\_message 变成 event.get("message")
  • 如果没有 full\_message,则 short\_message 变成 event.get("message")

strip_leading_underscore编辑

是否删除 GELF 字段中的前导 \_ 或保留它们。(Logstash < 1.2 默认情况下不会删除它们)。请注意,GELF 版本 1.1 格式现在要求所有非标准字段作为“附加”字段添加,以下划线开头。

例如,\_foo 变成 foo

通用选项编辑

以下配置选项由所有输入插件支持

设置 输入类型 必需

add_field

hash

codec

codec

enable_metric

布尔值

id

字符串

tags

array

type

字符串

详细信息编辑

 

add_field编辑

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

向事件添加字段

codec编辑

用于输入数据的编解码器。输入编解码器是在数据进入输入之前对其进行解码的便捷方法,无需在 Logstash 管道中使用单独的过滤器。

enable_metric编辑

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

id编辑

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

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

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

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

tags编辑

  • 值类型为 数组
  • 此设置没有默认值。

向您的事件添加任意数量的任意标签。

这可以帮助以后进行处理。

type编辑

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

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型存储为事件本身的一部分,因此您也可以使用类型在 Kibana 中搜索它。

如果您尝试在已经具有类型的事件上设置类型(例如,当您从发件人发送事件到索引器时),那么新的输入将不会覆盖现有的类型。在发件人处设置的类型会一直保留在该事件中,即使它被发送到另一个 Logstash 服务器也是如此。