Snmptrap input plugin v3.1.0

edit
  • Plugin version: v3.1.0
  • Released on: 2021-11-19
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting help

edit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

edit

Read snmp trap messages as events

Resulting message field resembles:

  #<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>

Compatibility with the Elastic Common Schema (ECS)

edit

Because SNMP data has specific field names based on OIDs, we recommend setting a target. The source host field changes based on ecs_compatibility.

ECS disabled

ECS v1, v8

Description

[host]

Snmptrap Input Configuration Options

edit

This plugin supports the following configuration options plus the Common options described later.

Setting Input type Required

community

array

No

ecs_compatibility

string

No

host

string

No

port

number

No

target

string

No

yamlmibdir

string

No

Also see Common options for a list of options supported by all input plugins.

 

community

edit
  • Value type is array
  • Default value is "public"

SNMP Community String to listen for.

ecs_compatibility

edit
  • Value type is string
  • Supported values are:

    • disabled: does not use ECS-compatible field names (fields might be set at the root of the event)
    • v1, v8: avoids field names that might conflict with Elastic Common Schema (for example, the host field)
  • Default value depends on which version of Logstash is running:

    • When Logstash provides a pipeline.ecs_compatibility setting, its value is used as the default
    • Otherwise, the default value is disabled.

Controls this plugin’s compatibility with the Elastic Common Schema (ECS).

host

edit
  • Value type is string
  • Default value is "0.0.0.0"

The address to listen on

port

edit
  • Value type is number
  • Default value is 1062

The port to listen on. Remember that ports less than 1024 (privileged ports) may require root to use. hence the default of 1062.

target

edit
  • Value type is string
  • There is no default value for this setting

The name of the field under which SNMP payloads are assigned. If not specified data will be stored in the root of the event.

Setting a target is recommended when ecs_compatibility is enabled.

yamlmibdir

edit
  • Value type is string
  • There is no default value for this setting.

directory of YAML MIB maps (same format ruby-snmp uses)

Common options

edit

These configuration options are supported by all input plugins:

Setting Input type Required

add_field

hash

No

codec

codec

No

enable_metric

boolean

No

id

string

No

tags

array

No

type

string

No

add_field

edit
  • Value type is hash
  • Default value is {}

Add a field to an event

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

enable_metric

edit
  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 snmptrap inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

tags

edit
  • Value type is array
  • There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

type

edit
  • Value type is string
  • There is no default value for this setting.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.