› ›

Snmptrap 输入插件

编辑

Snmptrap 输入插件编辑

插件版本：v3.1.0
发布时间：2021-11-19
更新日志

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

获取帮助编辑

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

描述编辑

将 snmp 陷阱消息读取为事件

生成的 message 字段类似于

  #<SNMP::SNMPv1_Trap:0x6f1a7a4 @varbind_list=[#<SNMP::VarBind:0x2d7bcd8f @value="teststring",
  @name=[1.11.12.13.14.15]>], @timestamp=#<SNMP::TimeTicks:0x1af47e9d @value=55>, @generic_trap=6,
  @enterprise=[1.2.3.4.5.6], @source_ip="127.0.0.1", @agent_addr=#<SNMP::IpAddress:0x29a4833e @value="\xC0\xC1\xC2\xC3">,
  @specific_trap=99>

与 Elastic 通用模式 (ECS) 的兼容性编辑

由于 SNMP 数据具有基于 OID 的特定字段名称，因此我们建议设置target。源主机字段根据ecs_compatibility而变化。

ECS 禁用

ECS v1、v8

描述

[主机]

Snmptrap 输入配置选项编辑

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

设置	输入类型	必需
`community`	数组	否
`ecs_compatibility`	字符串	否
`主机`	字符串	否
`端口`	数字	否
`目标`	字符串	否
`yamlmibdir`	字符串	否

另请参阅通用选项，以获取所有输入插件支持的选项列表。

`community`编辑

值类型为数组
默认值为 "public"

要侦听的 SNMP 社区字符串。

`ecs_compatibility`编辑

值类型为字符串
支持的值为
- disabled：不使用与 ECS 兼容的字段名称（字段可能设置在事件的根目录下）
- v1、v8：避免可能与 Elastic 通用模式冲突的字段名称（例如，host 字段）
默认值取决于运行的 Logstash 版本
- 当 Logstash 提供 pipeline.ecs_compatibility 设置时，其值将用作默认值
- 否则，默认值为 disabled。

控制此插件与Elastic 通用模式 (ECS)的兼容性。

`host`编辑

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

要侦听的地址

`port`编辑

值类型为数字
默认值为 1062

要侦听的端口。请记住，小于 1024 的端口（特权端口）可能需要 root 权限才能使用。因此默认为 1062。

`target`编辑

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

分配 SNMP 有效负载的字段的名称。如果未指定，数据将存储在事件的根目录下。

当启用ecs_compatibility时，建议设置目标。

`yamlmibdir`编辑

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

YAML MIB 映射目录（与 ruby-snmp 使用的格式相同）

通用选项编辑

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

设置	输入类型	必需
`add_field`	哈希	否
`编解码器`	编解码器	否
`enable_metric`	布尔值	否
`ID`	字符串	否
`标签`	数组	否
`类型`	字符串	否

详细信息编辑

`add_field`编辑

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

向事件添加字段

`codec`编辑

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

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

`enable_metric`编辑

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

默认情况下，我们记录所有可以记录的指标，但您可以禁用特定插件的指标收集。

`id`编辑

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

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

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

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

`tags`编辑

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

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

这有助于以后的处理。

`type`编辑

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

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

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

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

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

« SNMP 输入插件 Sqlite 输入插件 »

Snmptrap 输入插件

Snmptrap 输入插件编辑

获取帮助编辑

描述编辑

与 Elastic 通用模式 (ECS) 的兼容性编辑

Snmptrap 输入配置选项编辑

community编辑

ecs_compatibility编辑

host编辑

port编辑

target编辑

yamlmibdir编辑