sensu-plugins-rabbitmq 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c311e72869b18722dcc6d4314f87ffb6e802558a1bbf2ea5d8bc177e3fdef55
-  data.tar.gz: d3298c7f161eaea4ec281f6256cd00ed0545c5a85f946e784b919cd1b3e62712
+  metadata.gz: 82e03ad3782930ed8f79782b6e87218024e8e111a1a4e230b117b0eac38f7bac
+  data.tar.gz: 7f4d9a9c9abb26b6f9ca9a9f28cbf12bbeae7f11e783ae1a5c63647bcf1948d8
 SHA512:
-  metadata.gz: 34901f8870f16e8b9a994886e82bba7cc27e4136589b7eab2b245597c69e51faf06149d259b3ce824086a893d8ce6e9197fa831f36d5d0b513855c8396f8ccb6
-  data.tar.gz: c0bfb8b5466e96444c8b48893490ccb668a60a5e562a43c263e313c86160c65393e8cf604475136d937bf7164e1643e34ddadbb555364687c05afde3bdcbd8ef
+  metadata.gz: 5e47ea6fd59814ab95780c0d6290a9f9695124bc96d3dc8a06c3586ed8abe977223aed16839805d939d49f4c83fc7347a5dbcbc944a56ad80c3f35fa38f3840a
+  data.tar.gz: fdcdd2d46d097b84874a3bba58d2272a1ba7bc4f9d4feacf23e726dfba75dc458199a93dc967bcc0d798eaeed3bbd7e69e6d640a0786e80e0dd979a5e4a841bf

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [5.1.0] - 2018-05-15
+### Added
+- check-rabbitmq-consumer-utilisation.rb: Added new check for consumer utilisation. Seeded from check-rabbitmq-consumers.rb. (@monkey670)
+
 ## [5.0.0] - 2018-05-02
 ### Breaking Changes
 - bump sensu-plugin version in dependencies to ~> 2.0.  This should fix the issue where multiple versions of json (1.8.6 and 2.0.2) are being loaded, causing checks to fail (@mattdoller)
