sensu-plugins-rabbitmq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3938fc8f1c33be6ee3f1ced513960928dc62e09
+  data.tar.gz: 17e8e359a42996896ff54693c34d6c8ccc21498e
+SHA512:
+  metadata.gz: dc59629127f1d646280538bca55bd3cbf6a0299eaab77fbd4153bfbcbd9b3751a04bc27a930a0a13e6b0c536c93e6e3682e09967ee3ff8c55433bf8b75af869d
+  data.tar.gz: d793e6f461d8dc98380d47e1e748e2feadea26df87386e456759ac19215b21cc2b733953a3bc53638de393166e9bbdbd51a64f3dfa397bdd8e6e0262e744c315

data.tar.gz.sig

@@ -0,0 +1 @@
+X��W8��)~,�&F99%�1P:� �������i[%�^��o�;>%J��nߟm9��}&��sW8H%�t�M~b�Ҩ���N��*I����-�

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+#Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## Unreleased][unreleased]
+
+## 0.0.1 - 2015-05-30
+
+### Added
+- Add the ability to monitor all queues in the consumer count plugin
+- Add ability to exclude specific queues in the consumer count plugin
+- Added Ruby 2.2.0 to Travis
+- Added additional node health checks to the check-rabbitmq-node-health.rb plugin
+- Added development tasks to the Rakefile
+- Added a Gemfile
+- Added egress rate to the metrics-rabbitmq-queue.rb plugin
+- Added encoding comment to each plugin
+- Added check-rabbitmq-queue-drain-time.rb plugin
+- Added queue drain time and the number of consumers to the metrics-rabbitmq-queue.rb plugin
+- Added check-rabbitmq-network-partitions plugin
+- Added the ability to monitor message count per queue and exclude specific queues in check-rabbitmq-messages.rb
+
+### Fixed
+- Fixed the critical and warning values to alert when <= not < in check-rabbitmq-consumers.rb
+
+### Changed
+- Updated Rubocop to 0.30 and resolved all warnings
+- Updated the headers to match and use the new template for additional information
+- Updated class names to match plugin names for better alert messaging
+- Made all plugins executable
+
+### Removed
+- Remove copy paste errors in the Readme
+- Removed Rubygems require Ruby 1.8.7 backwards compatibility from all plugins

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+## Sensu-Plugins-rabbitmq
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-rabbitmq.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-rabbitmq)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-rabbitmq.svg)](http://badge.fury.io/rb/sensu-plugins-rabbitmq)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-rabbitmq/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-rabbitmq)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-rabbitmq/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-rabbitmq)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-rabbitmq.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-rabbitmq)
+[![Codeship Status for sensu-plugins/sensu-plugins-rabbitmq](https://codeship.com/projects/524c57f0-e89b-0132-b373-0e94167ad564/status?branch=master)](https://codeship.com/projects/82842)
+
+## Functionality
+
+## Files
+ * bin/check-rabbitmq-alive.rb
+ * bin/check-rabbitmq-amqp-alive.rb
+ * bin/check-rabbitmq-cluster-health.rb
+ * bin/check-rabbitmq-consumers.rb
+ * bin/check-rabbitmq-messages.rb
+ * bin/check-rabbitmq-network-partitions.rb
+ * bin/check-rabbitmq-node-health.rb
+ * bin/check-rabbitmq-queue-drain-time.rb
+ * bin/check-rabbitmq-queue.rb
+ * bin/check-rabbitmq-stomp-alive.rb
+ * bin/metrics-rabbitmq-overview.rb
+ * bin/metrics-rabbitmq-queue.rb
+
+## Usage
+
+## Installation
+
+[Installation and Setup](https://github.com/sensu-plugins/documentation/blob/master/user_docs/installation_instructions.md)
+
+## Notes

data/bin/check-rabbitmq-alive.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# RabbitMQ check alive plugin
+# ===
+#
+# DESCRIPTION:
+# This plugin checks if RabbitMQ server is alive using the REST API
+#
+# PLATFORMS:
+#   Linux, Windows, BSD, Solaris
+#
+# DEPENDENCIES:
+#   RabbitMQ rabbitmq_management plugin
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# LICENSE:
+# Copyright 2012 Abhijith G <abhi@runa.com> and Runa Inc.
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'json'
+require 'rest_client'
+
+# main plugin class
+class CheckRabbitMQAlive < Sensu::Plugin::Check::CLI
+  option :host,
+         description: 'RabbitMQ host',
+         short: '-w',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :vhost,
+         description: 'RabbitMQ vhost',
+         short: '-v',
+         long: '--vhost VHOST',
+         default: '%2F'
+
+  option :username,
+         description: 'RabbitMQ username',
+         short: '-u',
+         long: '--username USERNAME',
+         default: 'guest'
+
+  option :password,
+         description: 'RabbitMQ password',
+         short: '-p',
+         long: '--password PASSWORD',
+         default: 'guest'
+
+  option :port,
+         description: 'RabbitMQ API port',
+         short: '-P',
+         long: '--port PORT',
+         default: '15672'
+
+  option :ssl,
+         description: 'Enable SSL for connection to RabbitMQ',
+         long: '--ssl',
+         boolean: true,
+         default: false
+
+  def run
+    res = vhost_alive?
+
+    if res['status'] == 'ok'
+      ok res['message']
+    elsif res['status'] == 'critical'
+      critical res['message']
+    else
+      unknown res['message']
+    end
+  end
+
+  def vhost_alive?
+    host     = config[:host]
+    port     = config[:port]
+    username = config[:username]
+    password = config[:password]
+    vhost    = config[:vhost]
+    ssl      = config[:ssl]
+
+    begin
+      resource = RestClient::Resource.new "http#{ssl ? 's' : ''}://#{host}:#{port}/api/aliveness-test/#{vhost}", username, password
+      # Attempt to parse response (just to trigger parse exception)
+      _response = JSON.parse(resource.get) == { 'status' => 'ok' }
+      { 'status' => 'ok', 'message' => 'RabbitMQ server is alive' }
+    rescue Errno::ECONNREFUSED => e
+      { 'status' => 'critical', 'message' => e.message }
+    rescue => e
+      { 'status' => 'unknown', 'message' => e.message }
+    end
+  end
+end

data/bin/check-rabbitmq-amqp-alive.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# RabbitMQ check amqp alive plugin
+# ===
+#
+# DESCRIPTION:
+# This plugin checks if RabbitMQ server is alive using the REST API
+#
+# PLATFORMS:
+#   Linux, BSD, Solaris
+#
+# DEPENDENCIES:
+#   RabbitMQ rabbitmq_management plugin
+#   gem: sensu-plugin
+#   gem: bunny
+#
+# LICENSE:
+# Copyright 2013 Milos Gajdos
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'bunny'
+
+# main plugin class
+class CheckRabbitAMQPAlive < Sensu::Plugin::Check::CLI
+  option :host,
+         description: 'RabbitMQ host',
+         short: '-w',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :vhost,
+         description: 'RabbitMQ vhost',
+         short: '-v',
+         long: '--vhost VHOST',
+         default: '%2F'
+
+  option :username,
+         description: 'RabbitMQ username',
+         short: '-u',
+         long: '--username USERNAME',
+         default: 'guest'
+
+  option :password,
+         description: 'RabbitMQ password',
+         short: '-p',
+         long: '--password PASSWORD',
+         default: 'guest'
+
+  option :port,
+         description: 'RabbitMQ AMQP port',
+         short: '-P',
+         long: '--port PORT',
+         default: '5672'
+
+  option :ssl,
+         description: 'Enable SSL for connection to RabbitMQ',
+         long: '--ssl',
+         boolean: true,
+         default: false
+
+  def run
+    res = vhost_alive?
+
+    if res['status'] == 'ok'
+      ok res['message']
+    elsif res['status'] == 'critical'
+      critical res['message']
+    else
+      unknown res['message']
+    end
+  end
+
+  def vhost_alive?
+    host     = config[:host]
+    port     = config[:port]
+    username = config[:username]
+    password = config[:password]
+    vhost    = config[:vhost]
+    ssl      = config[:ssl]
+
+    begin
+      conn = Bunny.new("amqp#{ssl ? 's' : ''}://#{username}:#{password}@#{host}:#{port}/#{vhost}")
+      conn.start
+      { 'status' => 'ok', 'message' => 'RabbitMQ server is alive' }
+    rescue Bunny::PossibleAuthenticationFailureError
+      { 'status' => 'critical', 'message' => 'Possible authentication failure' }
+    rescue Bunny::TCPConnectionFailed
+      { 'status' => 'critical', 'message' => 'TCP connection refused' }
+    rescue => e
+      { 'status' => 'unknown', 'message' => e.message }
+    end
+  end
+end

data/bin/check-rabbitmq-cluster-health.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# RabbitMQ check cluster nodes health plugin
+# ===
+#
+# DESCRIPTION:
+# This plugin checks if RabbitMQ server's cluster nodes are in a running state.
+# It also accepts and optional list of nodes and verifies that those nodes are
+# present in the cluster.
+# The plugin is based on the RabbitMQ alive plugin by Abhijith G.
+#
+# PLATFORMS:
+#   Linux, Windows, BSD, Solaris
+#
+# DEPENDENCIES:
+#   RabbitMQ rabbitmq_management plugin
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# LICENSE:
+# Copyright 2012 Abhijith G <abhi@runa.com> and Runa Inc.
+# Copyright 2014 Tim Smith <tim@cozy.co> and Cozy Services Ltd.
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'json'
+require 'rest_client'
+
+# main plugin class
+class CheckRabbitMQCluster < Sensu::Plugin::Check::CLI
+  option :host,
+         description: 'RabbitMQ host',
+         short: '-w',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :username,
+         description: 'RabbitMQ username',
+         short: '-u',
+         long: '--username USERNAME',
+         default: 'guest'
+
+  option :password,
+         description: 'RabbitMQ password',
+         short: '-p',
+         long: '--password PASSWORD',
+         default: 'guest'
+
+  option :port,
+         description: 'RabbitMQ API port',
+         short: '-P',
+         long: '--port PORT',
+         default: '15672'
+
+  option :nodes,
+         description: 'Optional comma separated list of expected nodes in the cluster',
+         short: '-n',
+         long: '--nodes NODE1,NODE2',
+         default: ''
+
+  def run
+    res = cluster_healthy?
+
+    if res['status'] == 'ok'
+      ok res['message']
+    elsif res['status'] == 'critical'
+      critical res['message']
+    else
+      unknown res['message']
+    end
+  end
+
+  def missing_nodes?(nodes, servers_status)
+    missing = []
+    if nodes.empty?
+      missing
+    else
+      nodes.reject { |x| servers_status.keys.include?(x) }
+    end
+  end
+
+  def failed_nodes?(servers_status)
+    failed_nodes = []
+    servers_status.each { |sv, stat| failed_nodes << sv unless stat == true }
+    failed_nodes
+  end
+
+  def cluster_healthy?
+    host     = config[:host]
+    port     = config[:port]
+    username = config[:username]
+    password = config[:password]
+    nodes   =  config[:nodes].split(',')
+
+    begin
+      resource = RestClient::Resource.new "http://#{host}:#{port}/api/nodes", username, password
+      # create a hash of the server names and their running state
+      servers_status = Hash[JSON.parse(resource.get).map { |server| [server['name'], server['running']] }]
+
+      # true or false for health of the nodes
+      missing_nodes = missing_nodes?(nodes, servers_status)
+
+      # array of nodes that are not running
+      failed_nodes = failed_nodes?(servers_status)
+
+      # build status and message
+      status = failed_nodes.empty? && missing_nodes.empty? ? 'ok' : 'critical'
+      if failed_nodes.empty?
+        message = "#{servers_status.keys.count} healthy cluster nodes"
+      else
+        message = "#{failed_nodes.count} failed cluster node: #{failed_nodes.sort.join(',')}"
+      end
+      message.prepend("#{missing_nodes.count } node(s) not found: #{missing_nodes.join(',')}. ") unless missing_nodes.empty?
+      { 'status' => status, 'message' => message }
+    rescue Errno::ECONNREFUSED => e
+      { 'status' => 'critical', 'message' => e.message }
+    rescue => e
+      { 'status' => 'unknown', 'message' => e.message }
+    end
+  end
+end

data/bin/check-rabbitmq-consumers.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# Check RabbitMQ consumers
+# ===
+#
+# DESCRIPTION:
+# This plugin checks the number of consumers on the RabbitMQ server
+#
+# 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>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'carrot-top'
+
+# main plugin class
+class CheckRabbitMQConsumers < 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 :ssl,
+         description: 'Enable SSL for connection to the API',
+         long: '--ssl',
+         boolean: true,
+         default: false
+
+  option :user,
+         description: 'RabbitMQ management API user',
+         long: '--user USER',
+         default: 'guest'
+
+  option :password,
+         description: 'RabbitMQ management API password',
+         long: '--password PASSWORD',
+         default: 'guest'
+
+  option :queue,
+         description: 'Comma separated list of RabbitMQ queues to monitor.',
+         long: '--queue queue_name',
+         proc: proc { |q| q.split(',') }
+
+  option :exclude,
+         description: 'Comma separated list of RabbitMQ queues to NOT monitor.  All others will be monitored.',
+         long: '--exclude queue_name',
+         proc: proc { |q| q.split(',') }
+
+  option :warn,
+         short: '-w NUM_CONSUMERS',
+         long: '--warn NUM_CONSUMERS',
+         proc: proc(&:to_i),
+         description: 'WARNING consumer count threshold',
+         default: 5
+
+  option :critical,
+         short: '-c NUM_CONSUMERS',
+         long: '--critical NUM_CONSUMERS',
+         description: 'CRITICAL consumer count threshold',
+         proc: proc(&:to_i),
+         default: 2
+
+  def rabbit
+    begin
+      connection = CarrotTop.new(
+        host: config[:host],
+        port: config[:port],
+        user: config[:user],
+        password: config[:password],
+        ssl: config[:ssl]
+      )
+    rescue
+      warning 'could not connect to rabbitmq'
+    end
+    connection
+  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)
+    elsif warning.count > 0
+      warning("Queues in warning state: #{warning.join(', ')}")
+    else
+      ok
+    end
+  end
+
+  def run
+    # create arrays to hold failures
+    missing = config[:queue] || []
+    critical = []
+    warn = []
+
+    rabbit.queues.each do |queue|
+      # if specific queues were passed only monitor those.
+      # if specific queues to exclude were passed then skip those
+      if config[:queue]
+        next unless config[:queue].include?(queue['name'])
+      elsif config[:exclude]
+        next if config[:exclude].include?(queue['name'])
+      end
+      missing.delete(queue['name'])
+      consumers = queue['consumers']
+      critical.push(queue['name']) if consumers <= config[:critical]
+      warn.push(queue['name']) if consumers <= config[:warn]
+    end
+
+    return_condition(missing, critical, warn)
+  end
+end