[META] SNMP input - first release roadmap

[colinsurprenant]

• The SNMP4J OSS Java library was chosen for the plugin runtime SNMP support. The plugin is written in Ruby by calling/wrapping the library classes. SNMP4J has support for all protocols SNMPv1/v2c/v3.

• The libsmi OSS library will be used for the external MIB files parsing support. Users will be able to import MIB files by installing libsmi on their platform and using the command line tool to import a MIB file for the plugin, with something like that:

smidump -k -f python path/to/some/original/mib > path/to/some/imported/mib.dic

No processing or computation is planned on the results. These will need to be done in downstream filters or at index/query time in ES/Kibana.

V1 Beta

See PR #1

• The plugin first iteration supportsthese options:

  • get on a configured list of OIDs to retrieve scalar values the these OIDs.
  • walk on a configured list of OIDs to retrieve the substree of information rooted at these OIDs.
  • hosts will specify a list of hosts addresses to perform the get and walk operations.
  • interval for the sleep interval between each poll cycle.
  • mib path to specify mib files for translating OID numbers to field names in the generated event.

• Only SNMPv2c over UDP is supported. (note that in beta3 SNMPv1 and TCP are supported)

• Simple threaded polling loop that cycles through all defined hosts to perform the get/walk operations. A single poll cycle including all get and walk results for a single host produces one event.

• Support MIB files to map the numeric OIDs to MIB field names in the resulting event.

• Support scalar values handling. No particular support for objects such as table.

• Field formatting, issue generated events fields using MIBs #3

V1 GA

• Support both UDP and TCP transport support tcp transport protocol #8
• Add host info in Event add host info in metadata and host field #7
• Add basic temporary documentation in the plugin wiki
• Support SNMPv1 add support for protocol version 1 #9
• Support SNMPv3 SNMPv3 support #27
• Better error handling
• Pre-package all MIBs included in libsmi into the plugin so these do not need to be imported Add support for provided MIBS #25
• Document usage in docs/index.asciidoc all options documentation #36

Post V1 GA

• Better test coverage
• Polling thread pool
• Hosts auto-discovery
• Distributed execution. This should tie-in with the future distributed LS architecture. We can also explore other ideas such as decoupling the hosts discovery from the polling and have the former feed the latter.
• Externally configured options such as hosts lists
• Support SNMP traps Can this plugin be extended to receive snmp traps? #44 [discuss] Design of Trap Handling #46
• Support for MIB Tables [discuss] event layout for MIB tables #45 SNMP Table support addition #49
• GETBULK support
• OID values MIB mapping Config option to perform mib mapping on values logstash-integration-snmp#39
• enhance OID root skip Change to the oid_root_skip functionality #34

[colinsurprenant]

initial version 0.1.0.beta1 merged in master.

[colinsurprenant]

0.1.0.beta3 pushed which adds support for SNMPv1 and TCP. Also 0.1.0.beta2 added host field information in the event.

[dfdalamar]

Hi, is there support for SNMPv2? I would love to start testing this.

[colinsurprenant]

@dfdalamar for now SNMPv1 and SNMPv2c are supported. Next in line is SNMPv3. Does SNMPv2c work for you?

[dfdalamar]

That is perfect!!!!

[colinsurprenant]

@dfdalamar looking forward for your feedback - do not hesitate to open bug/suggestion issues, I will followup as we are ramping up toward the 1.0 release soon.

[dfdalamar]

Please excuse my ignorance. How do I install this? Can I use the logstash plugin install command?

[colinsurprenant]

@dfdalamar since this is a beta version you have to explicitly specify the version like this:

$  bin/logstash-plugin install --version 0.1.0.beta3 logstash-input-snmp

[dfdalamar]

Thanks!!!!

[dfdalamar]

I have installed but cannot find the files to edit. I have all kinds of MIBS on my machine, I am running rrd with another program.

[colinsurprenant]

@dfdalamar could you please open a new issue with your specific usage problems and we can followup in there? This is not relevant to this release roadmap meta issue here. Thank you. Also note that there are configuration examples in the wiki that might be useful.

[swtrux]

I am very interested in using this new plugin but need the SNMPv3 support. I have not seen any progress lately in this tread. Is this feature still coming?

[colinsurprenant]

@swtrux I am about to resume work on the SNMPv3 support and review #21

[colinsurprenant]

I added initial support for SNMPv3 in #27 - once reviewed I will publish it in beta5.

[colinsurprenant]

0.1.0.beta5 was just published and includes a number of bug fixes, support for SNMPv3 and the inclusion of all ietf MIBs.

$ bin/logstash-plugin install --version 0.1.0.beta3 logstash-input-snmp

[edperry]

I will start looking at the snmpv3 next week,

[colinsurprenant]

v1.1.0 with table support is out!