@@ -196,7 +200,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/5.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/5.1.0...HEAD
+[5.1.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/5.0.0...5.1.0
 [5.0.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/4.1.1...5.0.0
 [4.1.1]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/4.1.0...4.1.1
 [4.1.0]: https://github.com/sensu-plugins/sensu-plugins-rabbitmq/compare/4.0.1...4.1.0

data/README.md

@@ -13,6 +13,7 @@
  * bin/check-rabbitmq-amqp-alive.rb
  * bin/check-rabbitmq-cluster-health.rb
  * bin/check-rabbitmq-consumers.rb
+ * bin/check-rabbitmq-consumer-utilisation.rb
  * bin/check-rabbitmq-messages.rb
  * bin/check-rabbitmq-network-partitions.rb
  * bin/check-rabbitmq-node-health.rb

data/bin/check-rabbitmq-consumer-utilisation.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Check RabbitMQ consumer utilisation
+# ===
+#
+# DESCRIPTION:
+# This plugin checks the consumer utilisation percentage.
+# The fraction of time in which the queue is able to immediately deliver
+# messages to consumer. If this number drops in percentage this may result
+# in slower message delivery and indicate issues with the queue.
+#
+# Seeded from check-rabbitmq-consumers.rb
+#
+# PLATFORMS:
+#   Linux, BSD, Solaris
+#
+# DEPENDENCIES:
+#   RabbitMQ rabbitmq_management plugin
+#   gem: sensu-plugin
+#   gem: carrot-top
+#
+# LICENSE:
+# Copyright 2014 Daniel Kerwin <d.kerwin@gini.net>
+# Copyright 2014 Tim Smith <tim@cozy.co>
+# Copyright 2018 Mike Murray <37150283+monkey670@users.noreply.github.com>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugins-rabbitmq'
+require 'sensu-plugins-rabbitmq/check'
+
+# main plugin class
+class CheckRabbitMQConsumerUtilisation < Sensu::Plugin::RabbitMQ::Check
+  option :regex,
+         description: 'Treat the --queue flag as a regular expression.',
+         long: '--regex',
+         boolean: true,
+         default: false
+
+  option :queue,
+         description: 'Comma separated list of RabbitMQ queues to monitor.',
+         long: '--queue queue_name'
+
+  option :exclude,
+         description: 'Comma separated list of RabbitMQ queues to NOT monitor.  All others will be monitored.',
+         long: '--exclude queue_name'
+
+  option :warn,
+         short: '-w CONSUMER_UTILISATION',
+         long: '--warn CONSUMER_UTILISATION',
+         proc: proc(&:to_f),
+         description: 'WARNING consumer utilisation threshold',
+         default: 0.9
+
+  option :critical,
+         short: '-c CONSUMER_UTILISATION',
+         long: '--critical CONSUMER_UTILISATION',
+         description: 'CRITICAL consumer utilisation threshold',
+         proc: proc(&:to_f),
+         default: 0.5
+
+  def queue_list_builder(input)
+    return [] if input.nil?
+    return [input] if config[:regex]
+    input.split(',')
+  end
+
+  def return_condition(missing, critical, warning)
+    if critical.count > 0 || missing.count > 0
+      message = []
+      message << "Queues in critical state: #{critical.join(', ')}. " if critical.count > 0
+      message << "Queues missing: #{missing.join(', ')}" if missing.count > 0
+      critical(message.join("\n"))
+    elsif warning.count > 0
+      warning("Queues in warning state: #{warning.join(', ')}")
+    else
+      ok
+    end
+  end
+
+  def run
+    # create arrays to hold failures
+    queue_list = queue_list_builder(config[:queue])
+    exclude_list = queue_list_builder(config[:exclude])
+    missing = if config[:regex]
+                []
+              else
+                queue_list || []
+              end
+    critical = []
+    warn = []
+    rabbitmq = acquire_rabbitmq_info
+    begin
+      rabbitmq.queues.each do |queue|
+        # if specific queues were passed only monitor those.
+        # if specific queues to exclude were passed then skip those
+        if config[:regex]
+          if config[:queue] && config[:exclude]
+            next unless queue['name'] =~ /#{queue_list.first}/ && queue['name'] !~ /#{exclude_list.first}/
+          else
+            next unless queue['name'] =~ /#{queue_list.first}/
+          end
+        elsif config[:queue]
+          next unless queue_list.include?(queue['name'])
+        elsif config[:exclude]
+          next if exclude_list.include?(queue['name'])
+        end
+        missing.delete(queue['name'])
+        consumer_util = queue['consumer_utilisation'] || 0
+        critical.push("#{queue['name']}:#{consumer_util.round(2) * 100}%") if consumer_util <= config[:critical]
+        warn.push("#{queue['name']}:#{consumer_util.round(2) * 100}%") if consumer_util <= config[:warn]
+      end
+    rescue StandardError
+      critical 'Could not find any queue, check rabbitmq server'
+    end
+    return_condition(missing, critical, warn)
+  end
+end

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

@@ -3,7 +3,7 @@
 module SensuPluginsRabbitMQ
   module Version
     MAJOR = 5
-    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: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -258,6 +258,7 @@ executables:
 - check-rabbitmq-alive.rb
 - check-rabbitmq-amqp-alive.rb
 - check-rabbitmq-cluster-health.rb
+- check-rabbitmq-consumer-utilisation.rb
 - check-rabbitmq-consumers.rb
 - check-rabbitmq-messages.rb
 - check-rabbitmq-network-partitions.rb
@@ -279,6 +280,7 @@ files:
 - bin/check-rabbitmq-alive.rb
 - bin/check-rabbitmq-amqp-alive.rb
 - bin/check-rabbitmq-cluster-health.rb
+- bin/check-rabbitmq-consumer-utilisation.rb
 - bin/check-rabbitmq-consumers.rb
 - bin/check-rabbitmq-messages.rb
 - bin/check-rabbitmq-network-partitions.rb