sensu-plugins-snmp 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8ce8fe5fa3c177f034f7dbd7d1a559712ca7b3944763600978d055ec5bac398
-  data.tar.gz: 15dbda47ba10aadbe0dc719cfd68127d16eb5bad4b0d17d64cb930182733153c
+  metadata.gz: 05b214e0573291717c537da2fee0326ad7d69ad88cd40340359e9777d0651538
+  data.tar.gz: 3eabe810681bb3700ee27a2fe029c055ff48251cc2d4a174a4b9d329bfd01914
 SHA512:
-  metadata.gz: 33e589a736c28423cc8ab83dd5027c85dcab51b69eaf0f21d19077ac5190a5152927dde44bd38f48deff98bbb38d1444609537960163798d2e797c4494c3a170
-  data.tar.gz: 5343e84097be502c70d718de07b74638862f8baf4d4b7d4cfb93e4e2b2a382b1c234553db4a7f6b3e57ffabf5ac6f1c38ed824a0a08625d35549655a513977d4
+  metadata.gz: 166d15056e31140d3ed2dd69aa400d274345dc31385d32593e02189c0a73f09dd6a3da12736b4453f12f00e5d132ba84fa88094ece547b0a4eaa89ed7e7405c7
+  data.tar.gz: fce00bc0a180ff3b3bbeef872b2f07e10062d94336506ac9b2903d1459a38237fbc3de8931527123974d26b75d6c8d3089501080c2f102d835cb475e8962cf2c

data/CHANGELOG.md

