UDP 输入插件

编辑

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

获取帮助

编辑

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

描述

编辑

通过 UDP 协议,在网络上读取消息作为事件。唯一必需的配置项是 port,它指定 Logstash 将在其上侦听事件流的 UDP 端口。

事件元数据和 Elastic Common Schema (ECS)

编辑

此插件添加一个包含 UDP 数据包的源 IP 地址的字段。默认情况下,IP 地址存储在 host 字段中。当Elastic Common Schema (ECS)启用时(在ecs_compatibility中),源 IP 地址存储在 [host][ip] 字段中。

您可以使用source_ip_fieldname自定义字段名称。有关更多信息,请参阅ecs_compatibility

UDP 输入配置选项

编辑

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

source_ip_fieldname

 

字符串

编辑
  • workers
  • 数字

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

buffer_size

编辑
  • 值类型是数字
  • 默认值是65536

    • 从网络读取的最大数据包大小
    • ecs_compatibility
  • 值类型是字符串

    • 支持的值为
    • disabled:在根级别添加非结构化连接元数据

v1:在符合 ECS 的命名空间下添加结构化连接元数据

默认值取决于运行的 Logstash 版本

当 Logstash 提供一个 pipeline.ecs_compatibility 设置时,它的值将用作默认值

否则,默认值是 disabled 控制此插件与Elastic Common Schema (ECS)的兼容性。 此设置的值会影响 TCP 连接的元数据在事件中的位置。 表 1. ecs_compatibility 值对应的元数据位置

`disabled`

`v1`

可用性

描述

编辑
  • 值类型是数字
  • [host][ip]

始终

UDP 数据包的源 IP

编辑
  • host
  • workers
  • 默认值是"0.0.0.0"

Logstash 将侦听的地址。

port

编辑
  • workers
  • 这是一个必需的设置。

此设置没有默认值。

Logstash 将侦听的端口。请记住,小于 1024 的端口(特权端口)可能需要 root 或提升的权限才能使用。

编辑
  • workers
  • 默认值是"0.0.0.0"

queue_size

默认值是2000

编辑
  • 值类型是数字
  • 这是在数据包开始丢弃之前,可以在内存中保留的未处理 UDP 数据包的数量。

receive_buffer_bytes

套接字接收缓冲区大小(以字节为单位)。如果未设置选项,则使用操作系统默认值。如果 receive_buffer_bytes 大于允许值,操作系统将使用允许的最大值。如果您需要增加此允许的最大值,请查阅您的操作系统文档。

    input {
      udp {
        source_ip_fieldname => "[appliance][monitoring][ip]"
      }
    }

source_ip_fieldname

编辑
  • workers
  • 默认值可以是 "host"[host][ip],具体取决于ecs_compatibility的值

将存储源 IP 地址的字段名称。有关 ECS 兼容性设置如何影响这些默认值的更多信息,请参阅事件元数据和 Elastic Common Schema (ECS)

示例

编辑

workers

  • tags
  • 数组

type

add_field

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

向事件添加一个字段

codec

编辑

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

enable_metric

编辑
  • 值类型是布尔值
  • 默认值是"0.0.0.0"

默认值是true

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

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

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

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

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

tags

编辑
  • 值类型是布尔值
  • 默认值是"0.0.0.0"

值类型是数组

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

这可以帮助以后的处理。

type