sensu-plugins-mysql-nagyt 2.6.0

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

@@ -0,0 +1,175 @@
+#!/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
+# Updated by Nicola Strappazzon 2016 to implement Multi Source Replication
+#
+# 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'
+#     mysql-alive.rb -h db01 --ini '/etc/sensu/my.cnf' --ini-section customsection
+#
+#   MY.CNF INI FORMAT
+#   [client]
+#   user=sensu
+#   password="abcd1234"
+#
+#   [customsection]
+#   user=user
+#   password="password"
+#
+
+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 :master_connection,
+         short: '-m',
+         long: '--master-connection=VALUE',
+         description: 'Replication master connection name'
+
+  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 :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
+
+  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[:user]
+      db_pass = config[:pass]
+    end
+    db_host = config[:host]
+    db_conn = config[:master_connection]
+
+    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 = if db_conn.nil?
+                  db.query 'SHOW SLAVE STATUS'
+                else
+                  db.query "SHOW SLAVE '#{db_conn}' STATUS"
+                end
+
+      unless results.nil?
+        results.each_hash do |row|
+          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
+
+          slave_running = %w(Slave_IO_Running Slave_SQL_Running).all? do |key|
+            row[key] =~ /Yes/
+          end
+
+          output = if db_conn.nil?
+                     'Slave not running!'
+                   else
+                     "Slave on master connection #{db_conn} not running!"
+                   end
+
+          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
+          elsif db_conn.nil?
+            ok "slave running: #{slave_running}, #{message}"
+          else
+            ok "master connection: #{db_conn}, 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/check-mysql-select-count.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+#
+# MySQL Select Count Check
+#
+# Checks the length of a result set from a MySQL query.
+#
+# Copyright 2017 Andrew Thal <athal7@me.com> to check-mysql-query-result-count.rb
+# Modified by Mutsutoshi Yoshimoto <negachov@gmail.com> 2018 to select count(*) version
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'mysql'
+require 'inifile'
+
+class MysqlSelectCountCheck < Sensu::Plugin::Check::CLI
+  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',
+         required: true
+
+  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 :warn,
+         short: '-w COUNT',
+         long: '--warning COUNT',
+         description: 'Warning when query value exceeds threshold',
+         proc: proc(&:to_i),
+         required: true
+
+  option :crit,
+         short: '-c COUNT',
+         long: '--critical COUNT',
+         description: 'Critical when query value exceeds threshold',
+         proc: proc(&:to_i),
+         required: true
+
+  option :query,
+         short: '-q SELECT_COUNT_QUERY',
+         long: '--query SELECT_COUNT_QUERY',
+         description: 'Query to execute',
+         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
+    raise "invalid query : #{config[:query]}" unless config[:query] =~ /^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(config[:query]).fetch_row[0].to_i
+    if count >= config[:crit]
+      critical "Count is above the CRITICAL limit: #{count} count / #{config[:crit]} limit"
+    elsif count >= config[:warn]
+      warning "Count is above the WARNING limit: #{count} count / #{config[:warn]} limit"
+    else
+      ok "Count is below thresholds : #{count} count"
+    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 StandardError => e
+    critical "unhandled exception: #{e}"
+
+  ensure
+    db.close if db
+  end
+end

data/bin/check-mysql-status.rb

@@ -0,0 +1,209 @@
+#!/usr/bin/env ruby
+#
+# MySQL Status Plugin
+# ===
+#
+# This plugin attempts to login to mysql with provided credentials.
+# NO DEPENDENCIES (no mysql-devel and thus no implicit mysql-server restart)
+# It checks whether MySQL is UP --check status
+# It checks replication delay --check replication
+# Author: Magic Online - www.magic.fr
+# Date: September 2016
+#
+# Author: Magic Online - www.magic.fr - September 2016
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+#
+# USING INI ARGUMENT
+# The ini file should be readable by the sensu user/group.
+#
+#   EXAMPLE
+#     check-mysql-status.rb -h localhost --ini '/etc/sensu/my.cnf' --check status
+#     check-mysql-status.rb -h localhost --ini '/etc/sensu/my.cnf' --check replication
+#
+#   MY.CNF INI FORMAT
+#   [client]
+#   user=sensu
+#   password="abcd1234"
+#   socket="/var/lib/mysql/mysql.sock"
+#
+
+require 'sensu-plugin/check/cli'
+require 'inifile'
+require 'open3'
+
+# Check MySQL Status
+class CheckMySQLStatus < Sensu::Plugin::Check::CLI
+  option :user,
+         description: 'MySQL User, you really should use ini to hide credentials instead of using me',
+         short: '-u USER',
+         long: '--user USER',
+         default: 'mosim'
+
+  option :password,
+         description: 'MySQL Password, you really should use ini to hide credentials instead of using me',
+         short: '-p PASS',
+         long: '--password PASS',
+         default: 'mysqlPassWord'
+
+  option :ini,
+         description: 'My.cnf ini file',
+         short: '-i',
+         long: '--ini VALUE'
+
+  option :ini_section,
+         description: 'Section in my.cnf ini file',
+         long: '--ini-section VALUE',
+         default: 'client'
+
+  option :hostname,
+         description: 'Hostname to login to',
+         short: '-h HOST',
+         long: '--hostname HOST',
+         default: 'localhost'
+
+  option :database,
+         description: 'Database schema to connect to',
+         short: '-d DATABASE',
+         long: '--database DATABASE',
+         default: 'test'
+
+  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',
+         default: '/var/run/mysqld/mysqld.sock'
+
+  option :binary,
+         description: 'Absolute path to mysql binary',
+         short: '-b BINARY',
+         long: '--binary BINARY',
+         default: 'mysql'
+
+  option :check,
+         description: 'type of check: (status|replication)',
+         short: '-C CHECK',
+         long: '--check CHECK',
+         default: 'status'
+
+  option :warn,
+         description: 'Warning threshold for replication lag',
+         short: '-w',
+         long: '--warning=VALUE',
+         default: 900
+
+  option :crit,
+         description: 'Critical threshold for replication lag',
+         short: '-c',
+         long: '--critical=VALUE',
+         default: 1800
+
+  option :debug,
+         description: 'Print debug info',
+         long: '--debug',
+         default: false
+
+  def credentials
+    if config[:ini]
+      ini = IniFile.load(config[:ini])
+      section = ini[config[:ini_section]]
+      db_user = section['user']
+      db_pass = section['password']
+      db_socket = if config[:socket]
+                    config[:socket]
+                  else
+                    section['socket']
+                  end
+    else
+      db_user = config[:user]
+      db_pass = config[:password]
+      db_socket = config[:socket]
+    end
+    [db_user, db_pass, db_socket]
+  end
+
+  # Status check
+  def status_check(db_user, db_pass, db_socket)
+    cmd = "#{config[:binary]} -u #{db_user} -h #{config[:hostname]} --port #{config[:port]} \
+        --socket #{db_socket} -p\"#{db_pass.strip}\" --batch --disable-column-names -e 'show schemas;'"
+    begin
+      stdout, _stderr, status = Open3.capture3(cmd)
+      if status.to_i == 0
+        ok "#{status} | #{stdout.split("\n")}"
+      else
+        critical "Error message: status: #{status}"
+      end
+    rescue => e
+      critical "Error message: status: #{status} | Exception: #{e}"
+    ensure
+      puts ''
+    end
+  end
+
+  def replication_check(db_user, db_pass, db_socket)
+    table = {}
+    begin
+      cmd = "#{config[:binary]} -u #{db_user} -h #{config[:hostname]} --port #{config[:port]} \
+        --socket #{db_socket} -p\"#{db_pass.strip}\"  -e 'SHOW SLAVE STATUS\\G'"
+      stdout, _stderr, status = Open3.capture3(cmd)
+      if status.to_i != 0
+        critical "Error message: status: #{status}"
+      end
+      stdout.split("\n").each do |line|
+        key = line.split(':')[0]
+        value = line.split(':')[1]
+        table[key.strip.to_s] = value.to_s unless key.include? '***'
+      end
+      dict = []
+      table.keys.to_a.each do |k|
+        %w(Slave_IO_State Slave_IO_Running Slave_SQL_Running Last_IO_Error Last_SQL_Error Seconds_Behind_Master).each do |key|
+          dict.push(k.strip.to_s) if key.strip == k.strip
+        end
+      end
+      table.each do |attribute, value|
+        puts "#{attribute} : #{value}" if config[:debug]
+        warn "couldn't detect replication status :#{dict.size}" unless dict.size == 6
+        slave_running = %w(Slave_IO_Running Slave_SQL_Running).all? do |key|
+          table[key].to_s =~ /Yes/
+        end
+        output = 'Slave not running!'
+        output += ' STATES:'
+        output += " Slave_IO_Running=#{table['Slave_IO_Running']}"
+        output += ", Slave_SQL_Running=#{table['Slave_SQL_Running']}"
+        output += ", LAST ERROR: #{table['Last_SQL_Error']}"
+        critical output unless slave_running
+        replication_delay = table['Seconds_Behind_Master'].to_i
+        message = "replication delayed by #{replication_delay}"
+        if replication_delay > config[:warn].to_i && replication_delay <= config[:crit].to_i
+          warning message
+        elsif replication_delay >= config[:crit].to_i
+          critical message
+        else
+          ok "slave running: #{slave_running}, #{message}"
+        end
+      end
+      ok 'show slave status was nil. This server is not a slave.'
+    rescue => e
+      critical "Error message: status: #{status} | Exception: #{e}"
+    end
+  end
+
+  def run
+    db_user = credentials[0]
+    db_pass = credentials[1]
+    db_socket = credentials[2]
+    if config[:check] == 'status'
+      status_check(db_user, db_pass, db_socket)
+    end
+    if config[:check] == 'replication'
+      replication_check(db_user, db_pass, db_socket)
+    end
+    unknown 'No check type succeeded. Check your options'
+  end
+end