sensu-plugins-mongodb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59832576dcbd865bd1cd58e4961a53e04c1995f3
-  data.tar.gz: 50be87abcbff02c6cfe176a420e005566d26e278
+  metadata.gz: fb4941553a69ae6bcca4130d5b4b0f70f275fbcc
+  data.tar.gz: 78c8ea6169c2d1276add39c49fd61bcf524f1c3f
 SHA512:
-  metadata.gz: f8abce4c1c05ee006437ba030c2a97d0742bc6d96507177712c970f3c7323ca9f992ef744d2b893b9926c9b63436acd0898d5d20c2c2eae2b4adaed598ec9188
-  data.tar.gz: 9f6c99372e062e43b21fa2f78f7cd221a5b44284150b5afb68a87c085627c24f3ecd0c409c4f36051b1b383ef485f6af33773634e4ae173cba85f0e1d6f2f225
+  metadata.gz: 831b34ee26b5e760745c3239a9e2ddcf2ff5141f0c95aecc4e6d1b797da08b05ad6b0631a69295433f4c6c3194df84e8f4ef503b22b2f078150350793737d02f
+  data.tar.gz: d6ca2cdba45c44e292f39cff53cb1bdb8de6bb063acf76ed7b5a6b80f0b04f85a95e0764327d0dd4e0553330363584d8001b5c766e3c61415616e91d35f804a4

data/CHANGELOG.md

