Udp 输入插件编辑

  • 插件版本: v3.5.0
  • 发布日期: 2021-08-04
  • 变更日志

有关其他版本,请参阅 版本化插件文档

获取帮助编辑

有关插件的问题,请在 讨论 论坛中发布主题。对于错误或功能请求,请在 Github 中打开问题。有关 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 输入配置选项编辑

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

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

 

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编辑

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

logstash 将监听的地址。

port编辑

  • 这是一个必需的设置。
  • 值类型为 数字
  • 此设置没有默认值。

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

queue_size编辑

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

这是在数据包开始丢失之前,您可以将未处理的 UDP 数据包保存在内存中的数量。

receive_buffer_bytes编辑

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

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

source_ip_fieldname编辑

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

示例

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

workers编辑

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

处理数据包的线程数

通用选项编辑

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

详细信息编辑

 

add_field编辑

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

向事件添加字段

codec编辑

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

enable_metric编辑

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

id编辑

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

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

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

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

tags编辑

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

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

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

type编辑

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

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

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

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

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