sensu-plugins/sensu-plugins-mysql

#!/usr/bin/env ruby
# frozen_string_literal: false

#
# 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'

  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']
      config[:host] = section['host']
      config[:socket] = section['socket']
    else
      db_user = config[:username]
      db_pass = config[:password]
    end
    raise 'Please specify hostname using -h or in mysql.cnf file' unless config[:host]

    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
  end
end