sensu-plugins-rabbitmq 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dd465aac9095a55b092e291e9db39204a4788c5
-  data.tar.gz: cd8aca106692da139aa6558ab507998c750281b8
+  metadata.gz: 1c69134806cf9022b7ae98acf067df1af22ff36d
+  data.tar.gz: 99201bec94d8734fb4eeaf26e708d7d99c465036
 SHA512:
-  metadata.gz: 35d2c570af65f9457741f7f054c72f6ae1078482fa4df62d0bf77a8152224f1fd68067a8440344cb25f9001bf767fd4531c8ddf826de8aedce43a8f2c3290cff
-  data.tar.gz: 24b37a3e73e585a6873e35abe56d52aba4b194f1e53dd528163424fd18c5e8e8b84cf83879d7060ee3398e9f91fe758d6039f900ff627a28a951dd2ade690719
+  metadata.gz: 0ac52d4769ba910b1f3c491fc41af7645b8257ecedb438c647a4b2889c011764cbe283ced41f0b86645e633191d5dad6ce35c1e5279de8731d8abed4fd6a8bb6
+  data.tar.gz: c5c23a7709b88182e8e4100685cc607cf45e1575e03db7fe1c22347fb05d071db81eb64720a463355644246c08f3eccaa3f145707243b7a9523c7ffe67f72712

data/CHANGELOG.md

@@ -5,7 +5,12 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
-## [2017-08-20] - 2017-08-20
+## [3.5.0] - 2017-09-05
+### Changed
+- RabbitMQ module with common code (@rthouvenin)
+- Check and Metrics base classes (@rthouvenin)
+
+## [3.4.0] - 2017-08-20
 ### Added
 - check-rabbitmq-amqp-alive.rb: Added threading and heartbeat interval options (@bdeo)
 
@@ -14,10 +19,12 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 - check-rabbitmq-consumers.rb: Added ability to select queues with regular expressions. (@jtduby)
 
 ### Added
-- ruby 2.4 support (@majormoses)
+ - ruby 2.4 support (@majormoses)
 
+### Changed
+ - metrics-rabbitmq-queue, metrics-rabbitmq-exchange, check-rabbitmq-queue: use the new base classes (@rthouvenin)
 ### Fixed
-- PR template spelling (@majormoses)
+ - PR template spelling (@majormoses)
 
 ## [3.2.0] - 2017-06-20
 ### Added
