SNMP 输入插件

控制此插件与 Elastic Common Schema (ECS) 的兼容性。

使用 get 选项查询给定 OID 的标量值。一个或多个 OID 指定为 OID 字符串数组。

示例

input {
  snmp {
    get => ["1.3.6.1.2.1.1.1.0", "1.3.6.1.2.1.1.3.0", "1.3.6.1.2.1.1.5.0"]
    hosts => [{host => "udp:127.0.0.1/161" community => "public"}]
  }
}

hosts 选项指定要查询配置的 get 和 walk 选项的主机列表。

每个主机定义都是一个哈希，并且必须定义 host 键和值。host 必须使用格式 {tcp|udp}:{ip address}/{port}，例如 host => "udp:127.0.0.1/161"

每个主机定义可以选择包含以下键和值

指定所有主机选项

input {
  snmp {
    get => ["1.3.6.1.2.1.1.1.0"]
    hosts => [{host => "udp:127.0.0.1/161" community => "public" version => "2c"  retries => 2  timeout => 1000}]
  }
}

指定多个主机

input {
  snmp {
    get => ["1.3.6.1.2.1.1.1.0"]
    hosts => [{host => "udp:127.0.0.1/161" community => "public"}, {host => "udp:192.168.0.1/161" community => "private"}]
  }
}

指定 IPv6 主机

input {
  snmp {
    get => ["1.3.6.1.2.1.1.1.0"]
    hosts => [{host => "udp:[::1]/161" community => "public"}, {host => "udp:[2001:db8::2:1]/161" community => "private"}]
  }
}

interval 选项指定轮询间隔（以秒为单位）。如果轮询所有配置的主机花费的时间超过此间隔，则会向日志发出警告。

SNMPv3 本地引擎 ID。其长度必须大于或等于 5，小于或等于 32。如果未提供，则会根据本地 IP 地址和另外四个随机字节生成默认 ID。

mib_paths 选项指定一个或多个导入的 MIB 文件的位置。该值可以是包含导入的 MIB（.dic、.yaml）文件的目录路径，也可以是单个 MIB 文件的文件路径。

此插件包含 IETF MIB。如果您需要其他 MIB，则需要导入它们。请参阅 导入 MIB。

定义 Logstash 事件中 OID 的映射文本表示形式

定义类型为 OID 的 Logstash 事件字段值是否使用 oid_mapping_format 选项中设置的配置的 OID 文本表示形式进行映射。

oid_root_skip 选项指定在事件字段名称中忽略的 OID 根数字的数量。例如，在像“1.3.6.1.2.1.1.1.0”这样的数字 OID 中，可以通过设置 oid_root_skip => 5 来忽略前 5 位数字，这将导致字段名称为“1.1.1.0”。类似地，当使用 MIB 时，OID“1.3.6.1.2.mib-2.system.sysDescr.0”将变为“mib-2.system.sysDescr.0”

选项 oid_path_length 用于指定在事件字段名称中保留的 OID 根数字的数量。例如，对于像 "1.3.6.1.2.1.1.1.0" 这样的数字 OID，可以通过设置 oid_path_length => 2 来保留最后 2 位数字，这将导致字段名称为 "1.0"。类似地，当使用 MIB 时，像 "1.3.6.1.2.mib-2.system.sysDescr.0" 这样的 OID 将变为 "sysDescr.0"

指定轮询客户端等待所有 hosts 响应的最长时间（以毫秒为单位）。如果在超时时间到期之前未收到所有响应，则客户端将失败，并且某些主机可能不会在当前周期内进行轮询。

默认情况下，它使用 1 小时、配置的最高 hosts timeout 值以及 interval 值中的最高值。

使用 walk 选项检索给定 OID 的信息子树。一个或多个 OID 指定为 OID 字符串数组。

查询从给定 OID 开始的信息子树。

示例

  snmp {
    walk => ["1.3.6.1.2.1.1"]
    hosts => [{host => "udp:127.0.0.1/161" community => "public"}]
  }
}

选项 tables 用于查询给定列 OID 的表格值。

每个表定义都是一个哈希，必须定义名称键和值以及要返回的列。

指定单个表

input {
  snmp {
    hosts => [{host => "udp:127.0.0.1/161" community => "public" version => "2c"  retries => 2  timeout => 1000}]
    tables => [ {"name" => "interfaces" "columns" => ["1.3.6.1.2.1.2.2.1.1", "1.3.6.1.2.1.2.2.1.2", "1.3.6.1.2.1.2.2.1.5"]} ]
  }
}

指定多个表

input {
  snmp {
    get => ["1.3.6.1.2.1.1.1.0"]
    tables => [ {"name" => "interfaces" "columns" => ["1.3.6.1.2.1.2.2.1.1", "1.3.6.1.2.1.2.2.1.2", "1.3.6.1.2.1.2.2.1.5"]}, {"name" => "ltmPoolStatTable" "columns" => ["1.3.6.1.4.1.3375.2.2.5.2.3.1.1", "1.3.6.1.4.1.3375.2.2.5.2.3.1.6"]} ]
  }
}

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

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

用于执行主机 SNMP 请求的线程数。

此插件提供所有 IETF MIB（管理信息库），这些库在 libsmi 版本 0.5.0 中公开提供。启用后，它会自动加载捆绑的 MIB，并在生成的事件中提供数字 OID 到 MIB 字段名称的映射。

选项 auth_pass 用于指定 SNMPv3 身份验证密码短语或密码。

选项 auth_protocol 用于指定 SNMPv3 身份验证协议或类型。

选项 priv_pass 用于指定 SNMPv3 加密密码。

选项 priv_protocol 用于指定 SNMPv3 私密性/加密协议。

选项 security_level 用于指定 SNMPv3 安全级别，包括身份验证、无隐私；身份验证、隐私；或无身份验证、无隐私。

选项 security_name 用于指定 SNMPv3 安全名称或用户名。

向事件添加字段。

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

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

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

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

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

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

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

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

如果您尝试设置已具有类型的事件的类型（例如，当您从发送器发送事件到索引器时），则新的输入将不会覆盖现有类型。即使发送到其他 Logstash 服务器，在发送器处设置的类型也会与该事件保持一致。