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 地址}/{端口}，例如 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_mapping_format选项上设置的配置 OID 文本表示形式来映射类型为 OID的 Logstash 事件字段值。

oid_root_skip选项指定在事件字段名称中要忽略的 OID 根数字的数量。例如，在像“1.3.6.1.2.1.1.1.0”这样的数字 OID 中，可以通过设置oid_root_skip => 5来忽略前 5 位数字，这将导致字段名称“1.1.1.0”。类似地，当使用 MIB 时，像“1.3.6.1.2.mib-2.system.sysDescr.0”这样的 OID 将变为“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（管理信息库），这些 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。强烈建议在您的配置中设置此 ID。当您有两个或多个相同类型的插件时，此功能特别有用，例如，如果您有 2 个 snmp 输入。在这种情况下添加命名 ID 将有助于在使用监视 API 时监视 Logstash。

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

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

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

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

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

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

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