@@ -156,7 +163,8 @@ NOTE: this release changes the option flags in check-rabbitmq-node-health.rb to
 - Remove copy paste errors in the Readme
 - Removed Rubygems require Ruby 1.8.7 backwards compatibility from all plugins
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/3.3.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/3.5.0...HEAD
+[3.5.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/3.4.0...3.5.0
 [3.4.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/3.3.0...3.4.0
 [3.3.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/3.2.0...3.3.0
 [3.2.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/3.1.1...3.2.0

data/bin/check-rabbitmq-queue.rb

@@ -21,46 +21,10 @@
 # Released under the same terms as Sensu (the MIT license); see LICENSE
 # for details.
 
-require 'sensu-plugin/check/cli'
-require 'socket'
-require 'carrot-top'
-require 'inifile'
+require 'sensu-plugins-rabbitmq'
 
 # main plugin class
-class CheckRabbitMQMessages < Sensu::Plugin::Check::CLI
-  option :host,
-         description: 'RabbitMQ management API host',
-         long: '--host HOST',
-         default: 'localhost'
-
-  option :port,
-         description: 'RabbitMQ management API port',
-         long: '--port PORT',
-         proc: proc(&:to_i),
-         default: 15_672
-
-  option :vhost,
-         description: 'RabbitMQ vhost',
-         short: '-v',
-         long: '--vhost VHOST',
-         default: ''
-
-  option :ssl,
-         description: 'Enable SSL for connection to the API',
-         long: '--ssl',
-         boolean: true,
-         default: false
-
-  option :username,
-         description: 'RabbitMQ management API user',
-         long: '--username USER',
-         default: 'guest'
-
-  option :password,
-         description: 'RabbitMQ management API password',
-         long: '--password PASSWORD',
-         default: 'guest'
-
+class CheckRabbitMQMessages < Sensu::Plugin::RabbitMQ::Check
   option :queue,
          description: 'RabbitMQ queue to monitor',
          long: '--queue queue_names',
@@ -103,36 +67,6 @@ class CheckRabbitMQMessages < Sensu::Plugin::Check::CLI
          boolean: true,
          default: false
 
-  option :ini,
-         description: 'Configuration ini file',
-         short: '-i',
-         long: '--ini VALUE'
-
-  def acquire_rabbitmq_info
-    begin
-      if config[:ini]
-        ini = IniFile.load(config[:ini])
-        section = ini['auth']
-        username = section['username']
-        password = section['password']
-      else
-        username = config[:username]
-        password = config[:password]
-      end
-
-      rabbitmq_info = CarrotTop.new(
-        host: config[:host],
-        port: config[:port],
-        user: username,
-        password: password,
-        ssl: config[:ssl]
-      )
-    rescue
-      warning 'could not get rabbitmq info'
-    end
-    rabbitmq_info
-  end
-
   def run
     @crit = []
     @warn = []

data/bin/metrics-rabbitmq-exchange.rb

@@ -24,44 +24,10 @@
 # Released under the same terms as Sensu (the MIT license); see LICENSE
 # for details.
 
-require 'sensu-plugin/metric/cli'
-require 'socket'
-require 'carrot-top'
-require 'inifile'
+require 'sensu-plugins-rabbitmq'
 
 # main plugin class
-class RabbitMQExchangeMetrics < Sensu::Plugin::Metric::CLI::Graphite
-  option :host,
-         description: 'RabbitMQ management API host',
-         long: '--host HOST',
-         default: 'localhost'
-
-  option :port,
-         description: 'RabbitMQ management API port',
-         long: '--port PORT',
-         proc: proc(&:to_i),
-         default: 15_672
-
-  option :vhost,
-         description: 'Regular expression for filtering the RabbitMQ vhost',
-         short: '-v',
-         long: '--vhost VHOST'
-
-  option :username,
-         description: 'RabbitMQ management API user',
-         long: '--username USER',
-         default: 'guest'
-
-  option :password,
-         description: 'RabbitMQ management API password',
-         long: '--password PASSWORD',
-         default: 'guest'
-
-  option :scheme,
-         description: 'Metric naming scheme, text to prepend to $exchange_name.$metric',
-         long: '--scheme SCHEME',
-         default: "#{Socket.gethostname}.rabbitmq"
-
+class RabbitMQExchangeMetrics < Sensu::Plugin::RabbitMQ::Metrics
   option :filter,
          description: 'Regular expression for filtering exchanges',
          long: '--filter REGEX'
@@ -70,61 +36,9 @@ class RabbitMQExchangeMetrics < Sensu::Plugin::Metric::CLI::Graphite
          description: 'Regular expression for filtering metrics in each exchange',
          long: '--metrics REGEX'
 
-  option :ssl,
-         description: 'Enable SSL for connection to the API',
-         long: '--ssl',
-         boolean: true,
-         default: false
-
-  option :ini,
-         description: 'Configuration ini file',
-         short: '-i',
-         long: '--ini VALUE'
-
-  def acquire_rabbitmq_exchanges
-    begin
-      if config[:ini]
-        ini = IniFile.load(config[:ini])
-        section = ini['auth']
-        username = section['username']
-        password = section['password']
-      else
-        username = config[:username]
-        password = config[:password]
-      end
-
-      rabbitmq_info = CarrotTop.new(
-        host: config[:host],
-        port: config[:port],
-        user: username,
-        password: password,
-        ssl: config[:ssl]
-      )
-    rescue
-      warning 'could not get rabbitmq exchange info'
-    end
-
-    if config[:vhost]
-      return rabbitmq_info.exchanges.select { |x| x['vhost'].match(config[:vhost]) }
-    end
-
-    rabbitmq_info.exchanges
-  end
-
-  def dotted_keys(hash, prefix = '', keys = [])
-    hash.each do |k, v|
-      if v.is_a? Hash
-        keys = dotted_keys(v, prefix + k + '.', keys)
-      else
-        keys << prefix + k
-      end
-    end
-    keys
-  end
-
   def run
     timestamp = Time.now.to_i
-    acquire_rabbitmq_exchanges.each do |exchange|
+    acquire_rabbitmq_info(:exchanges).each do |exchange|
       if config[:filter]
         next unless exchange['name'].match(config[:filter])
       end

data/bin/metrics-rabbitmq-queue.rb

@@ -28,44 +28,10 @@
 # Released under the same terms as Sensu (the MIT license); see LICENSE
 # for details.
 
-require 'sensu-plugin/metric/cli'
-require 'socket'
-require 'carrot-top'
-require 'inifile'
+require 'sensu-plugins-rabbitmq'
 
 # main plugin class
-class RabbitMQMetrics < Sensu::Plugin::Metric::CLI::Graphite
-  option :host,
-         description: 'RabbitMQ management API host',
-         long: '--host HOST',
-         default: 'localhost'
-
-  option :port,
-         description: 'RabbitMQ management API port',
-         long: '--port PORT',
-         proc: proc(&:to_i),
-         default: 15_672
-
-  option :vhost,
-         description: 'Regular expression for filtering the RabbitMQ vhost',
-         short: '-v',
-         long: '--vhost VHOST'
-
-  option :username,
-         description: 'RabbitMQ management API user',
-         long: '--username USER',
-         default: 'guest'
-
-  option :password,
-         description: 'RabbitMQ management API password',
-         long: '--password PASSWORD',
-         default: 'guest'
-
-  option :scheme,
-         description: 'Metric naming scheme, text to prepend to $queue_name.$metric',
-         long: '--scheme SCHEME',
-         default: "#{Socket.gethostname}.rabbitmq"
-
+class RabbitMQQueueMetrics < Sensu::Plugin::RabbitMQ::Metrics
   option :filter,
          description: 'Regular expression for filtering queues',
          long: '--filter REGEX'
@@ -75,61 +41,9 @@ class RabbitMQMetrics < Sensu::Plugin::Metric::CLI::Graphite
          long: '--metrics REGEX',
          default: '^messages$|consumers|drain_time|avg_egress'
 
-  option :ssl,
-         description: 'Enable SSL for connection to the API',
-         long: '--ssl',
-         boolean: true,
-         default: false
-
-  option :ini,
-         description: 'Configuration ini file',
-         short: '-i',
-         long: '--ini VALUE'
-
-  def acquire_rabbitmq_queues
-    begin
-      if config[:ini]
-        ini = IniFile.load(config[:ini])
-        section = ini['auth']
-        username = section['username']
-        password = section['password']
-      else
-        username = config[:username]
-        password = config[:password]
-      end
-
-      rabbitmq_info = CarrotTop.new(
-        host: config[:host],
-        port: config[:port],
-        user: username,
-        password: password,
-        ssl: config[:ssl]
-      )
-    rescue
-      warning 'could not get rabbitmq queue info'
-    end
-
-    if config[:vhost]
-      return rabbitmq_info.queues.select { |x| x['vhost'].match(config[:vhost]) }
-    end
-
-    rabbitmq_info.queues
-  end
-
-  def dotted_keys(hash, prefix = '', keys = [])
-    hash.each do |k, v|
-      if v.is_a? Hash
-        keys = dotted_keys(v, prefix + k + '.', keys)
-      else
-        keys << prefix + k
-      end
-    end
-    keys
-  end
-
   def run
     timestamp = Time.now.to_i
-    acquire_rabbitmq_queues.each do |queue|
+    acquire_rabbitmq_info(:queues).each do |queue|
       if config[:filter]
         next unless queue['name'].match(config[:filter])
       end

data/lib/sensu-plugins-rabbitmq.rb

@@ -1 +1,5 @@
+require 'ruby_dig'
+
 require 'sensu-plugins-rabbitmq/version'
+require 'sensu-plugins-rabbitmq/check'
+require 'sensu-plugins-rabbitmq/metrics'

data/lib/sensu-plugins-rabbitmq/check.rb

@@ -0,0 +1,17 @@
+require 'sensu-plugin/check/cli'
+require 'sensu-plugins-rabbitmq/rabbitmq'
+
+module Sensu
+  module Plugin
+    module RabbitMQ
+      class Check < Sensu::Plugin::Check::CLI
+        include Sensu::Plugin::RabbitMQ::Common
+
+        # To avoid complaints from mother class at the end of tests (at_exit handler)
+        def run
+          ok
+        end
+      end
+    end
+  end
+end

data/lib/sensu-plugins-rabbitmq/metrics.rb

@@ -0,0 +1,34 @@
+require 'sensu-plugin/metric/cli'
+require 'socket'
+require 'sensu-plugins-rabbitmq/rabbitmq'
+
+module Sensu
+  module Plugin
+    module RabbitMQ
+      class Metrics < Sensu::Plugin::Metric::CLI::Graphite
+        include Sensu::Plugin::RabbitMQ::Common
+
+        option :scheme,
+               description: 'Metric naming scheme',
+               long: '--scheme SCHEME',
+               default: "#{Socket.gethostname}.rabbitmq"
+
+        def dotted_keys(hash, prefix = '', keys = [])
+          hash.each do |k, v|
+            if v.is_a? Hash
+              keys = dotted_keys(v, prefix + k + '.', keys)
+            else
+              keys << prefix + k
+            end
+          end
+          keys
+        end
+
+        # To avoid complaints from mother class at the end of tests (at_exit handler)
+        def run
+          ok
+        end
+      end
+    end
+  end
+end

data/lib/sensu-plugins-rabbitmq/rabbitmq.rb

@@ -0,0 +1,91 @@
+require 'carrot-top'
+require 'inifile'
+
+module Sensu
+  module Plugin
+    module RabbitMQ
+      module Options
+        def add_common_options
+          option :host,
+                 description: 'RabbitMQ management API host',
+                 long: '--host HOST',
+                 default: 'localhost'
+
+          option :port,
+                 description: 'RabbitMQ management API port',
+                 long: '--port PORT',
+                 proc: proc(&:to_i),
+                 default: 15_672
+
+          option :vhost,
+                 description: 'Regular expression for filtering the RabbitMQ vhost',
+                 short: '-v',
+                 long: '--vhost VHOST',
+                 default: ''
+
+          option :username,
+                 description: 'RabbitMQ management API user',
+                 long: '--username USER',
+                 default: 'guest'
+
+          option :password,
+                 description: 'RabbitMQ management API password',
+                 long: '--password PASSWORD',
+                 default: 'guest'
+
+          option :ssl,
+                 description: 'Enable SSL for connection to the API',
+                 long: '--ssl',
+                 boolean: true,
+                 default: false
+
+          option :ini,
+                 description: 'Configuration ini file',
+                 short: '-i',
+                 long: '--ini VALUE'
+        end
+      end
+
+      module Common
+        def acquire_rabbitmq_info(property = nil)
+          begin
+            if config[:ini]
+              ini = IniFile.load(config[:ini])
+              section = ini['auth']
+              username = section['username']
+              password = section['password']
+            else
+              username = config[:username]
+              password = config[:password]
+            end
+
+            rabbitmq_info = CarrotTop.new(
+              host: config[:host],
+              port: config[:port],
+              user: username,
+              password: password,
+              ssl: config[:ssl]
+            )
+          rescue
+            warning 'could not get rabbitmq info'
+          end
+
+          result_info = rabbitmq_info
+          unless property.nil?
+            result_info = rabbitmq_info.send property
+            if config[:vhost] != ''
+              result_info.select! { |x| x['vhost'].match(config[:vhost]) }
+            end
+          end
+
+          result_info
+        end
+
+        def self.included(receiver)
+          receiver.extend(Sensu::Plugin::RabbitMQ::Options)
+          receiver.add_common_options
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module SensuPluginsRabbitMQ
   module Version
     MAJOR = 3
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-rabbitmq
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-20 00:00:00.000000000 Z
+date: 2017-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -108,6 +108,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: ruby_dig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +290,9 @@ files:
 - bin/metrics-rabbitmq-overview.rb
 - bin/metrics-rabbitmq-queue.rb
 - lib/sensu-plugins-rabbitmq.rb
+- lib/sensu-plugins-rabbitmq/check.rb
+- lib/sensu-plugins-rabbitmq/metrics.rb
+- lib/sensu-plugins-rabbitmq/rabbitmq.rb
 - lib/sensu-plugins-rabbitmq/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-rabbitmq
 licenses:
@@ -303,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for rabbitmq