› ›

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`	数字	否
`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`

编辑

值类型是编解码器
默认值是 "plain"

用于输入数据的编解码器。输入编解码器是一种方便的方法，可以在数据进入输入之前解码数据，而无需在 Logstash 管道中单独设置过滤器。

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

这有助于稍后处理。

`type`

编辑

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

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

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

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

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

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