sensu-plugins-mysql-checks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5fd0d7edc5bb266573a286dde1620c2ce3c3b81
+  data.tar.gz: 22b3303c6b3e2794f2c033a6f92a458d4174c080
+SHA512:
+  metadata.gz: 6f7829206dd1bd32c4451a7b7d72ee0ccd3841b966936aabba345f70ccd2c9ae89d1fe93b37e2da0dc172c490c926224dba2a20fa661a5da3dc1b7749c0d7609
+  data.tar.gz: 3452e50d14dc9d7bb9968172b432b92702a90a8dd3414c2ef297c2991e9c966e95545e0218b28847ec4c30e837941f3caf49ca08df5112bcb13d20be002b9873

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## Unreleased
+
+## [0.0.1] - 2016-01-18
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Matteo Cerutti
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,45 @@
+# Sensu plugin for monitoring MySQL
+
+A sensu plugin to monitor MySQL, including slave replication.
+
+The plugin generates multiple OK/WARN/CRIT/UNKNOWN events via the sensu client socket (https://sensuapp.org/docs/latest/clients#client-socket-input).
+
+What is currently supported:
+
+* Active connections check
+* Max used connections check
+* Slave IO/SQL threads running checks
+* Slave replication lag check
+* Uptime check
+* Operational check (up/down)
+
+## Usage
+
+The plugin accepts the following command line options:
+
+```
+    -c, --config <PATH>              Optional configuration file (default: ./mysql.json)
+        --crit-conn <PERCENTAGE>     Critical if PERCENTAGE exceeds the current number of open connections in relation to max connections (default: 90)
+        --crit-slave-lag <SECONDS>   Critical if SECONDS exceeds the current slave replication lag (default: 120)
+        --dryrun                     Do not send events to sensu client socket
+        --handlers <HANDLER>         Comma separated list of handlers
+    -H, --host <HOST>                MySQL host (default: localhost)
+        --password <PASSWORD>        MySQL password
+    -p, --port <PORT>                MySQL port (default: 3306)
+        --uptime <UPTIME>            Uptime in seconds
+    -u, --user <USER>                MySQL user
+        --warn-conn <PERCENTAGE>     Warn if PERCENTAGE exceeds the current number of open connections in relation to max connections (default: 80)
+        --warn-slave-lag <SECONDS>   Warn if SECONDS exceeds the current slave replication lag (default: 60)
+```
+
+For security reasons, it's recommended you placed the MySQL credentials in the JSON configuration file as follows:
+
+```
+{
+  "username": "sensu",
+  "password": "secret"
+}
+```
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-mysql.rb

@@ -0,0 +1,224 @@
+#!/usr/bin/env ruby
+#
+# check-mysql.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-plugin/check/cli'
+require 'mysql2'
+require 'json'
+
+class CheckMySQL < Sensu::Plugin::Check::CLI
+  option :host,
+         :description => "MySQL host (default: localhost)",
+         :short => "-H <HOST>",
+         :long => "--host <HOST>",
+         :default => "localhost"
+
+  option :port,
+         :description => "MySQL port (default: 3306)",
+         :short => "-p <PORT>",
+         :long => "--port <PORT>",
+         :proc => proc(&:to_i),
+         :default => 3306
+
+  option :username,
+         :description => "MySQL user",
+         :short => "-u <USER>",
+         :long => "--user <USER>",
+         :default => nil
+
+  option :password,
+         :description => "MySQL password",
+         :long => "--password <PASSWORD>",
+         :default => nil
+
+  option :config_file,
+         :description => "Optional configuration file (default: #{File.dirname(__FILE__)}/mysql.json)",
+         :short => "-c <PATH>",
+         :long => "--config <PATH>",
+         :default => File.dirname(__FILE__) + "/mysql.json"
+
+  option :uptime,
+         :description => "Uptime in seconds",
+         :long => "--uptime <UPTIME>",
+         :proc => proc(&:to_i),
+         :default => 300
+
+  option :warn_conn,
+         :description => "Warn if PERCENTAGE exceeds the current number of open connections in relation to max connections (default: 80)",
+         :long => "--warn-conn <PERCENTAGE>",
+         :proc => proc(&:to_i),
+         :default => 80
+
+  option :crit_conn,
+         :description => "Critical if PERCENTAGE exceeds the current number of open connections in relation to max connections (default: 90)",
+         :long => "--crit-conn <PERCENTAGE>",
+         :proc => proc(&:to_i),
+         :default => 90
+
+  option :warn_slave_lag,
+         :description => "Warn if SECONDS exceeds the current slave replication lag (default: 60)",
+         :long => "--warn-slave-lag <SECONDS>",
+         :proc => proc(&:to_i),
+         :default => 60
+
+  option :crit_slave_lag,
+         :description => "Critical if SECONDS exceeds the current slave replication lag (default: 120)",
+         :long => "--crit-slave-lag <SECONDS>",
+         :proc => proc(&:to_i),
+         :default => 120
+
+  option :handlers,
+         :description => "Comma separated list of handlers",
+         :long => "--handlers <HANDLER>",
+         :proc => proc { |s| s.split(',') },
+         :default => []
+
+  option :dryrun,
+         :description => "Do not send events to sensu client socket",
+         :long => "--dryrun",
+         :boolean => true,
+         :default => false
+
+  def initialize()
+    super
+
+    if File.exists?(config[:config_file])
+      config.merge!(JSON.parse(File.read(config[:config_file]), :symbolize_names => true))
+    end
+
+    raise "MySQL user is required" if config[:username].nil?
+    raise "MySQL password is required" if config[:password].nil?
+
+    begin
+      @client = Mysql2::Client.new(:host => config[:host], :port => config[:port], :username => config[:username], :password => config[:password])
+    rescue
+      critical("MySQL server is down (#{$!})")
+    end
+  end
+
+  def send_client_socket(data)
+    if config[:dryrun]
+      puts data.inspect
+    else
+      sock = UDPSocket.new
+      sock.send(data + "\n", 0, "127.0.0.1", 3030)
+    end
+  end
+
+  def send_ok(check_name, msg)
+    event = {"name" => check_name, "status" => 0, "output" => "#{self.class.name} OK: #{msg}", "handlers" => config[:handlers]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_warning(check_name, msg)
+    event = {"name" => check_name, "status" => 1, "output" => "#{self.class.name} WARNING: #{msg}", "handlers" => config[:handlers]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_critical(check_name, msg)
+    event = {"name" => check_name, "status" => 2, "output" => "#{self.class.name} CRITICAL: #{msg}", "handlers" => config[:handlers]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_unknown(check_name, msg)
+    event = {"name" => check_name, "status" => 3, "output" => "#{self.class.name} UNKNOWN: #{msg}", "handlers" => config[:handlers]}
+    send_client_socket(event.to_json)
+  end
+
+  def get_uptime()
+    res = @client.query("SHOW GLOBAL STATUS LIKE 'Uptime'")
+    res.first['Value'].to_i
+  end
+
+  def get_threads_connected()
+    res = @client.query("SHOW GLOBAL STATUS LIKE 'Threads_connected'")
+    res.first['Value'].to_i
+  end
+
+  def get_max_connections_setting()
+    res = @client.query("SHOW VARIABLES LIKE 'max_connections'")
+    res.first['Value'].to_i
+  end
+
+  def get_max_used_connections()
+    res = @client.query("SHOW GLOBAL STATUS LIKE 'Max_used_connections'")
+    res.first['Value'].to_i
+  end
+
+  def get_slave_status()
+    res = @client.query("SHOW SLAVE STATUS")
+    res.first
+  end
+
+  def run
+    check_name = "mysql-active_connections"
+    threads_connected = get_threads_connected()
+    max_connections = get_max_connections_setting()
+    if threads_connected >= config[:crit_conn] * max_connections / 100
+      send_critical(check_name, "Too many active connections - Current: #{threads_connected} (>= #{config[:crit_conn] * max_connections / 100})")
+    elsif threads_connected >= config[:warn_conn] * max_connections / 100
+      send_warning(check_name, "High number of active connections - Current: #{threads_connected} (>= #{config[:warn_conn] * max_connections / 100})")
+    else
+      send_ok(check_name, "#{threads_connected} active connections (< #{config[:warn_conn] * max_connections / 100})")
+    end
+
+    check_name = "mysql-max_used_connections"
+    max_used = get_max_used_connections() 
+    if max_used >= config[:crit_conn] * max_connections / 100
+      send_warning(check_name, "MySQL server max used connections reached #{max_used} (>= #{config[:crit_conn] * max_connections / 100})")
+    else
+      send_ok(check_name, "MySQL server max used connections is #{max_used} (< #{config[:crit_conn] * max_connections / 100})")
+    end
+
+    # is replication enabled?
+    slave = get_slave_status()
+    if slave.has_key?('Slave_IO_Running')
+      check_name = "mysql-slave-io_thread"
+      if slave['Slave_IO_Running'].downcase != 'yes'
+        send_critical(check_name, "MySQL slave IO thread not running (Errno: #{slave['Last_IO_Errno']}, Error: #{slave['Last_IO_Error']})")
+      else
+        send_ok(check_name, "MySQL slave IO thread is running")
+      end
+    end
+
+    if slave.has_key?('Slave_SQL_Running')
+      check_name = "mysql-slave-sql_thread"
+      if slave['Slave_SQL_Running'].downcase != 'yes'
+        send_critical(check_name, "MySQL slave SQL thread not running (Errno: #{slave['Last_SQL_Errno']}, Error: #{slave['Last_SQL_Error']})")
+      else
+        send_ok(check_name, "MySQL slave SQL thread is running")
+      end
+    end
+
+    if slave.has_key?('Last_Errno')
+      check_name = "mysql-slave-last_errno"
+      if slave['Last_Errno'] != 0
+        send_critical(check_name, "MySQL slave replication has failed with #{slave['Last_errno']} error (#{slave['Last_Error']})")
+      else
+        send_ok(check_name, "MySQL slave replication has no errors")
+      end
+    end
+
+    if slave.has_key?('Seconds_Behind_Master')
+      check_name = "mysql-slave-lag"
+      msg = "MySQL slave replication is #{slave['Seconds_Behind_Master']}s behind master"
+      if slave['Seconds_Behind_Master'] >= config[:crit_slave_lag]
+        send_critical(check_name, "#{msg} (>= #{config[:crit_slave_lag]}s)")
+      elsif slave['Seconds_Behind_Master'] >= config[:warn_slave_lag]
+        send_warning(check_name, "#{msg} (>= #{config[:warn_slave_lag]}s)")
+      else
+        send_ok(check_name, "MySQL slave replication is in sync")
+      end
+    end
+
+    uptime = get_uptime()
+    if uptime <= config[:uptime]
+      warning("MySQL server restarted #{uptime}s ago")
+    end
+
+    ok("MySQL server is running")
+  end
+end

data/lib/sensu-plugins-mysql-checks/version.rb

@@ -0,0 +1,9 @@
+module SensuPluginsMySQLChecks
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/sensu-plugins-mysql-checks.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-mysql-checks/version'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-mysql-checks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: This plugin provides facilities for monitoring MySQL
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-mysql.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-mysql.rb
+- lib/sensu-plugins-mysql-checks.rb
+- lib/sensu-plugins-mysql-checks/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-mysql-checks
+licenses:
+- MIT
+metadata:
+  maintainer: "@m4ce"
+  development_status: active
+  production_status: stable
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for monitoring MySQL
+test_files: []