› ›

Gelf 输入插件

编辑

Gelf 输入插件

编辑

插件版本：v3.3.2
发布日期：2022-08-22
变更日志

其他版本请参见版本化插件文档。

获取帮助

编辑

如有任何关于插件的问题，请在 Discuss 论坛中发帖提问。如发现错误或有功能需求，请在 Github 中提交问题。如需查看 Elastic 支持的插件列表，请参阅 Elastic 支持矩阵。

描述

编辑

此输入插件将通过网络读取 GELF 消息作为事件，如果您已经在使用 Graylog2，则这是一个不错的选择。

此输入插件的主要用例是利用现有的 GELF 日志记录库，例如 GELF log4j appender。

Gelf 输入配置选项

编辑

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

设置	输入类型	必填
`host`	字符串	否
`use_udp`	布尔值	否
`use_tcp`	布尔值	否
`端口`	数字	否
`port_tcp`	数字	否
`port_udp`	数字	否
`remap`	布尔值	否
`strip_leading_underscore`	布尔值	否

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

`host`

编辑

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

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

`use_udp`

编辑

值类型为布尔值
默认值为 true

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

`use_tcp`

编辑

值类型为布尔值
默认值为 false

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

`port`

编辑

值类型为数字
默认值为 12201

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

`port_tcp`

编辑

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

要监听的 TCP 端口。除非您需要为 UDP 设置与 TCP 不同的端口，否则请使用 port 设置而不是此设置。

`port_udp`

编辑

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

要监听的 UDP 端口。除非您需要为 UDP 设置与 TCP 不同的端口，否则请使用 port 设置而不是此设置。

`remap`

编辑

值类型为布尔值
默认值为 true

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

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

full\_message 转换为 event.get("message")。
如果没有 full\_message，则 short\_message 转换为 event.get("message")。

`strip_leading_underscore`

编辑

值类型为布尔值
默认值为 true

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

例如 \_foo 转换为 foo

通用选项

编辑

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

设置	输入类型	必填
`add_field`	哈希表	否
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否
`tags`	数组	否
`type`	字符串	否

`add_field`

编辑

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

向事件添加字段

`codec`

编辑

值类型为 codec
默认值为 "plain"

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

`enable_metric`

编辑

值类型为布尔值
默认值为 true

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

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

`type`

编辑

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

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

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

类型存储在事件本身中，因此您也可以使用类型在 Kibana 中搜索它。

如果您尝试在已经拥有类型的事件上设置类型（例如，当您将事件从发件人发送到索引器时），则新的输入将不会覆盖现有类型。即使发送到另一个 Logstash 服务器，在发件人处设置的类型也会一直保留在该事件中。

« Ganglia 输入插件 Generator 输入插件 »