sensu-plugins-rabbitmq 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4136a3c48a94763e3ab822775e4d21a832b10887
-  data.tar.gz: eab91431b9a3e361e955f23ed3c383d7832344fb
+  metadata.gz: 8c4af6295e3502323bc33b8a0c7e8468fa0bc049
+  data.tar.gz: 7cf40311405259b11315d2266fc1d28b35faa0ef
 SHA512:
-  metadata.gz: e8b04c93a18c80b25bf0ea1f1025d7f1d0ca24facd5802a71f758afa1d1dbfe00b8a8a471fbcb6115c1e4a261c052c77566dd3f09343064abf3c682ee3b32756
-  data.tar.gz: da132f2cc3c15f1f22dc1280d9192f6f800aa50f612c503de942d60321e0d7375996092b2d00ac2429c62fd0a514323586b7a7908b1db1a7bcdc188bae693359
+  metadata.gz: 6b8628a015ddb462ef3c0ad1e2136c7e260dc9a0c9ee4a8c02d9fcff94a5546ad6a70c1a87a0d98d2d574812f3d37b8debcbcf6fc6b703ce8c5446fe1e0ac0c1
+  data.tar.gz: 8267f2febc301f37f6d0adb030484da3f70f59c5d85e9ecf1ef07a244c5aaed9ccc7076f7ffafd871af0d09651c1e3688325b034226fa68083ab16cb31786209

data/CHANGELOG.md

@@ -4,6 +4,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
+## [3.1.0] - 2017-05-16
+### Added
+ - metrics-rabbitmq-queue.rb: --metrics option to specifiy which metrics to gather (@rthouvenin)
+
 ## [3.0.0] - 2017-05-10
 ### Breaking change
  - Previously some checks used --user to specify username, now all scripts use --username
@@ -129,7 +133,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.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/3.1.0...HEAD
+[3.1.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/3.0.0...3.1.0
 [3.0.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/2.3.0...3.0.0
 [2.3.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/2.2.0...2.3.0
 [2.2.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/2.1.0...2.2.0

data/bin/metrics-rabbitmq-queue.rb

@@ -5,11 +5,12 @@
 # ===
 #
 # DESCRIPTION:
-# This plugin checks gathers the following per queue rabbitmq metrics:
+# This plugin checks gathers by default the following per queue rabbitmq metrics:
 #   - message count
 #   - average egress rate
 #   - "drain time" metric, which is the time a queue will take to reach 0 based on the egress rate
 #   - consumer count
+# The list of gathered metrics can also be specified with an option
 #
 # PLATFORMS:
 #   Linux, BSD, Solaris
@@ -22,6 +23,7 @@
 # LICENSE:
 # Copyright 2011 Sonian, Inc <chefs@sonian.net>
 # Copyright 2015 Tim Smith <tim@cozy.co> and Cozy Services Ltd.
+# Copyright 2017 Romain Thouvenin <romain@thouvenin.pro>
 #
 # Released under the same terms as Sensu (the MIT license); see LICENSE
 # for details.
@@ -68,6 +70,11 @@ class RabbitMQMetrics < Sensu::Plugin::Metric::CLI::Graphite
          description: 'Regular expression for filtering queues',
          long: '--filter REGEX'
 
+  option :metrics,
+         description: 'Regular expression for filtering metrics in each queue',
+         long: '--metrics REGEX',
+         default: '^messages$|consumers|drain_time|avg_egress'
+
   option :ssl,
          description: 'Enable SSL for connection to the API',
          long: '--ssl',
@@ -109,6 +116,17 @@ class RabbitMQMetrics < Sensu::Plugin::Metric::CLI::Graphite
     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|
@@ -120,16 +138,21 @@ class RabbitMQMetrics < Sensu::Plugin::Metric::CLI::Graphite
       queue['messages'] ||= 0
       drain_time = queue['messages'] / queue['backing_queue_status']['avg_egress_rate']
       drain_time = 0 if drain_time.nan? || drain_time.infinite? # 0 rate with 0 messages is 0 time to drain
-      output([config[:scheme], queue['name'], 'drain_time'].join('.'), drain_time.to_i, timestamp)
-
-      %w(messages consumers).each do |metric|
-        output([config[:scheme], queue['name'], metric].join('.'), queue[metric], timestamp)
+      queue['drain_time'] = drain_time.to_i
+
+      metrics = dotted_keys(queue)
+      metrics.each do |metric|
+        next unless metric.match(config[:metrics])
+        value = queue.dig(*metric.split('.'))
+        # Special case of ingress and egress rates for backward-compatibility
+        if metric =~ 'backing_queue_status.avg'
+          value = format('%.4f', value)
+          metric = metric.split('.')[-1]
+        end
+        output("#{config[:scheme]}.#{queue['name']}.#{metric}", value, timestamp) unless value.nil?
       end
-
-      # fetch the average egress rate of the queue
-      rate = format('%.4f', queue['backing_queue_status']['avg_egress_rate'])
-      output([config[:scheme], queue['name'], 'avg_egress_rate'].join('.'), rate, timestamp)
     end
+
     ok
   end
 end

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

@@ -1,7 +1,7 @@
 module SensuPluginsRabbitMQ
   module Version
     MAJOR = 3
-    MINOR = 0
+    MINOR = 1
     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.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin