sensu-plugins-mysql 0.0.1

data/bin/check-mysql-innodb-lock.rb

@@ -0,0 +1,130 @@
+# !/usr/bin/env ruby
+#
+# MySQL InnoDB Lock Check Plugin
+# ===
+#
+# This plugin checks InnoDB locks.
+#
+# Copyright 2014 Hiroaki Sano <hiroaki.sano.9stories@gmail.com>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'mysql'
+
+class CheckMySQLInnoDBLock < Sensu::Plugin::Check::CLI
+  option :user,
+         description: 'MySQL User',
+         short: '-u USER',
+         long: '--user USER',
+         default: 'root'
+
+  option :password,
+         description: 'MySQL Password',
+         short: '-p PASS',
+         long: '--password PASS',
+         required: true
+
+  option :hostname,
+         description: 'Hostname to login to',
+         short: '-h HOST',
+         long: '--hostname HOST',
+         default: 'localhost'
+
+  option :port,
+         description: 'Port to connect to',
+         short: '-P PORT',
+         long: '--port PORT',
+         default: '3306'
+
+  option :socket,
+         description: 'Socket to use',
+         short: '-s SOCKET',
+         long: '--socket SOCKET'
+
+  option :warn,
+         description: 'Warning threshold',
+         short: '-w SECONDS',
+         long: '--warning SECONDS',
+         default: 5
+
+  option :crit,
+         description: 'Critical threshold',
+         short: '-c SECONDS',
+         long: '--critical SECONDS',
+         default: 10
+
+  def run
+    db = Mysql.new(config[:hostname], config[:user], config[:password], config[:database], config[:port].to_i, config[:socket])
+
+    warn = config[:warn].to_i
+    crit = config[:crit].to_i
+
+    res = db.query <<-EQSQL
+      select
+        t_b.trx_mysql_thread_id blocking_id,
+        t_w.trx_mysql_thread_id requesting_id,
+        p_b.HOST blocking_host,
+        p_w.HOST requesting_host,
+        l.lock_table lock_table,
+        l.lock_index lock_index,
+        l.lock_mode lock_mode,
+        p_w.TIME seconds,
+        p_b.INFO blocking_info,
+        p_w.INFO requesting_info
+      from
+        information_schema.INNODB_LOCK_WAITS w,
+        information_schema.INNODB_LOCKS l,
+        information_schema.INNODB_TRX t_b,
+        information_schema.INNODB_TRX t_w,
+        information_schema.PROCESSLIST p_b,
+        information_schema.PROCESSLIST p_w
+      where
+          w.blocking_lock_id = l.lock_id
+        and
+          w.blocking_trx_id = t_b.trx_id
+        and
+          w.requesting_trx_id = t_w.trx_id
+        and
+          t_b.trx_mysql_thread_id = p_b.ID
+        and
+          t_w.trx_mysql_thread_id = p_w.ID
+        and
+          p_w.TIME > #{warn}
+      order by
+        requesting_id,blocking_id
+    EQSQL
+
+    lock_info = []
+    is_crit = false
+    res.each_hash do |row|
+      h = {}
+      is_crit = true if row['seconds'].to_i > crit
+      h['blocking_id'] = row['blocking_id']
+      h['requesting_id'] = row['requesting_id']
+      h['blocking_host'] = row['blocking_host']
+      h['requesting_host'] = row['requesting_host']
+      h['lock_table'] = row['lock_table']
+      h['lock_index'] = row['lock_index']
+      h['lock_mode'] = row['lock_mode']
+      h['seconds'] = row['seconds']
+      h['blocking_info'] = row['blocking_info']
+      h['requesting_info'] = row['requesting_info']
+      lock_info.push(h)
+    end
+
+    if lock_info.length == 0
+      ok
+    elsif is_crit == false
+      warning "Detected Locks #{lock_info}"
+    else
+      critical "Detected Locks #{lock_info}"
+    end
+
+  rescue Mysql::Error => e
+    critical "MySQL check failed: #{e.error}"
+  ensure
+    db.close if db
+  end
+end

data/bin/check-mysql-replication-status.rb

@@ -0,0 +1,158 @@
+# !/usr/bin/env ruby
+#
+# MySQL Replication Status (modded from disk)
+# ===
+#
+# Copyright 2011 Sonian, Inc <chefs@sonian.net>
+# Updated by Oluwaseun Obajobi 2014 to accept ini argument
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+#
+# USING INI ARGUMENT
+# This was implemented to load mysql credentials without parsing the username/password.
+# The ini file should be readable by the sensu user/group.
+# Ref: http://eric.lubow.org/2009/ruby/parsing-ini-files-with-ruby/
+#
+#   EXAMPLE
+#     mysql-alive.rb -h db01 --ini '/etc/sensu/my.cnf'
+#
+#   MY.CNF INI FORMAT
+#   [client]
+#   user=sensu
+#   password="abcd1234"
+#
+
+require 'sensu-plugin/check/cli'
+require 'mysql'
+require 'inifile'
+
+class CheckMysqlReplicationStatus < Sensu::Plugin::Check::CLI
+  option :host,
+         short: '-h',
+         long: '--host=VALUE',
+         description: 'Database host'
+
+  option :port,
+         short: '-P',
+         long: '--port=VALUE',
+         description: 'Database port',
+         default: 3306,
+         # #YELLOW
+         proc: lambda { |s| s.to_i } # rubocop:disable Lambda
+
+  option :socket,
+         short: '-s SOCKET',
+         long: '--socket SOCKET',
+         description: 'Socket to use'
+
+  option :user,
+         short: '-u',
+         long: '--username=VALUE',
+         description: 'Database username'
+
+  option :pass,
+         short: '-p',
+         long: '--password=VALUE',
+         description: 'Database password'
+
+  option :ini,
+         short: '-i',
+         long: '--ini VALUE',
+         description: 'My.cnf ini file'
+
+  option :warn,
+         short: '-w',
+         long: '--warning=VALUE',
+         description: 'Warning threshold for replication lag',
+         default: 900,
+         # #YELLOW
+         proc: lambda { |s| s.to_i }  # rubocop:disable Lambda
+
+  option :crit,
+         short: '-c',
+         long: '--critical=VALUE',
+         description: 'Critical threshold for replication lag',
+         default: 1800,
+         # #YELLOW
+         proc: lambda { |s| s.to_i }  # rubocop:disable Lambda
+
+  option :help,
+         short: '-h',
+         long: '--help',
+         description: 'Check MySQL replication status',
+         on: :tail,
+         boolean: true,
+         show_options: true,
+         exit: 0
+
+  def run
+    if config[:ini]
+      ini = IniFile.load(config[:ini])
+      section = ini['client']
+      db_user = section['user']
+      db_pass = section['password']
+    else
+      db_user = config[:user]
+      db_pass = config[:pass]
+    end
+    db_host = config[:host]
+
+    if [db_host, db_user, db_pass].any?(&:nil?)
+      unknown 'Must specify host, user, password'
+    end
+
+    begin
+      db = Mysql.new(db_host, db_user, db_pass, nil, config[:port], config[:socket])
+      results = db.query 'show slave status'
+
+      unless results.nil?
+        results.each_hash do |row|
+          # #YELLOW
+          # rubocop:disable all
+          warn "couldn't detect replication status" unless
+            %w(Slave_IO_State Slave_IO_Running Slave_SQL_Running Last_IO_Error Last_SQL_Error Seconds_Behind_Master).all? do |key|
+              row.key? key
+            end
+
+          # rubocop: enable all
+          slave_running = %w(Slave_IO_Running Slave_SQL_Running).all? do |key|
+            row[key] =~ /Yes/
+          end
+
+          output = 'Slave not running!'
+          output += ' STATES:'
+          output += " Slave_IO_Running=#{row['Slave_IO_Running']}"
+          output += ", Slave_SQL_Running=#{row['Slave_SQL_Running']}"
+          output += ", LAST ERROR: #{row['Last_SQL_Error']}"
+
+          critical output unless slave_running
+
+          replication_delay = row['Seconds_Behind_Master'].to_i
+
+          message = "replication delayed by #{replication_delay}"
+
+          if replication_delay > config[:warn] &&
+             replication_delay <= config[:crit]
+            warning message
+          elsif replication_delay >= config[:crit]
+            critical message
+          else
+            ok "slave running: #{slave_running}, #{message}"
+          end
+        end
+        ok 'show slave status was nil. This server is not a slave.'
+      end
+
+    rescue Mysql::Error => e
+      errstr = "Error code: #{e.errno} Error message: #{e.error}"
+      critical "#{errstr} SQLSTATE: #{e.sqlstate}" if e.respond_to?('sqlstate')
+
+    rescue => e
+      critical e
+
+    ensure
+      db.close if db
+    end
+  end
+end

data/bin/metrics-mysql-graphite.rb

@@ -0,0 +1,261 @@
+# !/usr/bin/env ruby
+#
+# Push mysql stats into graphite
+# ===
+#
+# NOTE: This plugin will attempt to get replication stats but the user
+# must have SUPER or REPLICATION CLIENT privileges to run 'SHOW SLAVE
+# STATUS'. It will silently ignore and continue if 'SHOW SLAVE STATUS'
+# fails for any reason. The key 'slaveLag' will not be present in the
+# output.
+#
+# Copyright 2012 Pete Shima <me@peteshima.com>
+# Additional hacks by Joe Miller - https://github.com/joemiller
+# Updated by Oluwaseun Obajobi 2014 to accept ini argument
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+#
+# USING INI ARGUMENT
+# This was implemented to load mysql credentials without parsing the username/password.
+# The ini file should be readable by the sensu user/group.
+# Ref: http://eric.lubow.org/2009/ruby/parsing-ini-files-with-ruby/
+#
+#   EXAMPLE
+#     mysql-alive.rb -h db01 --ini '/etc/sensu/my.cnf'
+#
+#   MY.CNF INI FORMAT
+#   [client]
+#   user=sensu
+#   password="abcd1234"
+#
+
+require 'sensu-plugin/metric/cli'
+require 'mysql2'
+require 'socket'
+require 'inifile'
+
+class Mysql2Graphite < Sensu::Plugin::Metric::CLI::Graphite
+  option :host,
+         short: '-h HOST',
+         long: '--host HOST',
+         description: 'Mysql Host to connect to',
+         required: true
+
+  option :port,
+         short: '-P PORT',
+         long: '--port PORT',
+         description: 'Mysql Port to connect to',
+         proc: proc(&:to_i),
+         default: 3306
+
+  option :username,
+         short: '-u USERNAME',
+         long: '--user USERNAME',
+         description: 'Mysql Username'
+
+  option :password,
+         short: '-p PASSWORD',
+         long: '--pass PASSWORD',
+         description: 'Mysql password',
+         default: ''
+
+  option :ini,
+         short: '-i',
+         long: '--ini VALUE',
+         description: 'My.cnf ini file'
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.mysql"
+
+  option :socket,
+         short: '-S SOCKET',
+         long: '--socket SOCKET'
+
+  option :verbose,
+         short: '-v',
+         long: '--verbose',
+         boolean: true
+
+  def run
+    # props to https://github.com/coredump/hoardd/blob/master/scripts-available/mysql.coffee
+
+    metrics = {
+      'general' => {
+        'Bytes_received' =>         'rxBytes',
+        'Bytes_sent' =>             'txBytes',
+        'Key_read_requests' =>      'keyRead_requests',
+        'Key_reads' =>              'keyReads',
+        'Key_write_requests' =>     'keyWrite_requests',
+        'Key_writes' =>             'keyWrites',
+        'Binlog_cache_use' =>       'binlogCacheUse',
+        'Binlog_cache_disk_use' =>  'binlogCacheDiskUse',
+        'Max_used_connections' =>   'maxUsedConnections',
+        'Aborted_clients' =>        'abortedClients',
+        'Aborted_connects' =>       'abortedConnects',
+        'Threads_connected' =>      'threadsConnected',
+        'Open_files' =>             'openFiles',
+        'Open_tables' =>            'openTables',
+        'Opened_tables' =>          'openedTables',
+        'Prepared_stmt_count' =>    'preparedStmtCount',
+        'Seconds_Behind_Master' =>  'slaveLag',
+        'Select_full_join' =>       'fullJoins',
+        'Select_full_range_join' => 'fullRangeJoins',
+        'Select_range' =>           'selectRange',
+        'Select_range_check' =>     'selectRange_check',
+        'Select_scan' =>            'selectScan',
+        'Slow_queries' =>           'slowQueries'
+      },
+      'querycache' => {
+        'Qcache_queries_in_cache' =>  'queriesInCache',
+        'Qcache_hits' =>              'cacheHits',
+        'Qcache_inserts' =>           'inserts',
+        'Qcache_not_cached' =>        'notCached',
+        'Qcache_lowmem_prunes' =>     'lowMemPrunes'
+      },
+      'commands' => {
+        'Com_admin_commands' => 'admin_commands',
+        'Com_begin' =>          'begin',
+        'Com_change_db' =>      'change_db',
+        'Com_commit' =>         'commit',
+        'Com_create_table' =>   'create_table',
+        'Com_drop_table' =>     'drop_table',
+        'Com_show_keys' =>      'show_keys',
+        'Com_delete' =>         'delete',
+        'Com_create_db' =>      'create_db',
+        'Com_grant' =>          'grant',
+        'Com_show_processlist' => 'show_processlist',
+        'Com_flush' =>          'flush',
+        'Com_insert' =>         'insert',
+        'Com_purge' =>          'purge',
+        'Com_replace' =>        'replace',
+        'Com_rollback' =>       'rollback',
+        'Com_select' =>         'select',
+        'Com_set_option' =>     'set_option',
+        'Com_show_binlogs' =>   'show_binlogs',
+        'Com_show_databases' => 'show_databases',
+        'Com_show_fields' =>    'show_fields',
+        'Com_show_status' =>    'show_status',
+        'Com_show_tables' =>    'show_tables',
+        'Com_show_variables' => 'show_variables',
+        'Com_update' =>         'update',
+        'Com_drop_db' =>        'drop_db',
+        'Com_revoke' =>         'revoke',
+        'Com_drop_user' =>      'drop_user',
+        'Com_show_grants' =>    'show_grants',
+        'Com_lock_tables' =>    'lock_tables',
+        'Com_show_create_table' => 'show_create_table',
+        'Com_unlock_tables' =>  'unlock_tables',
+        'Com_alter_table' =>    'alter_table'
+      },
+      'counters' => {
+        'Handler_write' =>              'handlerWrite',
+        'Handler_update' =>             'handlerUpdate',
+        'Handler_delete' =>             'handlerDelete',
+        'Handler_read_first' =>         'handlerRead_first',
+        'Handler_read_key' =>           'handlerRead_key',
+        'Handler_read_next' =>          'handlerRead_next',
+        'Handler_read_prev' =>          'handlerRead_prev',
+        'Handler_read_rnd' =>           'handlerRead_rnd',
+        'Handler_read_rnd_next' =>      'handlerRead_rnd_next',
+        'Handler_commit' =>             'handlerCommit',
+        'Handler_rollback' =>           'handlerRollback',
+        'Handler_savepoint' =>          'handlerSavepoint',
+        'Handler_savepoint_rollback' => 'handlerSavepointRollback'
+      },
+      'innodb' => {
+        'Innodb_buffer_pool_pages_total' =>   'bufferTotal_pages',
+        'Innodb_buffer_pool_pages_free' =>    'bufferFree_pages',
+        'Innodb_buffer_pool_pages_dirty' =>   'bufferDirty_pages',
+        'Innodb_buffer_pool_pages_data' =>    'bufferUsed_pages',
+        'Innodb_page_size' =>                 'pageSize',
+        'Innodb_pages_created' =>             'pagesCreated',
+        'Innodb_pages_read' =>                'pagesRead',
+        'Innodb_pages_written' =>             'pagesWritten',
+        'Innodb_row_lock_current_waits' =>    'currentLockWaits',
+        'Innodb_row_lock_waits' =>            'lockWaitTimes',
+        'Innodb_row_lock_time' =>             'rowLockTime',
+        'Innodb_data_reads' =>                'fileReads',
+        'Innodb_data_writes' =>               'fileWrites',
+        'Innodb_data_fsyncs' =>               'fileFsyncs',
+        'Innodb_log_writes' =>                'logWrites',
+        'Innodb_rows_updated' =>              'rowsUpdated',
+        'Innodb_rows_read' =>                 'rowsRead',
+        'Innodb_rows_deleted' =>              'rowsDeleted',
+        'Innodb_rows_inserted' =>             'rowsInserted'
+      },
+      'configuration' => {
+        'Max_prepared_stmt_count' =>          'MaxPreparedStmtCount'
+      }
+    }
+
+    config[:host].split(' ').each do |mysql_host|
+      mysql_shorthostname = mysql_host.split('.')[0]
+      if config[:ini]
+        ini = IniFile.load(config[:ini])
+        section = ini['client']
+        db_user = section['user']
+        db_pass = section['password']
+      else
+        db_user = config[:username]
+        db_pass = config[:password]
+      end
+      begin
+        mysql = Mysql2::Client.new(
+          host: mysql_host,
+          port: config[:port],
+          username: db_user,
+          password: db_pass,
+          socket: config[:socket]
+        )
+
+        results = mysql.query('SHOW GLOBAL STATUS')
+      rescue => e
+        puts e.message
+      end
+
+      results.each do |row|
+        metrics.each do |category, var_mapping|
+          if var_mapping.key?(row['Variable_name'])
+            output "#{config[:scheme]}.#{mysql_shorthostname}.#{category}.#{var_mapping[row['Variable_name']]}", row['Value']
+          end
+        end
+      end
+
+      begin
+        slave_results = mysql.query('SHOW SLAVE STATUS')
+        # should return a single element array containing one hash
+        # #YELLOW
+        slave_results.first.each do |key, value| # rubocop:disable Style/Next
+          if metrics['general'].include?(key)
+            # Replication lag being null is bad, very bad, so negativate it here
+            value = -1 if key == 'Seconds_Behind_Master' && value.nil?
+            output "#{config[:scheme]}.#{mysql_shorthostname}.general.#{metrics['general'][key]}", value
+          end
+        end
+      rescue => e
+        puts "Error querying slave status: #{e}" if config[:verbose]
+      end
+
+      begin
+        variables_results = mysql.query('SHOW GLOBAL VARIABLES')
+
+        category = 'configuration'
+        variables_results.each do |row|
+          metrics[category].each do |metric, desc|
+            if metric.casecmp(row['Variable_name']) == 0
+              output "#{config[:scheme]}.#{mysql_shorthostname}.#{category}.#{desc}", row['Value']
+            end
+          end
+        end
+      rescue => e
+        puts e.message
+      end
+    end
+
+    ok
+  end
+end