logstash-input-snmp 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fe1c5f85dcfcd638d7a15c9798f34d27cee90599d45b984e3a6a9d578233894
-  data.tar.gz: 4261ebb2f0e9d7ab9b7f73d11bc2e4b1af37c176131b14c97b4808c249176d45
+  metadata.gz: 10af98fea9ec23b72d7b713cd503c4b34167cf5cebd494f4e73e52f5b02a12c1
+  data.tar.gz: f009f89f26dc5b8fff9d3fa07dacd577999c13589a175417178db1219063c98c
 SHA512:
-  metadata.gz: 89ee144bd1e2a3d40dcdd355bac9b330a93b0b011739367721c82e33adca7762e716c53db4f95ae5816a87f004a1155f824603acf0c8f57025ac14502f5b4f11
-  data.tar.gz: d7879c1a5de45a5e8f50574223dc883723cdda586540409ced17442f79396fb42669ce6bec8302c3f62d97a2b49927e3e62e7157ac23bec6ebbf05831e753e32
+  metadata.gz: 1db41b3f534bac5a03dbfd45210ebe2e944b361029d80e1bcc1131c4b1e35f363b72c07ad7771a3c54eca21c31b67e11fac8a725bcabd0b31e11a68bdbecdbdd
+  data.tar.gz: ece59ff5c72ccea90e8223fed33978ed4a7b6d486928d6c63eaf8f5696d85ec41e3a352ead03e6bcdb9abca8ae60a9fe5da6908f1a1cb43ea72666461b13cd8a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+## 1.3.3
+  - Silence warnings when loading dictionary MIB files [#118](https://github.com/logstash-plugins/logstash-input-snmp/pull/118)
+
 ## 1.3.2
-  -  Docs: add troubleshooting help for "failed to locate MIB module" error when using smidump to convert MIBs
+  -  [DOC] Add troubleshooting help for "failed to locate MIB module" error when using smidump to convert MIBs [#112](https://github.com/logstash-plugins/logstash-input-snmp/pull/112)
+  -  Fix CI failures [#113](https://github.com/logstash-plugins/logstash-input-snmp/pull/113)
 
 ## 1.3.1
   -  Refactor: handle no response(s) wout error logging [#105](https://github.com/logstash-plugins/logstash-input-snmp/pull/105)
@@ -15,7 +19,7 @@
   - Added integration tests to ensure SNMP server and IPv6 connections [#90](https://github.com/logstash-plugins/logstash-input-snmp/issues/90). Fixes[#87](https://github.com/logstash-plugins/logstash-input-snmp/issues/87).
 
 ## 1.2.6
-  - Docs: example on setting IPv6 hosts [#89](https://github.com/logstash-plugins/logstash-input-snmp/pull/89)
+  - [DOC] Add example on setting IPv6 hosts [#89](https://github.com/logstash-plugins/logstash-input-snmp/pull/89)
 
 ## 1.2.5
   - Updated snmp4j library to v2.8.4 [#86](https://github.com/logstash-plugins/logstash-input-snmp/pull/86)

data/README.md

@@ -17,7 +17,7 @@ Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/log
 
 ## Developing
 
-### 1. Plugin Developement and Testing
+### 1. Plugin Development and Testing
 
 #### Code
 - To get started, you'll need JRuby with the Bundler gem installed.

data/docs/index.asciidoc

@@ -54,7 +54,7 @@ libsmi is available and installable on most operating systems.
 
 To import a MIB, you need to first convert the ASN.1 MIB file into a `.dic` file using the libsmi `smidump` command line utility.
 
-Example (using `RFC1213-MIB` file)
+*Example (using `RFC1213-MIB` file)*
 
 [source,sh]
 -----
@@ -63,37 +63,48 @@ $ smidump --level=1 -k -f python RFC1213-MIB > RFC1213-MIB.dic
 
 Note that the resulting file as output by `smidump` must have the `.dic` extension.
 
-As `smidump` only looks for mib dependencies in its pre-configured path lists as defined in the documentaion in the https://www.ibr.cs.tu-bs.de/projects/libsmi/smi_config.html["MODULES LOCATIONS"] section, you may need to provide the paths to locations of MIBs in your particular environment to avoid a `failed to locate MIB module` error.
+[id="plugins-{type}s-{plugin}-locate-mibs"]
+===== Preventing a `failed to locate MIB module` error 
 
-Two ways to achieve this are by using an environment variable or a config file to provide the additional path configuration.
+The `smidump` function looks for mib dependencies in its pre-configured path lists.
+You may need to provide the paths to locations of MIBs in your particular environment.
 
-Set the `SMIPATH` env var with the path to your mibs ensuring you include a prepended colon `:` for the path, for example:
+You can avoid  to avoid a `failed to locate MIB module` error by providing the additional path configuration information with:
+
+* an environment variable, or 
+* a config file to provide the additional path configuration.
+
+See the "MODULE LOCATIONS" section of the https://www.ibr.cs.tu-bs.de/projects/libsmi/smi_config.html[smi_config documentation] for more info. 
+
+[id="plugins-{type}s-{plugin}-env-var"]
+===== Option 1: Use an environment variable 
+
+Set the `SMIPATH` env var with the path to your mibs.
+Be sure to include a prepended colon (`:`) for the path.
 
 [source,sh]
 -----
-$ SMIPATH=":/path/to/mibs/" smidump -k -f python CISCO-PROCESS-MIB.mib > CISCO-PROCESS-MIB_my.dic
+$ SMIPATH=":/path/to/mibs/" smidump -k -f python CISCO-PROCESS-MIB.mib > CISCO-PROCESS-MIB_my.dic <1>
 -----
+<1> Notice the colon that preceeds the path definition. 
 
-NOTE: SMI docs on the prepended colon:
+[id="plugins-{type}s-{plugin}-mib-config"]
+===== Option 2: Provide a coniguration file
 
-  The ‘path’ command argument and the environment variable either start with a path separator character (‘:’ on UNIX-like systems, ‘;’ on MS-Windows systems) to append to the path, or end with a path separator character to prepend to the path, or otherwise completely replace the path.
-
-
-The other way is to create a configuration file eg `smi.conf` with the `path` option.
+The other approach is to create a configuration file with the `path` option. For example, you could create a file called `smi.conf`.
 
 [source,sh]
 -----
 path :/path/to/mibs/
 -----
 
-and use that config with smidump:
+Use the config with smidump:
 
 [source,sh]
 -----
 $ smidump -c smi.conf -k -f python CISCO-PROCESS-MIB.mib > CISCO-PROCESS-MIB_my.dic
 -----
 
-
 [id="plugins-{type}s-{plugin}-options"]
 ==== SNMP Input Configuration Options
 

data/lib/logstash/inputs/snmp/mib.rb

@@ -157,11 +157,23 @@ module LogStash
         sub('MIB =', 'mib =')
 
       mib = nil
-      eval(mib_hash)
+      silence_warnings do
+        eval(mib_hash)
+      end
       mib
     rescue Exception => e
       # rescuing Exception class is important here to rescue SyntaxError from eval
       raise(SnmpMibError, "error parsing mib dic file: #{filename}, error: #{e.message}")
     end
+
+    # MIB definition files may have duplicate entries that, since Ruby 2.7, generate warnings when they are converted to a hash.
+    # This method will suppress these warnings, unless `debug` logging is enabled.
+    def silence_warnings
+      warn_level = $VERBOSE
+      $VERBOSE = logger.debug? ? warn_level : nil
+      yield
+    ensure
+      $VERBOSE = warn_level
+    end
   end
 end

data/logstash-input-snmp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-input-snmp'
-  s.version       = '1.3.2'
+  s.version       = '1.3.3'
   s.licenses      = ['Apache-2.0']
   s.summary       = "SNMP input plugin"
   s.description   = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-snmp
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement