sensu-plugins-rabbitmq 0.0.1

data/bin/check-rabbitmq-queue.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# Check RabbitMQ Queue Messages
+# ===
+#
+# DESCRIPTION:
+# This plugin checks the number of messages queued on the RabbitMQ server in a specific queues
+#
+# PLATFORMS:
+#   Linux, BSD, Solaris
+#
+# DEPENDENCIES:
+#   RabbitMQ rabbitmq_management plugin
+#   gem: sensu-plugin
+#   gem: carrot-top
+#
+# LICENSE:
+# Copyright 2012 Evan Hazlett <ejhazlett@gmail.com>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'socket'
+require 'carrot-top'
+
+# 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 :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: 'RabbitMQ queue to monitor',
+         long: '--queue queue_names',
+         required: true,
+         proc: proc { |a| a.split(',') }
+
+  option :warn,
+         short: '-w NUM_MESSAGES',
+         long: '--warn NUM_MESSAGES',
+         description: 'WARNING message count threshold',
+         default: 250
+
+  option :critical,
+         short: '-c NUM_MESSAGES',
+         long: '--critical NUM_MESSAGES',
+         description: 'CRITICAL message count threshold',
+         default: 500
+
+  def acquire_rabbitmq_info
+    begin
+      rabbitmq_info = CarrotTop.new(
+        host: config[:host],
+        port: config[:port],
+        user: config[:user],
+        password: config[:password],
+        ssl: config[:ssl]
+      )
+    rescue
+      warning 'could not get rabbitmq info'
+    end
+    rabbitmq_info
+  end
+
+  def run
+    @crit = []
+    @warn = []
+    rabbitmq = acquire_rabbitmq_info
+    queues = rabbitmq.queues
+    config[:queue].each do |q|
+      unless queues.map  { |hash| hash['name'] }.include? q
+        @warn << "Queue #{ q } not available"
+        next
+      end
+      queues.each do |queue|
+        next unless queue['name'] == q
+        total = queue['messages']
+        total = 0 if total.nil?
+        message "#{total}"
+        @crit << "#{ q }:#{ total }" if total > config[:critical].to_i
+        @warn << "#{ q }:#{ total }" if total > config[:warn].to_i
+      end
+    end
+    if @crit.empty? && @warn.empty?
+      ok
+    elsif !(@crit.empty?)
+      critical "critical: #{ @crit } warning: #{ @warn }"
+    elsif !(@warn.empty?)
+      warning "critical: #{ @crit } warning: #{ @warn }"
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# RabbitMQ check alive plugin
+# ===
+#
+# DESCRIPTION:
+# This plugin checks if RabbitMQ server is alive and responding to STOMP
+# requests.
+#
+# Based on rabbitmq-amqp-alive by Milos Gajdos
+#
+# PLATFORMS:
+#   Linux, BSD, Solaris
+#
+# DEPENDENCIES:
+#   RabbitMQ rabbitmq_management plugin
+#   gem: sensu-plugin
+#   gem: stomp
+#
+# LICENSE:
+# Copyright 2014 Adam Ashley
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'stomp'
+
+# main plugin class
+class CheckRabbitStomp < 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 STOMP port',
+         short: '-P',
+         long: '--port PORT',
+         default: '61613'
+
+  option :ssl,
+         description: 'Enable SSL for connection to RabbitMQ',
+         long: '--ssl',
+         boolean: true,
+         default: false
+
+  option :queue,
+         description: 'Queue to post a message to and receive from',
+         short: '-q',
+         long: '--queue QUEUE',
+         default: 'aliveness-test'
+
+  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?
+    hash = {
+      hosts: [
+        {
+          login: config[:username],
+          passcode: config[:password],
+          host: config[:host],
+          port: config[:port],
+          ssl: config[:ssl]
+        }
+      ],
+      reliable: false, # disable failover
+      connect_timeout: 10
+    }
+
+    begin
+      conn = Stomp::Client.new(hash)
+      conn.publish("/queue/#{config[:queue]}", 'STOMP Alive Test')
+      conn.subscribe("/queue/#{config[:queue]}") do |_msg|
+      end
+      { 'status' => 'ok', 'message' => 'RabbitMQ server is alive' }
+     rescue Errno::ECONNREFUSED
+       { 'status' => 'critical', 'message' => 'TCP connection refused' }
+     rescue Stomp::Error::BrokerException => e
+       { 'status' => 'critical', 'message' => "Error from broker. Check auth details? #{e.message}" }
+    rescue => e
+      { 'status' => 'unknown', 'message' => "#{e.class}: #{e.message}" }
+    end
+  end
+end

data/bin/metrics-rabbitmq-overview.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# RabbitMQ Overview Metrics
+# ===
+#
+# DESCRIPTION:
+# RabbitMQ 'overview' stats are similar to what is shown on the main page
+# of the rabbitmq_management web UI. Example:
+#
+#   $ rabbitmq-queue-metrics.rb
+#    host.rabbitmq.queue_totals.messages.count 0 1344186404
+#    host.rabbitmq.queue_totals.messages.rate  0.0 1344186404
+#    host.rabbitmq.queue_totals.messages_unacknowledged.count  0 1344186404
+#    host.rabbitmq.queue_totals.messages_unacknowledged.rate 0.0 1344186404
+#    host.rabbitmq.queue_totals.messages_ready.count 0 1344186404
+#    host.rabbitmq.queue_totals.messages_ready.rate  0.0 1344186404
+#    host.rabbitmq.message_stats.publish.count 4605755 1344186404
+#    host.rabbitmq.message_stats.publish.rate  17.4130186829638  1344186404
+#    host.rabbitmq.message_stats.deliver_no_ack.count  6661111 1344186404
+#    host.rabbitmq.message_stats.deliver_no_ack.rate 24.6867565643405  1344186404
+#    host.rabbitmq.message_stats.deliver_get.count 6661111 1344186404
+#    host.rabbitmq.message_stats.deliver_get.rate  24.6867565643405  1344186404#
+#
+# PLATFORMS:
+#   Linux, BSD, Solaris
+#
+# DEPENDENCIES:
+#   RabbitMQ rabbitmq_management plugin
+#   gem: sensu-plugin
+#   gem: carrot-top
+#
+# LICENSE:
+# Copyright 2012 Joe Miller - https://github.com/joemiller
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+require 'carrot-top'
+
+# 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 :user,
+         description: 'RabbitMQ management API user',
+         long: '--user 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"
+
+  option :ssl,
+         description: 'Enable SSL for connection to the API',
+         long: '--ssl',
+         boolean: true,
+         default: false
+
+  def acquire_rabbitmq_info
+    begin
+      rabbitmq_info = CarrotTop.new(
+        host: config[:host],
+        port: config[:port],
+        user: config[:user],
+        password: config[:password],
+        ssl: config[:ssl]
+      )
+    rescue
+      warning 'could not get rabbitmq info'
+    end
+    rabbitmq_info
+  end
+
+  def run #rubocop:disable all
+    timestamp = Time.now.to_i
+
+    rabbitmq = acquire_rabbitmq_info
+    overview = rabbitmq.overview
+
+    # overview['queue_totals']['messages']
+    if overview.key?('queue_totals') && !overview['queue_totals'].empty?
+      output "#{config[:scheme]}.queue_totals.messages.count", overview['queue_totals']['messages'], timestamp
+      output "#{config[:scheme]}.queue_totals.messages.rate", overview['queue_totals']['messages_details']['rate'], timestamp
+
+      # overview['queue_totals']['messages_unacknowledged']
+      output "#{config[:scheme]}.queue_totals.messages_unacknowledged.count", overview['queue_totals']['messages_unacknowledged'], timestamp
+      output "#{config[:scheme]}.queue_totals.messages_unacknowledged.rate", overview['queue_totals']['messages_unacknowledged_details']['rate'], timestamp
+
+      # overview['queue_totals']['messages_ready']
+      output "#{config[:scheme]}.queue_totals.messages_ready.count", overview['queue_totals']['messages_ready'], timestamp
+      output "#{config[:scheme]}.queue_totals.messages_ready.rate", overview['queue_totals']['messages_ready_details']['rate'], timestamp
+    end
+
+    if overview.key?('message_stats') && !overview['message_stats'].empty?
+      # overview['message_stats']['publish']
+      if overview['message_stats'].include?('publish')
+        output "#{config[:scheme]}.message_stats.publish.count", overview['message_stats']['publish'], timestamp
+      end
+      if overview['message_stats'].include?('publish_details') &&
+         overview['message_stats']['publish_details'].include?('rate')
+        output "#{config[:scheme]}.message_stats.publish.rate", overview['message_stats']['publish_details']['rate'], timestamp
+      end
+
+      # overview['message_stats']['deliver_no_ack']
+      if overview['message_stats'].include?('deliver_no_ack')
+        output "#{config[:scheme]}.message_stats.deliver_no_ack.count", overview['message_stats']['deliver_no_ack'], timestamp
+      end
+      if overview['message_stats'].include?('deliver_no_ack_details') &&
+         overview['message_stats']['deliver_no_ack_details'].include?('rate')
+        output "#{config[:scheme]}.message_stats.deliver_no_ack.rate", overview['message_stats']['deliver_no_ack_details']['rate'], timestamp
+      end
+
+      # overview['message_stats']['deliver_get']
+      if overview['message_stats'].include?('deliver_get')
+        output "#{config[:scheme]}.message_stats.deliver_get.count", overview['message_stats']['deliver_get'], timestamp
+      end
+      if overview['message_stats'].include?('deliver_get_details') &&
+         overview['message_stats']['deliver_get_details'].include?('rate')
+        output "#{config[:scheme]}.message_stats.deliver_get.rate", overview['message_stats']['deliver_get_details']['rate'], timestamp
+      end
+    end
+    ok
+  end
+end

data/bin/metrics-rabbitmq-queue.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# RabbitMQ Queue Metrics
+# ===
+#
+# DESCRIPTION:
+# This plugin checks gathers 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
+#
+# PLATFORMS:
+#   Linux, BSD, Solaris
+#
+# DEPENDENCIES:
+#   RabbitMQ rabbitmq_management plugin
+#   gem: sensu-plugin
+#   gem: carrot-top
+#
+# LICENSE:
+# Copyright 2011 Sonian, Inc <chefs@sonian.net>
+# Copyright 2015 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/metric/cli'
+require 'socket'
+require 'carrot-top'
+
+# 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 :user,
+         description: 'RabbitMQ management API user',
+         long: '--user 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"
+
+  option :filter,
+         description: 'Regular expression for filtering queues',
+         long: '--filter REGEX'
+
+  option :ssl,
+         description: 'Enable SSL for connection to the API',
+         long: '--ssl',
+         boolean: true,
+         default: false
+
+  def acquire_rabbitmq_queues
+    begin
+      rabbitmq_info = CarrotTop.new(
+        host: config[:host],
+        port: config[:port],
+        user: config[:user],
+        password: config[:password],
+        ssl: config[:ssl]
+      )
+    rescue
+      warning 'could not get rabbitmq queue info'
+    end
+    rabbitmq_info.queues
+  end
+
+  def run
+    timestamp = Time.now.to_i
+    acquire_rabbitmq_queues.each do |queue|
+      if config[:filter]
+        next unless queue['name'].match(config[:filter])
+      end
+
+      # calculate and output time till the queue is drained in drain metrics
+      drain_time = queue['messages'] / queue['backing_queue_status']['avg_egress_rate']
+      drain_time = 0 if drain_time.nan? # 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)
+      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