@@ -5,6 +5,22 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [1.1.0] - 2016-10-17
+### Added
+- Inclusion of check-mongodb-metrics.rb to perform checks against the same data metrics-mongodb.rb produces. (@stefano-pogliani)
+- Inclusion of lib/sensu-plugins-mongodb/metics.rb to share metric collection logic. (@stefano-pogliani)
+- Tests to the metrics processing shared code.  (@stefano-pogliani)
+- Support for SSL certificates for clients. (@b0d0nne11)
+- Inclusion of metrics-mongodb-replication.rb to produce replication metrics including lag statistics (@stefano-pogliani)
+- Updated metrics-mongodb.rb to include version checks to ensure execution in mongodb > 3.2.x (@RycroftSolutions)
+- Additional metrics not included in original metrics-mongodb.rb (@RycroftSolutions)
+
+### Changed
+- Moved most of metrics-mongodb.rb code to shared library. (@stefano-pogliani)
+- MongoDB version checks to skip missing metrics. (@stefano-pogliani)
+- Renamed some metrics to become standard with MongoDB 3.2 equivalent
+  (so checks/queries don't have to bother with version detection). (@stefano-pogliani)
+
 ## [1.0.0] - 2016-06-03
 ### Removed
 - support for Rubies 1.9.3 and 2.0
@@ -14,7 +30,7 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ### Changed
 - Update to rubocop 0.40 and cleanup
-- Update to mongo gem 2.2.x and boson 4.x for MongoDB 3.2 support
+- Update to mongo gem 2.2.x and bson 4.x for MongoDB 3.2 support
 
 ### Fixed
 - Long was added as a numeric type
@@ -64,7 +80,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-mongodb/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-mongodb/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-mongodb/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-mongodb/compare/0.0.8...1.0.0
 [0.0.8]: https://github.com/sensu-plugins/sensu-plugins-mongodb/compare/0.0.7...0.0.8
 [0.0.7]: https://github.com/sensu-plugins/sensu-plugins-mongodb/compare/0.0.6...0.0.7

data/README.md

@@ -1,6 +1,6 @@
 ## Sensu-Plugins-mongodb
 
-[ ![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-mongodb.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-mongodb)
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-mongodb.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-mongodb)
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-mongodb.svg)](http://badge.fury.io/rb/sensu-plugins-mongodb)
 [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mongodb/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mongodb)
 [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mongodb/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mongodb)
@@ -11,7 +11,9 @@
 ## Files
  * bin/check-mongodb.py
  * bin/check-mongodb.rb - wrapper for check-mongodb.py
+ * bin/check-mongodb-metric.rb
  * bin/metrics-mongodb.rb
+ * bin/metrics-mongodb-replication.rb
 
 ## Usage
 

data/bin/check-mongodb-metric.rb

@@ -0,0 +1,143 @@
+#! /usr/bin/env ruby
+#
+#   check-mongodb-metric.rb
+#
+# DESCRIPTION:
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: mongo
+#   gem: bson
+#   gem: bson_ext
+#
+# USAGE:
+#   #YELLOW
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2016 Conversocial https://github.com/conversocial
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'sensu-plugins-mongodb/metics'
+require 'mongo'
+include Mongo
+
+#
+# Mongodb
+#
+
+class CheckMongodbMetric < Sensu::Plugin::Check::CLI
+  option :host,
+         description: 'MongoDB host',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :port,
+         description: 'MongoDB port',
+         long: '--port PORT',
+         default: 27_017
+
+  option :user,
+         description: 'MongoDB user',
+         long: '--user USER',
+         default: nil
+
+  option :password,
+         description: 'MongoDB password',
+         long: '--password PASSWORD',
+         default: nil
+
+  option :ssl,
+         description: 'Connect using SSL',
+         long: '--ssl',
+         default: false
+
+  option :ssl_cert,
+         description: 'The certificate file used to identify the local connection against mongod',
+         long: '--ssl-cert SSL_CERT',
+         default: ''
+
+  option :ssl_key,
+         description: 'The private key used to identify the local connection against mongod',
+         long: '--ssl-key SSL_KEY',
+         default: ''
+
+  option :ssl_ca_cert,
+         description: 'The set of concatenated CA certificates, which are used to validate certificates passed from the other end of the connection',
+         long: '--ssl-ca-cert SSL_CA_CERT',
+         default: ''
+
+  option :ssl_verify,
+         description: 'Whether or not to do peer certification validation',
+         long: '--ssl-verify',
+         default: false
+
+  option :debug,
+         description: 'Enable debug',
+         long: '--debug',
+         default: false
+
+  option :require_master,
+         description: 'Require the node to be a master node',
+         long: '--require-master',
+         default: false
+
+  option :metric,
+         description: 'Name of the metric to check',
+         long: '--metric METRIC',
+         short: '-m METRIC'
+
+  option :warn,
+         description: 'Warn if values are above this threshold',
+         short: '-w WARN',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :crit,
+         description: 'Fail if values are above this threshold',
+         short: '-c CRIT',
+         proc: proc(&:to_i),
+         default: 0
+
+  def run
+    Mongo::Logger.logger.level = Logger::FATAL
+    @debug = config[:debug]
+    if @debug
+      Mongo::Logger.logger.level = Logger::DEBUG
+      config_debug = config.clone
+      config_debug[:password] = '***'
+      puts 'Arguments: ' + config_debug.inspect
+    end
+
+    # Get the metrics.
+    collector = SensuPluginsMongoDB::Metrics.new(config)
+    collector.connect_mongo_db('admin')
+    exit(1) if config[:require_master] && !collector.master?
+    metrics = collector.server_metrics
+
+    # Make sure the requested value is available.
+    unless metrics.key?(config[:metric])
+      unknown "Unable to find a value for metric '#{config[:metric]}'"
+    end
+
+    # Check the requested value against the thresholds.
+    value = metrics[config[:metric]]
+    if value >= config[:crit]
+      critical "The value of '#{config[:metric]}' exceeds #{config[:crit]}."
+    end
+    if value >= config[:warn]
+      warning "The value of '#{config[:metric]}' exceeds #{config[:warn]}."
+    end
+    ok "The value of '#{config[:metric]}' is below all threshold."
+  end
+end

data/bin/check-mongodb.py

@@ -153,6 +153,9 @@ def main(argv):
     p.add_option('-d', '--database', action='store', dest='database', default='admin', help='Specify the database to check')
     p.add_option('--all-databases', action='store_true', dest='all_databases', default=False, help='Check all databases (action database_size)')
     p.add_option('-s', '--ssl-enabled', dest='ssl_enabled', default=False, action='callback', callback=optional_arg(True), help='Connect using SSL')
+    p.add_option('-e', '--ssl-certfile', dest='ssl_certfile', default=None, action='store', help='The certificate file used to identify the local connection against mongod')
+    p.add_option('-k', '--ssl-keyfile', dest='ssl_keyfile', default=None, action='store', help='The private key used to identify the local connection against mongod')
+    p.add_option('-a', '--ssl-ca-certs', dest='ssl_ca_certs', default=None, action='store', help='The set of concatenated CA certificates, which are used to validate certificates passed from the other end of the connection')
     p.add_option('-r', '--replicaset', dest='replicaset', default=None, action='callback', callback=optional_arg(True), help='Connect to replicaset')
     p.add_option('-q', '--querytype', action='store', dest='query_type', default='query', help='The query type to check [query|insert|update|delete|getmore|command] from queries_per_second')
     p.add_option('-c', '--collection', action='store', dest='collection', default='admin', help='Specify the collection to check')
@@ -178,6 +181,9 @@ def main(argv):
     max_lag = options.max_lag
     database = options.database
     ssl_enabled = options.ssl_enabled
+    ssl_certfile = options.ssl_certfile
+    ssl_keyfile = options.ssl_keyfile
+    ssl_ca_certs = options.ssl_ca_certs
     replicaset = options.replicaset
 
     if action == 'replica_primary' and replicaset is None:
@@ -189,7 +195,7 @@ def main(argv):
     # moving the login up here and passing in the connection
     #
     start = time.time()
-    err, con = mongo_connect(host, port, ssl_enabled, user, passwd, replicaset)
+    err, con = mongo_connect(host, port, ssl_enabled, ssl_certfile, ssl_keyfile, ssl_ca_certs, user, passwd, replicaset)
     if err != 0:
         return err
 
@@ -267,14 +273,14 @@ def main(argv):
         return check_connect(host, port, warning, critical, perf_data, user, passwd, conn_time)
 
 
-def mongo_connect(host=None, port=None, ssl_enabled=False, user=None, passwd=None, replica=None):
+def mongo_connect(host=None, port=None, ssl_enabled=False, ssl_certfile=None, ssl_keyfile=None, ssl_ca_certs=None, user=None, passwd=None, replica=None):
     try:
         # ssl connection for pymongo > 2.3
         if pymongo.version >= "2.3":
             if replica is None:
-                con = pymongo.MongoClient(host, port, ssl=ssl_enabled)
+                con = pymongo.MongoClient(host, port, ssl=ssl_enabled, ssl_certfile=ssl_certfile, ssl_keyfile=ssl_keyfile, ssl_ca_certs=ssl_ca_certs)
             else:
-                con = pymongo.Connection(host, port, read_preference=pymongo.ReadPreference.SECONDARY, ssl=ssl_enabled, replicaSet=replica, network_timeout=10)
+                con = pymongo.Connection(host, port, read_preference=pymongo.ReadPreference.SECONDARY, ssl=ssl_enabled, ssl_certfile=ssl_certfile, ssl_keyfile=ssl_keyfile, ssl_ca_certs=ssl_ca_certs, replicaSet=replica, network_timeout=10)
         else:
             if replica is None:
                 con = pymongo.Connection(host, port, slave_okay=True, network_timeout=10)

data/bin/metrics-mongodb-replication.rb

@@ -0,0 +1,261 @@
+#! /usr/bin/env ruby
+#
+#   metrics-mongodb-replication.rb
+#
+# DESCRIPTION:
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: mongo
+#   gem: bson
+#   gem: bson_ext
+#
+# USAGE:
+#   #YELLOW
+#
+# NOTES::
+#   Basics from github.com/sensu-plugins/sensu-plugins-mongodb/bin/metrics-mongodb
+#
+#   Replication lag is calculated by obtaining the last optime from primary and
+#   secondary members. The last optime of the secondary is subtracted from the
+#   last optime of the primary to produce the difference in seconds, minutes and hours
+#
+# LICENSE:
+#   Copyright 2016 Rycroft Solutions
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'mongo'
+require 'date'
+include Mongo
+
+#
+# Mongodb
+#
+
+class MongoDB < Sensu::Plugin::Metric::CLI::Graphite
+  option :host,
+         description: 'MongoDB host',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :port,
+         description: 'MongoDB port',
+         long: '--port PORT',
+         default: 27_017
+
+  option :user,
+         description: 'MongoDB user',
+         long: '--user USER',
+         default: nil
+
+  option :password,
+         description: 'MongoDB password',
+         long: '--password PASSWORD',
+         default: nil
+
+  option :ssl,
+         description: 'Connect using SSL',
+         long: '--ssl',
+         default: false
+
+  option :ssl_cert,
+         description: 'The certificate file used to identify the local connection against mongod',
+         long: '--ssl-cert SSL_CERT',
+         default: ''
+
+  option :ssl_key,
+         description: 'The private key used to identify the local connection against mongod',
+         long: '--ssl-key SSL_KEY',
+         default: ''
+
+  option :ssl_ca_cert,
+         description: 'The set of concatenated CA certificates, which are used to validate certificates passed from the other end of the connection',
+         long: '--ssl-ca-cert SSL_CA_CERT',
+         default: ''
+
+  option :ssl_verify,
+         description: 'Whether or not to do peer certification validation',
+         long: '--ssl-verify',
+         default: false
+
+  option :scheme,
+         description: 'Metric naming scheme',
+         long: '--scheme SCHEME',
+         short: '-s SCHEME',
+         default: "#{Socket.gethostname}.mongodb"
+
+  option :password,
+         description: 'MongoDB password',
+         long: '--password PASSWORD',
+         default: nil
+
+  option :debug,
+         description: 'Enable debug',
+         long: '--debug',
+         default: false
+
+  def get_mongo_doc(command)
+    rs = @db.command(command)
+    unless rs.successful?
+      return nil
+    end
+    rs.documents[0]
+  end
+
+  # connects to mongo and sets @db, works with MongoClient < 2.0.0
+  def connect_mongo_db
+    if Gem.loaded_specs['mongo'].version < Gem::Version.new('2.0.0')
+      mongo_client = MongoClient.new(host, port)
+      @db = mongo_client.db(db_name)
+      @db.authenticate(db_user, db_password) unless db_user.nil?
+    else
+      address_str = "#{config[:host]}:#{config[:port]}"
+      client_opts = {}
+      client_opts[:database] = 'admin'
+      unless config[:user].nil?
+        client_opts[:user] = config[:user]
+        client_opts[:password] = config[:password]
+      end
+      if config[:ssl]
+        client_opts[:ssl] = true
+        client_opts[:ssl_cert] = config[:ssl_cert]
+        client_opts[:ssl_key] = config[:ssl_key]
+        client_opts[:ssl_ca_cert] = config[:ssl_ca_cert]
+        client_opts[:ssl_verify] = config[:ssl_verify]
+      end
+      mongo_client = Mongo::Client.new([address_str], client_opts)
+      @db = mongo_client.database
+    end
+  end
+
+  def run
+    Mongo::Logger.logger.level = Logger::FATAL
+    @debug = config[:debug]
+    if @debug
+      Mongo::Logger.logger.level = Logger::DEBUG
+      config_debug = config.clone
+      config_debug[:password] = '***'
+      puts 'arguments:' + config_debug.inspect
+    end
+
+    connect_mongo_db
+
+    _result = false
+    # check if master
+    begin
+      @is_master = get_mongo_doc('isMaster' => 1)
+      unless @is_master.nil?
+        _result = @is_master['ok'] == 1
+      end
+    rescue StandardError => e
+      if @debug
+        puts 'Error checking isMaster:' + e.message
+        puts e.backtrace.inspect
+      end
+      exit(1)
+    end
+
+    replication_status = get_mongo_doc('replSetGetStatus' => 1)
+
+    # get the replication metrics
+    begin
+      metrics = {}
+      if !replication_status.nil? && replication_status['ok'] == 1
+        metrics.update(gather_replication_metrics(replication_status))
+        timestamp = Time.now.to_i
+        metrics.each do |k, v|
+          unless v.nil?
+            output [config[:scheme], 'replication', k].join('.'), v, timestamp
+          end
+        end
+      end
+    rescue StandardError => e
+      if @debug
+        puts 'Error checking replicationStatus:' + e.message
+        puts e.backtrace.inspect
+      end
+      exit(2)
+    end
+
+    # Get the repllication member metrics
+    begin
+      metrics = {}
+      replication_members = replication_status['members']
+      unless replication_members.nil?
+        replication_members.each do |replication_member_details|
+          metrics.update(gather_replication_member_metrics(replication_member_details))
+          member_id = replication_member_details['_id']
+          timestamp = Time.now.to_i
+          metrics.each do |k, v|
+            unless v.nil?
+              output [config[:scheme], "member_#{member_id}", k].join('.'), v, timestamp
+            end
+          end
+        end
+      end
+    rescue StandardError => e
+      if @debug
+        puts 'Error checking replicationMemberStatus:' + e.message
+        puts e.backtrace.inspect
+      end
+      exit(2)
+    end
+
+    # done!
+    ok
+  end
+
+  def gather_replication_metrics(replication_status)
+    replication_metrics = {}
+
+    replication_metrics['replica_set'] = replication_status['set']
+    replication_metrics['date'] = replication_status['date']
+    replication_metrics['myState'] = replication_status['myState']
+    replication_metrics['term'] = replication_status['term']
+    replication_metrics['heartbeatIntervalMillis'] = replication_status['heartbeatIntervalMillis']
+
+    replication_metrics
+  end
+
+  def gather_replication_member_metrics(replication_member_details)
+    replication_member_metrics = {}
+
+    replication_member_metrics['id'] = replication_member_details['_id']
+    replication_member_metrics['name'] = replication_member_details['name']
+    replication_member_metrics['health'] = replication_member_details['health']
+    replication_member_metrics['state'] = replication_member_details['state']
+    replication_member_metrics['stateStr'] = replication_member_details['stateStr']
+    member_hierarchy = replication_member_details['stateStr']
+    if member_hierarchy == 'PRIMARY'
+      @primary_optime_date = replication_member_details['optimeDate']
+      replication_member_metrics['primary.startOptimeDate'] = @primary_optime_date
+    end
+    if member_hierarchy == 'SECONDARY'
+      @secondary_optime_date = replication_member_details['optimeDate']
+      difference_in_seconds = (@primary_optime_date - @secondary_optime_date).to_i
+      difference_in_minutes = ((@primary_optime_date - @secondary_optime_date) / 60).to_i
+      difference_in_hours = ((@primary_optime_date - @secondary_optime_date) / 3600).to_i
+      replication_member_metrics['secondsBehindPrimary'] = difference_in_seconds
+      replication_member_metrics['minutesBehindPrimary'] = difference_in_minutes
+      replication_member_metrics['hoursBehindPrimary'] = difference_in_hours
+    end
+    replication_member_metrics['optimeDate'] = replication_member_details['optimeDate']
+    replication_member_metrics['uptime'] = replication_member_details['uptime']
+    replication_member_metrics['lastHeartbeat'] = replication_member_details['lastHeartbeat']
+    replication_member_metrics['lastHeartbeatRecv'] = replication_member_details['lastHeartbeatiRecv']
+    replication_member_metrics['pingMs'] = replication_member_details['pingMs']
+    replication_member_metrics['syncingTo'] = replication_member_details['syncingTo']
+    replication_member_metrics['configVersion'] = replication_member_details['configVersion']
+
+    replication_member_metrics
+  end
+end

data/bin/metrics-mongodb.rb

@@ -29,6 +29,7 @@
 #
 
 require 'sensu-plugin/metric/cli'
+require 'sensu-plugins-mongodb/metics'
 require 'mongo'
 include Mongo
 
@@ -57,48 +58,46 @@ class MongoDB < Sensu::Plugin::Metric::CLI::Graphite
          long: '--password PASSWORD',
          default: nil
 
-  option :scheme,
-         description: 'Metric naming scheme',
-         long: '--scheme SCHEME',
-         short: '-s SCHEME',
-         default: "#{Socket.gethostname}.mongodb"
+  option :ssl,
+         description: 'Connect using SSL',
+         long: '--ssl',
+         default: false
 
-  option :password,
-         description: 'MongoDB password',
-         long: '--password PASSWORD',
-         default: nil
+  option :ssl_cert,
+         description: 'The certificate file used to identify the local connection against mongod',
+         long: '--ssl-cert SSL_CERT',
+         default: ''
+
+  option :ssl_key,
+         description: 'The private key used to identify the local connection against mongod',
+         long: '--ssl-key SSL_KEY',
+         default: ''
+
+  option :ssl_ca_cert,
+         description: 'The set of concatenated CA certificates, which are used to validate certificates passed from the other end of the connection',
+         long: '--ssl-ca-cert SSL_CA_CERT',
+         default: ''
+
+  option :ssl_verify,
+         description: 'Whether or not to do peer certification validation',
+         long: '--ssl-verify',
+         default: false
 
   option :debug,
          description: 'Enable debug',
          long: '--debug',
          default: false
 
-  def get_mongo_doc(command)
-    rs = @db.command(command)
-    unless rs.successful?
-      return nil
-    end
-    rs.documents[0]
-  end
+  option :scheme,
+         description: 'Metric naming scheme',
+         long: '--scheme SCHEME',
+         short: '-s SCHEME',
+         default: "#{Socket.gethostname}.mongodb"
 
-  # connects to mongo and sets @db, works with MongoClient < 2.0.0
-  def connect_mongo_db(host, port, db_name, db_user, db_password)
-    if Gem.loaded_specs['mongo'].version < Gem::Version.new('2.0.0')
-      mongo_client = MongoClient.new(host, port)
-      @db = mongo_client.db(db_name)
-      @db.authenticate(db_user, db_password) unless db_user.nil?
-    else
-      address_str = "#{host}:#{port}"
-      client_opts = {}
-      client_opts[:database] = db_name
-      unless db_user.nil?
-        client_opts[:user] = db_user
-        client_opts[:password] = db_password
-      end
-      mongo_client = Mongo::Client.new([address_str], client_opts)
-      @db = mongo_client.database
-    end
-  end
+  option :require_master,
+         description: 'Require the node to be a master node',
+         long: '--require-master',
+         default: false
 
   def run
     Mongo::Logger.logger.level = Logger::FATAL
@@ -107,89 +106,22 @@ class MongoDB < Sensu::Plugin::Metric::CLI::Graphite
       Mongo::Logger.logger.level = Logger::DEBUG
       config_debug = config.clone
       config_debug[:password] = '***'
-      puts 'arguments:' + config_debug.inspect
-    end
-    host = config[:host]
-    port = config[:port]
-    db_name = 'admin'
-    db_user = config[:user]
-    db_password = config[:password]
-
-    connect_mongo_db(host, port, db_name, db_user, db_password)
-
-    _result = false
-    # check if master
-    begin
-      @is_master = get_mongo_doc('isMaster' => 1)
-      unless @is_master.nil?
-        _result = @is_master['ok'] == 1
-      end
-    rescue StandardError => e
-      if @debug
-        puts 'Error checking isMaster:' + e.message
-        puts e.backtrace.inspect
-      end
-      exit(1)
+      puts 'Arguments: ' + config_debug.inspect
     end
 
-    # get the metrics
-    begin
-      metrics = {}
-      server_status = get_mongo_doc('serverStatus' => 1)
-      if !server_status.nil? && server_status['ok'] == 1
-        metrics.update(gather_replication_metrics(server_status))
-        timestamp = Time.now.to_i
-        metrics.each do |k, v|
-          output [config[:scheme], k].join('.'), v, timestamp
-        end
-      end
-    rescue StandardError => e
-      if @debug
-        puts 'Error checking serverStatus:' + e.message
-        puts e.backtrace.inspect
-      end
-      exit(2)
+    # Get the metrics.
+    collector = SensuPluginsMongoDB::Metrics.new(config)
+    collector.connect_mongo_db('admin')
+    exit(1) if config[:require_master] && !collector.master?
+    metrics = collector.server_metrics
+
+    # Print them in graphite format.
+    timestamp = Time.now.to_i
+    metrics.each do |k, v|
+      output [config[:scheme], k].join('.'), v, timestamp
     end
 
     # done!
     ok
   end
-
-  def gather_replication_metrics(server_status)
-    mongo_version = server_status['version'].gsub(/[^0-9\.]/i, '') # Handle versions like "2.6.11-pre" etc
-    server_metrics = {}
-
-    server_metrics['lock.ratio'] = sprintf('%.5f', server_status['globalLock']['ratio']).to_s unless server_status['globalLock']['ratio'].nil?
-
-    server_metrics['lock.queue.total'] = server_status['globalLock']['currentQueue']['total']
-    server_metrics['lock.queue.readers'] = server_status['globalLock']['currentQueue']['readers']
-    server_metrics['lock.queue.writers'] = server_status['globalLock']['currentQueue']['writers']
-
-    server_metrics['connections.current'] = server_status['connections']['current']
-    server_metrics['connections.available'] = server_status['connections']['available']
-
-    if Gem::Version.new(mongo_version) < Gem::Version.new('3.0.0')
-      if server_status['indexCounters']['btree'].nil?
-        server_metrics['indexes.missRatio'] = sprintf('%.5f', server_status['indexCounters']['missRatio']).to_s
-        server_metrics['indexes.hits'] = server_status['indexCounters']['hits']
-        server_metrics['indexes.misses'] = server_status['indexCounters']['misses']
-      else
-        server_metrics['indexes.missRatio'] = sprintf('%.5f', server_status['indexCounters']['btree']['missRatio']).to_s
-        server_metrics['indexes.hits'] = server_status['indexCounters']['btree']['hits']
-        server_metrics['indexes.misses'] = server_status['indexCounters']['btree']['misses']
-      end
-    end
-
-    server_metrics['cursors.open'] = server_status['metrics']['cursor']['open']['total']
-    server_metrics['cursors.timedOut'] = server_status['metrics']['cursor']['timedOut']
-
-    server_metrics['mem.residentMb'] = server_status['mem']['resident']
-    server_metrics['mem.virtualMb'] = server_status['mem']['virtual']
-    server_metrics['mem.mapped'] = server_status['mem']['mapped']
-    server_metrics['mem.pageFaults'] = server_status['extra_info']['page_faults']
-
-    server_metrics['asserts.warnings'] = server_status['asserts']['warning']
-    server_metrics['asserts.errors'] = server_status['asserts']['msg']
-    server_metrics
-  end
 end

data/lib/sensu-plugins-mongodb/metics.rb

@@ -0,0 +1,340 @@
+require 'mongo'
+include Mongo
+
+module SensuPluginsMongoDB
+  class Metrics
+    # Initializes a Metrics collector.
+    #
+    # @param config [Mesh]
+    #   the config object parsed from the command line.
+    #   Must include: :host, :port, :user, :password, :debug
+    def initialize(config)
+      @config = config
+      @connected = false
+      @db = nil
+    end
+
+    # Connects to a mongo database.
+    #
+    # @param db_name [String] the name of the db to connect to.
+    def connect_mongo_db(db_name)
+      if @connected
+        raise 'Already connected to a database'
+      end
+
+      @connected = true
+      host = @config[:host]
+      port = @config[:port]
+      db_user = @config[:user]
+      db_password = @config[:password]
+      ssl = @config[:ssl]
+      ssl_cert = @config[:ssl_cert]
+      ssl_key = @config[:ssl_key]
+      ssl_ca_cert = @config[:ssl_ca_cert]
+      ssl_verify = @config[:ssl_verify]
+
+      if Gem.loaded_specs['mongo'].version < Gem::Version.new('2.0.0')
+        mongo_client = MongoClient.new(host, port)
+        @db = mongo_client.db(db_name)
+        @db.authenticate(db_user, db_password) unless db_user.nil?
+      else
+        address_str = "#{host}:#{port}"
+        client_opts = {}
+        client_opts[:database] = db_name
+        unless db_user.nil?
+          client_opts[:user] = db_user
+          client_opts[:password] = db_password
+        end
+        if ssl
+          client_opts[:ssl] = true
+          client_opts[:ssl_cert] = ssl_cert
+          client_opts[:ssl_key] = ssl_key
+          client_opts[:ssl_ca_cert] = ssl_ca_cert
+          client_opts[:ssl_verify] = ssl_verify
+        end
+        mongo_client = Mongo::Client.new([address_str], client_opts)
+        @db = mongo_client.database
+      end
+    end
+
+    # Fetches a document from the mongo db.
+    #
+    # @param command [Mesh] the command to search documents with.
+    # @return [Mesh, nil] the first document or nil.
+    def get_mongo_doc(command)
+      unless @connected
+        raise 'Cannot fetch documents before connecting.'
+      end
+      unless @db
+        raise 'Cannot fetch documents without a db.'
+      end
+
+      rs = @db.command(command)
+      unless rs.successful?
+        return nil
+      end
+      rs.documents[0]
+    end
+
+    # Checks if the connected node is the master node.
+    #
+    # @return [true, false] true when the node is a master node.
+    def master?
+      result = false
+      begin
+        @is_master = get_mongo_doc('isMaster' => 1)
+        unless @is_master.nil?
+          result = @is_master['ok'] == 1 && @is_master['ismaster']
+        end
+      rescue StandardError => e
+        if @config[:debug]
+          puts 'Error checking isMaster: ' + e.message
+          puts e.backtrace.inspect
+        end
+      end
+      result
+    end
+
+    # Fetches the status of the server (which includes the metrics).
+    #
+    # @return [Mash, nil] the document showing the server status or nil.
+    def server_status
+      status = get_mongo_doc('serverStatus' => 1)
+      return nil if status.nil? || status['ok'] != 1
+      return status
+    rescue StandardError => e
+      if @debug
+        puts 'Error checking serverStatus: ' + e.message
+        puts e.backtrace.inspect
+      end
+    end
+
+    # Fetches metrics for the server we are connected to.
+    #
+    # @return [Mash] the metrics for the server.
+    # rubocop:disable Metrics/AbcSize
+    def server_metrics
+      server_status = self.server_status
+      server_metrics = {}
+      # Handle versions like "2.6.11-pre" etc
+      mongo_version = server_status['version'].gsub(/[^0-9\.]/i, '')
+
+      server_metrics['lock.ratio'] = sprintf('%.5f', server_status['globalLock']['ratio']).to_s unless server_status['globalLock']['ratio'].nil?
+
+      # Asserts
+      asserts = server_status['asserts']
+      server_metrics['asserts.warnings'] = asserts['warning']
+      server_metrics['asserts.errors'] = asserts['msg']
+      server_metrics['asserts.regular'] = asserts['regular']
+      server_metrics['asserts.user'] = asserts['user']
+      server_metrics['asserts.rollovers'] = asserts['rollovers']
+
+      # Background flushing
+      if server_status.key?('backgroundFlushing')
+        bg_flushing = server_status['backgroundFlushing']
+        server_metrics['backgroundFlushing.flushes'] = bg_flushing['flushes']
+        server_metrics['backgroundFlushing.total_ms'] = bg_flushing['total_ms']
+        server_metrics['backgroundFlushing.average_ms'] = bg_flushing['average_ms']
+        server_metrics['backgroundFlushing.last_ms'] = bg_flushing['last_ms']
+      end
+
+      # Connections
+      connections = server_status['connections']
+      server_metrics['connections.current'] = connections['current']
+      server_metrics['connections.available'] = connections['available']
+      server_metrics['connections.totalCreated'] = connections['totalCreated']
+
+      # Cursors (use new metrics.cursor from mongo 2.6+)
+      if Gem::Version.new(mongo_version) < Gem::Version.new('2.6.0')
+        cursors = server_status['cursors']
+        server_metrics['clientCursors.size'] = cursors['clientCursors_size']
+        server_metrics['cursors.timedOut'] = cursors['timedOut']
+
+        # Metric names match the version 2.6+ format for standardization!
+        server_metrics['cursors.open.NoTimeout'] = cursors['totalNoTimeout']
+        server_metrics['cursors.open.pinned'] = cursors['pinned']
+        server_metrics['cursors.open.total'] = cursors['totalOpen']
+      else
+        cursors = server_status['metrics']['cursor']
+        server_metrics['cursors.timedOut'] = cursors['timedOut']
+        # clientCursors.size has been replaced by cursors.open.total
+
+        open = cursors['open']
+        server_metrics['cursors.open.noTimeout'] = open['noTimeout']
+        server_metrics['cursors.open.pinned'] = open['pinned']
+        server_metrics['cursors.open.total'] = open['total']
+
+        unless Gem::Version.new(mongo_version) < Gem::Version.new('3.0.0')
+          server_metrics['cursors.open.multiTarget'] = open['multiTarget']
+          server_metrics['cursors.open.singleTarget'] = open['singleTarget']
+        end
+      end
+
+      # Journaling (durability)
+      if server_status.key?('dur')
+        dur = server_status['dur']
+        server_metrics['journal.commits'] = dur['commits']
+        server_metrics['journaled_MB'] = dur['journaledMB']
+        server_metrics['journal.timeMs.writeToDataFiles'] = dur['timeMs']['writeToDataFiles']
+        server_metrics['journal.writeToDataFilesMB'] = dur['writeToDataFilesMB']
+        server_metrics['journal.compression'] = dur['compression']
+        server_metrics['journal.commitsInWriteLock'] = dur['commitsInWriteLock']
+        server_metrics['journal.timeMs.dt'] = dur['timeMs']['dt']
+        server_metrics['journal.timeMs.prepLogBuffer'] = dur['timeMs']['prepLogBuffer']
+        server_metrics['journal.timeMs.writeToJournal'] = dur['timeMs']['writeToJournal']
+        server_metrics['journal.timeMs.remapPrivateView'] = dur['timeMs']['remapPrivateView']
+      end
+
+      # Extra info
+      extra_info = server_status['extra_info']
+      server_metrics['mem.heap_usage_bytes'] = extra_info['heap_usage_bytes']
+      server_metrics['mem.pageFaults'] = extra_info['page_faults']
+
+      # Global Lock
+      global_lock = server_status['globalLock']
+      server_metrics['lock.totalTime'] = global_lock['totalTime']
+      server_metrics['lock.queue_total'] = global_lock['currentQueue']['total']
+      server_metrics['lock.queue_readers'] = global_lock['currentQueue']['readers']
+      server_metrics['lock.queue_writers'] = global_lock['currentQueue']['writers']
+      server_metrics['lock.clients_total'] = global_lock['activeClients']['total']
+      server_metrics['lock.clients_readers'] = global_lock['activeClients']['readers']
+      server_metrics['lock.clients_writers'] = global_lock['activeClients']['writers']
+
+      # Index counters
+      if Gem::Version.new(mongo_version) < Gem::Version.new('3.0.0')
+        index_counters = server_status['indexCounters']
+        index_counters = server_status['indexCounters']['btree'] unless server_status['indexCounters']['btree'].nil?
+
+        server_metrics['indexes.missRatio'] = sprintf('%.5f', index_counters['missRatio']).to_s
+        server_metrics['indexes.hits'] = index_counters['hits']
+        server_metrics['indexes.misses'] = index_counters['misses']
+        server_metrics['indexes.accesses'] = index_counters['accesses']
+        server_metrics['indexes.resets'] = index_counters['resets']
+      end
+
+      # Locks (from mongo 3.0+ only)
+      unless Gem::Version.new(mongo_version) < Gem::Version.new('3.0.0')
+        locks = server_status['locks']
+        lock_namespaces = %w(
+          Collection Global Database Metadata
+          MMAPV1Journal oplog
+        )
+        lock_dimentions = %w(
+          acquireCount acquireWaitCount
+          timeAcquiringMicros deadlockCount
+        )
+
+        lock_namespaces.each do |ns|
+          lock_dimentions.each do |dm|
+            next unless locks.key?(ns) && locks[ns].key?(dm)
+            lock = locks[ns][dm]
+            server_metrics["locks.#{ns}.#{dm}_r"] = lock['r'] if lock.key?('r')
+            server_metrics["locks.#{ns}.#{dm}_w"] = lock['r'] if lock.key?('w')
+            server_metrics["locks.#{ns}.#{dm}_R"] = lock['r'] if lock.key?('R')
+            server_metrics["locks.#{ns}.#{dm}_W"] = lock['r'] if lock.key?('W')
+          end
+        end
+      end
+
+      # Network
+      network = server_status['network']
+      server_metrics['network.bytesIn'] = network['bytesIn']
+      server_metrics['network.bytesOut'] = network['bytesOut']
+      server_metrics['network.numRequests'] = network['numRequests']
+
+      # Opcounters
+      opcounters = server_status['opcounters']
+      server_metrics['opcounters.insert'] = opcounters['insert']
+      server_metrics['opcounters.query'] = opcounters['query']
+      server_metrics['opcounters.update'] = opcounters['update']
+      server_metrics['opcounters.delete'] = opcounters['delete']
+      server_metrics['opcounters.getmore'] = opcounters['getmore']
+      server_metrics['opcounters.command'] = opcounters['command']
+
+      # Opcounters Replication
+      opcounters_repl = server_status['opcountersRepl']
+      server_metrics['opcountersRepl.insert'] = opcounters_repl['insert']
+      server_metrics['opcountersRepl.query'] = opcounters_repl['query']
+      server_metrics['opcountersRepl.update'] = opcounters_repl['update']
+      server_metrics['opcountersRepl.delete'] = opcounters_repl['delete']
+      server_metrics['opcountersRepl.getmore'] = opcounters_repl['getmore']
+      server_metrics['opcountersRepl.command'] = opcounters_repl['command']
+
+      # Memory
+      mem = server_status['mem']
+      server_metrics['mem.residentMb'] = mem['resident']
+      server_metrics['mem.virtualMb'] = mem['virtual']
+      server_metrics['mem.mapped'] = mem['mapped']
+      server_metrics['mem.mappedWithJournal'] = mem['mappedWithJournal']
+
+      # Metrics (documents)
+      document = server_status['metrics']['document']
+      server_metrics['metrics.document.deleted'] = document['deleted']
+      server_metrics['metrics.document.inserted'] = document['inserted']
+      server_metrics['metrics.document.returned'] = document['returned']
+      server_metrics['metrics.document.updated'] = document['updated']
+
+      # Metrics (getLastError)
+      get_last_error = server_status['metrics']['getLastError']
+      server_metrics['metrics.getLastError.wtime_num'] = get_last_error['wtime']['num']
+      server_metrics['metrics.getLastError.wtime_totalMillis'] = get_last_error['wtime']['totalMillis']
+      server_metrics['metrics.getLastError.wtimeouts'] = get_last_error['wtimeouts']
+
+      # Metrics (operation)
+      operation = server_status['metrics']['operation']
+      server_metrics['metrics.operation.fastmod'] = operation['fastmod']
+      server_metrics['metrics.operation.idhack'] = operation['idhack']
+      server_metrics['metrics.operation.scanAndOrder'] = operation['scanAndOrder']
+
+      # Metrics (operation)
+      query_executor = server_status['metrics']['queryExecutor']
+      server_metrics['metrics.queryExecutor.scanned'] = query_executor['scanned']
+      server_metrics['metrics.queryExecutor.scannedObjects'] = query_executor['scannedObjects']
+      server_metrics['metrics.record.moves'] = server_status['metrics']['record']['moves']
+
+      # Metrics (repl)
+      repl = server_status['metrics']['repl']
+      server_metrics['metrics.repl.apply.batches_num'] = repl['apply']['batches']['num']
+      server_metrics['metrics.repl.apply.batches_totalMillis'] = repl['apply']['batches']['totalMillis']
+      server_metrics['metrics.repl.apply.ops'] = repl['apply']['ops']
+      server_metrics['metrics.repl.buffer.count'] = repl['buffer']['count']
+      server_metrics['metrics.repl.buffer.maxSizeBytes'] = repl['buffer']['maxSizeBytes']
+      server_metrics['metrics.repl.buffer.sizeBytes'] = repl['buffer']['sizeBytes']
+      server_metrics['metrics.repl.network.bytes'] = repl['network']['bytes']
+      server_metrics['metrics.repl.network.getmores_num'] = repl['network']['getmores']['num']
+      server_metrics['metrics.repl.network.getmores_totalMillis'] = repl['network']['getmores']['totalMillis']
+      server_metrics['metrics.repl.network.ops'] = repl['network']['ops']
+      server_metrics['metrics.repl.network.readersCreated'] = repl['network']['readersCreated']
+      server_metrics['metrics.repl.preload.docs_num'] = repl['preload']['docs']['num']
+      server_metrics['metrics.repl.preload.docs_totalMillis'] = repl['preload']['docs']['totalMillis']
+      server_metrics['metrics.repl.preload.indexes_num'] = repl['preload']['indexes']['num']
+      server_metrics['metrics.repl.preload.indexes_totalMillis'] = repl['preload']['indexes']['totalMillis']
+
+      # Metrics (storage)
+      if Gem::Version.new(mongo_version) >= Gem::Version.new('2.6.0')
+        freelist = server_status['metrics']['storage']['freelist']
+        server_metrics['metrics.storage.freelist.search_bucketExhauseted'] = freelist['search']['bucketExhausted']
+        server_metrics['metrics.storage.freelist.search_requests'] = freelist['search']['requests']
+        server_metrics['metrics.storage.freelist.search_scanned'] = freelist['search']['scanned']
+      end
+
+      # Metrics (ttl)
+      ttl = server_status['metrics']['ttl']
+      server_metrics['metrics.ttl.deletedDocuments'] = ttl['deletedDocuments']
+      server_metrics['metrics.ttl.passes'] = ttl['passes']
+
+      # Return metrics map.
+      # MongoDB returns occasional nils and floats as {"floatApprox": x}.
+      # Clean up the results once here to avoid per-metric logic.
+      clean_metrics = {}
+      server_metrics.each do |k, v|
+        next if v.nil?
+        if v.is_a?(Hash) && v.key?('floatApprox')
+          v = v['floatApprox']
+        end
+        clean_metrics[k] = v
+      end
+      clean_metrics
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module SensuPluginsMongoDB
   module Version
     MAJOR = 1
-    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-mongodb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-04 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson
@@ -187,7 +187,9 @@ description: |-
                                 more.
 email: "<sensu-users@googlegroups.com>"
 executables:
+- check-mongodb-metric.rb
 - check-mongodb.rb
+- metrics-mongodb-replication.rb
 - metrics-mongodb.rb
 extensions: []
 extra_rdoc_files: []
@@ -195,10 +197,13 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/check-mongodb-metric.rb
 - bin/check-mongodb.py
 - bin/check-mongodb.rb
+- bin/metrics-mongodb-replication.rb
 - bin/metrics-mongodb.rb
 - lib/sensu-plugins-mongodb.rb
+- lib/sensu-plugins-mongodb/metics.rb
 - lib/sensu-plugins-mongodb/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-mongodb
 licenses:
@@ -231,4 +236,3 @@ signing_key:
 specification_version: 4
 summary: Sensu plugins for mongodb
 test_files: []
-has_rdoc: