sensu-plugins-mysql 2.6.0 → 3.2.0

data/bin/check-mysql-threads.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 #   check-mysql-threads.rb
 #
@@ -117,6 +119,6 @@ class CheckMySQLHealth < Sensu::Plugin::Check::CLI
   rescue Mysql::Error => e
     critical "MySQL check failed: #{e.error}"
   ensure
-    db.close if db
+    db&.close
   end
 end

data/bin/metrics-mysql-graphite.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # Push mysql stats into graphite
 # ===
@@ -90,120 +92,125 @@ class MysqlGraphite < Sensu::Plugin::Metric::CLI::Graphite
          long: '--verbose',
          boolean: true
 
-  def run
-    # props to https://github.com/coredump/hoardd/blob/master/scripts-available/mysql.coffee
-
-    metrics = {
+  def metrics_hash
+    {
       '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',
+        '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'
+        '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'
+        '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_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_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_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_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'
+        '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_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'
+        '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_connections'         =>          'MaxConnections',
-        'Max_prepared_stmt_count' =>          'MaxPreparedStmtCount'
+        'max_connections' => 'MaxConnections',
+        'Max_prepared_stmt_count' => 'MaxPreparedStmtCount'
       }
     }
+  end
+
+  def run
+    # props to https://github.com/coredump/hoardd/blob/master/scripts-available/mysql.coffee
+
+    metrics = metrics_hash
 
-    config[:host].split(' ').each do |mysql_host|
+    # FIXME: break this up
+    config[:host].split(' ').each do |mysql_host| # rubocop:disable Metrics/BlockLength
       mysql_shorthostname = mysql_host.split('.')[0]
       if config[:ini]
         ini = IniFile.load(config[:ini])
@@ -218,7 +225,7 @@ class MysqlGraphite < Sensu::Plugin::Metric::CLI::Graphite
         mysql = Mysql.new(mysql_host, db_user, db_pass, nil, config[:port], config[:socket])
 
         results = mysql.query('SHOW GLOBAL STATUS')
-      rescue => e
+      rescue StandardError => e
         puts e.message
       end
 
@@ -241,7 +248,7 @@ class MysqlGraphite < Sensu::Plugin::Metric::CLI::Graphite
             output "#{config[:scheme]}.#{mysql_shorthostname}.general.#{metrics['general'][key]}", value
           end
         end
-      rescue => e
+      rescue StandardError => e
         puts "Error querying slave status: #{e}" if config[:verbose]
       end
 
@@ -251,16 +258,16 @@ class MysqlGraphite < Sensu::Plugin::Metric::CLI::Graphite
         category = 'configuration'
         variables_results.each_hash do |row|
           metrics[category].each do |metric, desc|
-            if metric.casecmp(row['Variable_name']) == 0
+            if metric.casecmp(row['Variable_name']).zero?
               output "#{config[:scheme]}.#{mysql_shorthostname}.#{category}.#{desc}", row['Value']
             end
           end
         end
-      rescue => e
+      rescue StandardError => e
         puts e.message
       end
 
-      mysql.close if mysql
+      mysql&.close
     end
 
     ok

data/bin/metrics-mysql-multiple-select-count.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+# MySQL Select Count Metrics
+#
+# Creates a graphite-formatted metrics for the first values of a result set from MySQL queries
+# defined as a JSON parameter.
+#
+# Copyright 2017 Andrew Thal <athal7@me.com>
+# Copyright 2018 Tibor Nagy <nagyt@hu.inter.net>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/metric/cli'
+require 'mysql'
+require 'inifile'
+require 'json'
+
+class MysqlQueryCountMetric < 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'
+
+  option :database,
+         short: '-d DATABASE',
+         long: '--database DATABASE',
+         description: 'MySQL database',
+         default: ''
+
+  option :ini,
+         short: '-i',
+         long: '--ini VALUE',
+         description: 'My.cnf ini file'
+
+  option :ini_section,
+         description: 'Section in my.cnf ini file',
+         long: '--ini-section VALUE',
+         default: 'client'
+
+  option :socket,
+         short: '-S SOCKET',
+         long: '--socket SOCKET',
+         description: 'MySQL Unix socket to connect to'
+
+  option :name,
+         short: '-n NAME',
+         long: '--name NAME',
+         description: 'Metric name for a configured handler',
+         default: 'mysql.query_count'
+
+  option :query,
+         short: '-q SELECT_COUNT_QUERIES',
+         long: '--query SELECT_COUNT_QUERIES',
+         description: 'Queries to execute in JSON',
+         required: true
+
+  def run
+    if config[:ini]
+      ini = IniFile.load(config[:ini])
+      section = ini[config[:ini_section]]
+      db_user = section['user']
+      db_pass = section['password']
+    else
+      db_user = config[:username]
+      db_pass = config[:password]
+    end
+
+    begin
+      query_hash = ::JSON.parse config[:query]
+    rescue ::JSON::ParserError => e
+      critical "JSON.parse error: #{e}"
+    end
+
+    # traverse all SQL
+    query_hash.each do |key, sql|
+      raise "invalid query : #{sql}" unless sql =~ /^select\s+count\(\s*\*\s*\)/i
+
+      db = Mysql.real_connect(config[:host], db_user, db_pass, config[:database], config[:port], config[:socket])
+      count = db.query(sql).fetch_row[0].to_i
+
+      output "#{config[:name]}.#{key}", count
+    end
+
+    ok
+  rescue Mysql::Error => e
+    errstr = "Error code: #{e.errno} Error message: #{e.error}"
+    critical "#{errstr} SQLSTATE: #{e.sqlstate}" if e.respond_to?('sqlstate')
+  rescue StandardError => e
+    critical "unhandled exception: #{e}"
+  end
+end

data/bin/metrics-mysql-processes.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # metrics-mysql-processes
 #
@@ -94,33 +96,40 @@ class MetricsMySQLProcesses < Sensu::Plugin::Metric::CLI::Graphite
          long: '--socket SOCKET',
          description: 'MySQL Unix socket to connect to'
 
+  def set_default_metrics
+    {
+      'user' => {},
+      'database' => {},
+      'command' => {}
+    }.each_value { |value| value.default = 0 }
+  end
+
+  def db_connection_creds
+    if config[:ini]
+      ini = IniFile.load(config[:ini])
+      section = ini[config[:ini_section]]
+      db_user = section['user']
+      db_pass = section['password']
+    else
+      db_user = config[:username]
+      db_pass = config[:password]
+    end
+    [db_user, db_pass]
+  end
+
   def run
     config[:host].split(' ').each do |mysql_host|
       mysql_shorthostname = mysql_host.split('.')[0]
-      if config[:ini]
-        ini = IniFile.load(config[:ini])
-        section = ini[config[:ini_section]]
-        db_user = section['user']
-        db_pass = section['password']
-      else
-        db_user = config[:username]
-        db_pass = config[:password]
-      end
+      db_user, db_pass = db_connection_creds
       begin
         mysql = Mysql.new(mysql_host, db_user, db_pass, nil, config[:port], config[:socket])
 
         results = mysql.query('SHOW PROCESSLIST')
-      rescue => e
+      rescue StandardError => e
         unknown "Unable to query MySQL: #{e.message}"
       end
 
-      metrics = {
-        'user' => {},
-        'database' => {},
-        'command' => {}
-      }
-
-      metrics.each_value { |value| value.default = 0 }
+      metrics = set_default_metrics
 
       results.each_hash do |row|
         metrics['user'][row['User']] += 1