@@ -6,6 +6,22 @@ Which is based on [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+
+## [3.0.0] - 2019-03-20
+### Added
+- Travis build automation to generate Sensu Asset tarballs that can be used n conjunction with Sensu provided ruby runtime assets and the Bonsai Asset Index
+- Require latest sensu-plugin for Sensu Go support
+
+### Breaking change
+- Updates minimum required ruby version to 2.3. Drop unsupported ruby versions.
+- Update dependancy on sensu-plugin to 4.0
+- Update runtime dep snmp requirement from = 1.2.0 to = 1.3.2
+
+### Changed
+- Update development dep bundler requirement from ~> 1.7 to ~> 2.1
+- Update development dep rubocop requirement from ~> 0.4 to ~> 0.8
+- Update development dep yard requirement to ~> 0.9.11
+
 ## [2.1.0] - 2018-06-25
 ### Added
 - metrics-snmp-if.rb: added `--timeout|-t` option which controls the request timeout (@rocdove)
@@ -74,7 +90,8 @@ Which is based on [Keep A Changelog](http://keepachangelog.com/)
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-snmp/compare/2.1.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-snmp/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/sensu-plugins/sensu-plugins-snmp/compare/2.1.0...3.0.0
 [2.1.0]: https://github.com/sensu-plugins/sensu-plugins-snmp/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-snmp/compare/1.1.0...2.0.0
 [1.1.0]: https://github.com/sensu-plugins/sensu-plugins-snmp/compare/1.0.0...1.1.0

data/README.md

@@ -1,24 +1,118 @@
-## Sensu-Plugins-snmp
-
+[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-snmp)
 [![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-snmp.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-snmp)
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-snmp.svg)](http://badge.fury.io/rb/sensu-plugins-snmp)
 [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-snmp/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-snmp)
 [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-snmp/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-snmp)
 [![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-snmp.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-snmp)
 
-## Functionality
+## Sensu SNMP Plugin
+
+- [Overview](#overview)
+- [Usage examples](#usage-examples)
+- [Configuration](#configuration)
+  - [Sensu Go](#sensu-go)
+    - [Asset definition](#asset-definition)
+    - [Check definition](#check-definition)
+  - [Sensu Core](#sensu-core)
+    - [Check definition](#check-definition)
+- [Installation](#installation)
+
+### Overview
+
+This plugin provides native SNMP instrumentation for monitoring and metrics collection, including: generic OID single/bulk query for status and metrics, and ifTable metrics.
 
-## Files
+The Sensu assets packaged from this repository are built against the Sensu ruby runtime environment. When using these assets as part of a Sensu Go resource (check, mutator or handler), make sure you include the corresponding Sensu ruby runtime asset in the list of assets needed by the resource.  The current ruby-runtime assets can be found [here](https://bonsai.sensu.io/assets/sensu/sensu-ruby-runtime) in the [Bonsai Asset Index](bonsai.sensu.io)
+
+#### Files
  * bin/check-snmp.rb
  * bin/check-snmp-disk.rb
  * bin/metrics-snmp-bulk.rb
  * bin/metrics-snmp-if.rb
  * bin/metrics-snmp.rb
 
-## Usage
+## Usage examples
+
+**metrics-snmp.rb**
+```
+Usage: metrics-snmp.rb (options)
+    -C snmp community
+    -g                               Replace dots with underscores in hostname
+    -h host
+    -d mibdir                        Full path to custom MIB directory.
+    -l mib[,mib,mib...]              Custom MIBs to load (from custom mib path).
+    -O OID
+    -P, --port PORT
+    -p prefix                        prefix to attach to graphite path
+    -v version                       SNMP version to use (SNMPv1, SNMPv2c (default))
+    -s suffix                        suffix to attach to graphite path (required)
+```
+
+### Configuration
+#### Sensu Go
+##### Asset registration
+
+Assets are the best way to make use of this handler. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 or later, you can use the following command to add the asset: 
+
+`sensuctl asset add sensu-plugins/sensu-plugins-snmp`
+
+If you're using an earlier version of sensuctl, you can download the asset definition from [this project's Bonsai Asset Index page](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-snmp).
+
+##### Asset definition
+
+```yaml
+---
+type: Asset
+api_version: core/v2
+metadata:
+  name: sensu-plugins-snmp
+spec:
+  url: https://assets.bonsai.sensu.io/cd39e88ca50bf16793796429a94673df208ddb26/sensu-plugins-snmp_3.0.0-pre_centos_linux_amd64.tar.gz
+  sha512: 7edd57dab82bfd97662d3f2d6ddfb70c41bbcba591b1c2c4077d0107c667fbd2c64ad2bcef51e0192e18176ade60fde403c4784ac141ba1a932cc65c8c897169
+  filters:
+  - entity.system.os == 'linux'
+  - entity.system.arch == 'amd64'
+  - entity.system.platform_family == 'rhel'
+```
+
+##### Check definition
+
+```yaml
+---
+type: CheckConfig
+spec:
+  command: "metrics-snmp.rb -h 10.0.0.1 -O 1.2.3.4.5"
+  interval: 10
+  publish: true
+  runtime_assets:
+  - sensu-plugins-snmp
+  - sensu-ruby-runtime
+  subscriptions:
+  - snmp-pollers
+  output_metric_format: graphite_plaintext
+  output_metric_handlers:
+  - influx-db
+```
+#### Sensu Core
+##### Check definition
+```json
+{
+  "checks": {
+    "check-snmp": {
+    "command": "metrics-snmp.rb -h 10.0.0.1 -O 1.2.3.4.5",
+    "subscribers": [
+      "snmp-pollers"
+    ],
+    "interval": 60
+    }
+  }
+}
+```
 
 ## Installation
 
-[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+### Sensu Go
+
+See the instructions above for [asset registration](#asset-registration)
 
-## Notes
+### Sensu Core
+Install and setup plugins on [Sensu Core](https://docs.sensu.io/sensu-core/latest/installation/installing-plugins/)

data/bin/check-snmp-disk.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 #   check-snmp-disk
 #
@@ -108,7 +110,8 @@ class CheckSNMP < Sensu::Plugin::Check::CLI
       response = manager.get_bulk(0, 200, [dev_desc_oid])
       dev_indexes = []
       response.each_varbind do |var|
-        next if config[:ignoremnt] && config[:ignoremnt].include?(var.value.to_s.split(',')[0])
+        next if config[:ignoremnt]&.include?(var.value.to_s.split(',')[0])
+
         if var.value.to_s =~ /#{config[:mount_point]}/
           dev_indexes.push(var.name[-1])
         end
@@ -116,7 +119,7 @@ class CheckSNMP < Sensu::Plugin::Check::CLI
       dev_indexes.each do |dev_index|
         response = manager.get(["#{dev_desc_oid}.#{dev_index}", "#{dev_size_oid}.#{dev_index}", "#{dev_used_oid}.#{dev_index}"])
         dev_desc, dev_size, dev_used = response.varbind_list
-        perc = dev_used.value.to_f / dev_size.value.to_f * 100
+        perc = dev_used.value / dev_size.value.to_f * 100
         if perc > config[:critical]
           @crit_mnt << "#{dev_desc.value} = #{perc.round(2)}%"
         elsif perc > config[:warning]
@@ -125,7 +128,7 @@ class CheckSNMP < Sensu::Plugin::Check::CLI
       end
     rescue SNMP::RequestTimeout
       unknown "#{config[:host]} not responding"
-    rescue => e
+    rescue StandardError => e
       unknown "An unknown error occured: #{e.inspect}"
     end
     critical usage_summary unless @crit_mnt.empty?

data/bin/check-snmp.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 # Check SNMP
 # ===
 #
@@ -97,7 +99,7 @@ class CheckSNMP < Sensu::Plugin::Check::CLI
       end
     rescue SNMP::RequestTimeout
       unknown "#{config[:host]} not responding"
-    rescue => e
+    rescue StandardError => e
       unknown "An unknown error occured: #{e.inspect}"
     end
     operators = { 'le' => :<=, 'ge' => :>= }
@@ -119,7 +121,7 @@ class CheckSNMP < Sensu::Plugin::Check::CLI
 
         critical 'Critical state detected' if snmp_value.to_s.to_i.send(symbol, config[:critical].to_s.to_i)
         # #YELLOW
-        warning 'Warning state detected' if snmp_value.to_s.to_i.send(symbol, config[:warning].to_s.to_i) && !snmp_value.to_s.to_i.send(symbol, config[:critical].to_s.to_i) # rubocop:disable LineLength
+        warning 'Warning state detected' if snmp_value.to_s.to_i.send(symbol, config[:warning].to_s.to_i) && !snmp_value.to_s.to_i.send(symbol, config[:critical].to_s.to_i) # rubocop:disable Layout/LineLength
         unless snmp_value.to_s.to_i.send(symbol, config[:warning].to_s.to_i)
           ok 'All is well!'
         end

data/bin/metrics-snmp-bulk.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 # SNMP Bulk Metrics
 # ===
 #
@@ -103,7 +105,7 @@ class SNMPGraphite < Sensu::Plugin::Metric::CLI::Graphite
                                   oids)
     rescue SNMP::RequestTimeout
       unknown "#{config[:host]} not responding"
-    rescue => e
+    rescue StandardError => e
       unknown "An unknown error occured: #{e.inspect}"
     end
     config[:host] = config[:host].tr('.', '_') if config[:graphite]
@@ -116,7 +118,7 @@ class SNMPGraphite < Sensu::Plugin::Metric::CLI::Graphite
         metric_string += ".#{config[:suffix]}" if config[:suffix]
         metric_string += ".#{name}"
         output metric_string, vb.value.to_f
-      rescue NameError # rubocop:disable Lint/HandleExceptions
+      rescue NameError # rubocop:disable Lint/SuppressedException
         # Rescue as some values may fail to cast to float
       end
     end

data/bin/metrics-snmp-if.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 # SNMP Interface Metrics
 # ===
 #
@@ -36,7 +38,7 @@
 # Released under the same terms as Sensu (the MIT license); see LICENSE
 # for details.
 
-# rubocop:disable VariableName
+# rubocop:disable Naming/VariableName
 require 'sensu-plugin/metric/cli'
 require 'snmp'
 
@@ -130,22 +132,22 @@ class SNMPIfStatsGraphite < Sensu::Plugin::Metric::CLI::Graphite
          description: 'Request timeout'
 
   def run # rubocop:disable Metrics/AbcSize
-    if_table_HC_columns = %w(
+    if_table_HC_columns = %w[
       ifHCInOctets ifHCOutOctets
       ifHCInUcastPkts ifHCOutUcastPkts
       ifHCInMulticastPkts ifHCOutMulticastPkts
       ifHCInBroadcastPkts ifHCOutBroadcastPkts
-    )
-    if_table_LC_columns = %w(
+    ]
+    if_table_LC_columns = %w[
       ifInOctets ifOutOctets
       ifInUcastPkts ifOutUcastPkts
       ifInMulticastPkts ifOutMulticastPkts
       ifInBroadcastPkts ifOutBroadcastPkts
-    )
-    if_table_common_columns = %w(
+    ]
+    if_table_common_columns = %w[
       ifIndex ifOperStatus ifName ifDescr
       ifInErrors ifOutErrors ifInDiscards ifOutDiscards ifSpeed
-    )
+    ]
     if_table_columns = if_table_common_columns +
                        (config[:low_capacity] ? if_table_LC_columns : if_table_HC_columns)
 
@@ -197,3 +199,4 @@ class SNMPIfStatsGraphite < Sensu::Plugin::Metric::CLI::Graphite
     ok
   end
 end
+# rubocop:enable Naming/VariableName

data/bin/metrics-snmp.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 # SNMP Metrics
 # ===
 #
@@ -83,7 +85,7 @@ class SNMPGraphite < Sensu::Plugin::Metric::CLI::Graphite
       response = manager.get([config[:objectid].to_s])
     rescue SNMP::RequestTimeout
       unknown "#{config[:host]} not responding"
-    rescue => e
+    rescue StandardEerror => e
       unknown "An unknown error occured: #{e.inspect}"
     end
     config[:host] = config[:host].tr('.', '_') if config[:graphite]

data/lib/sensu-plugins-snmp.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'sensu-plugins-snmp/version'

data/lib/sensu-plugins-snmp/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SensuPluginsSnmp
   module Version
-    MAJOR = 2
-    MINOR = 1
+    MAJOR = 3
+    MINOR = 0
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-snmp
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2020-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -16,154 +16,154 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: snmp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: github-markup
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.80'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.80'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.9.11
 description: |-
   This plugin provides native SNMP instrumentation
                                 for monitoring and metrics collection, including:
@@ -171,11 +171,11 @@ description: |-
                                 metrics, and ifTable metrics.
 email: "<sensu-users@googlegroups.com>"
 executables:
-- check-snmp-disk.rb
-- check-snmp.rb
 - metrics-snmp-bulk.rb
-- metrics-snmp-if.rb
+- check-snmp.rb
 - metrics-snmp.rb
+- check-snmp-disk.rb
+- metrics-snmp-if.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -207,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="