sensu-plugins-mysql-boutetnico 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 146f44e13b444f45ee61db8098eb3b3062dbef74
+  data.tar.gz: 8516156a74fc97731a1ad5c2d04c1663f9d75c64
+SHA512:
+  metadata.gz: 15df20ea87d2e4dc6ac85f2a93ef8de7eebf00d4c733684f8c5a10bf0b3950ee7f7ea195dca3485edf4db81170187f2d5b2f2c9e01f89887ac42c0c5ee63b0a7
+  data.tar.gz: 1b63f91ac45984154d8a4c6873ff7d4b0d2e5409a9547daf9fbe6a85d0b7b5998fc74dce1af1613b813bcf803a54cc0d38fb18636583b97990db44a81f208c80

data/CHANGELOG.md

@@ -0,0 +1 @@
+Can be found at [https://github.com/boutetnico/sensu-plugins-mysql/releases](https://github.com/boutetnico/sensu-plugins-mysql/releases).

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+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,161 @@
+## Sensu-Plugins-mysql
+
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-mysql-boutetnico.svg)](https://badge.fury.io/rb/sensu-plugins-mysql-boutetnico.svg)
+[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/boutetnico/sensu-plugins-mysql)
+
+## This is an unofficial fork
+
+This fork is automatically tested, built and published to [RubyGems](https://rubygems.org/gems/sensu-plugins-mysql-boutetnico/) and [Bonsai](https://bonsai.sensu.io/assets/boutetnico/sensu-plugins-mysql).
+
+## Files
+ * bin/check-cloudwatch-mysql-sensu.rb
+ * bin/check-mysql-alive.rb
+ * bin/check-mysql-status.rb
+ * bin/check-mysql-connections.rb
+ * bin/check-mysql-disk.rb
+ * bin/check-mysql-innodb-lock.rb
+ * bin/check-mysql-threads.rb
+ * bin/check-mysql-query-result-count.rb
+ * bin/check-mysql-select-count.rb
+ * bin/check-mysql-msr-replication-status.rb
+ * bin/metrics-mysql-graphite.rb
+ * bin/metrics-mysql-multiple-select-count.rb
+ * bin/metrics-mysql-processes.rb
+ * bin/metrics-mysql-raw.rb
+ * bin/metrics-mysql.rb
+ * bin/metrics-mysql-query-result-count.rb
+ * bin/metrics-mysql-select-count.rb
+ * bin/mysql-metrics.sql
+
+## Usage
+**metrics-mysql**
+```
+{
+    "mysql":{
+        "hostname": "localhost",
+        "username": "sensu_user",
+        "password": "sensu_user_pass"
+    }
+}
+```
+
+**metrics-mysql-graphite** example:
+```bash
+/opt/sensu/embedded/bin$ /opt/sensu/embedded/bin/ruby metrics-mysql-graphite.rb --host=localhost --port=3306 --user=collectd --pass=tflypass --socket=/data/mysql.sock
+```
+
+**check-mysql-connections** example
+```bash
+/opt/sensu/embedded/bin$ /opt/sensu/embedded/bin/ruby check-mysql-connections.rb --host=localhost --port=3306 --user=collectd --pass=tflypass --socket=/data/mysql.sock
+```
+
+**check-mysql-connections** example with ini file to hide credentials
+```bash
+$ /opt/sensu/embedded/bin/check-mysql-connections.rb --host=<DBHOST> --ini=/etc/sensu/my.ini
+```
+
+**check-mysql-alive** example
+```bash
+$ /opt/sensu/embedded/bin/check-mysql-alive.rb --host=<DBHOST> --ini=/etc/sensu/my.ini --ini-section=customsection
+```
+
+**check-mysql-disk** example (note: you must supply max disk size)
+```bash
+$ /opt/sensu/embedded/bin/check-mysql-disk.rb --host=<DBHOST> --ini=/etc/sensu/my.ini --size <MAX_DB_SIZE>
+```
+
+**check-mysql-innodb-lock** example
+```bash
+$ /opt/sensu/embedded/bin/check-mysql-innodb-lock.rb --host=<DBHOST> --ini=/etc/sensu/my.ini
+```
+
+**check-mysql-threads** example
+```bash
+$ /opt/sensu/embedded/bin/check-mysql-threads.rb --host=<DBHOST> --ini=/etc/sensu/my.ini --warnlow 0
+```
+
+**check-mysql-replication-status** example
+```bash
+$ /opt/sensu/embedded/bin/check-mysql-replication-status.rb --host=<SLAVE> --ini=/etc/sensu/my.ini
+```
+
+**check-mysql-msr-replication-status** example
+```bash
+$ /opt/sensu/embedded/bin/check-mysql-replication-status.rb --host=<SLAVE> --ini=/etc/sensu/my.ini
+```
+
+**check-mysql-query-result-count** example
+```bash
+/opt/sensu/embedded/bin$ /opt/sensu/embedded/bin/ruby check-mysql-query-result-count.rb --host=localhost --port=3306 --user=collectd --pass=tflypass --socket=/data/mysql.sock --warning 1 --critical 10 --query 'SELECT DISTINCT(t.id) FROM table t where t.failed = true'
+```
+
+**check-mysql-select-count** example
+```bash
+/opt/sensu/embedded/bin$ /opt/sensu/embedded/bin/ruby check-mysql-select-count.rb --host=localhost --port=3306 --user=collectd --pass=tflypass --socket=/data/mysql.sock --warning 30000 --critical 50000 --query 'SELECT count(*) FROM table t'
+```
+
+**metrics-mysql-query-result-count** example
+```bash
+/opt/sensu/embedded/bin$ /opt/sensu/embedded/bin/ruby metrics-mysql-query-result-count.rb --host=localhost --port=3306 --user=collectd --pass=tflypass --socket=/data/mysql.sock --query 'SELECT DISTINCT(t.id) FROM table t where t.failed = true'
+```
+
+**metrics-mysql-select-count** example
+```bash
+/opt/sensu/embedded/bin$ /opt/sensu/embedded/bin/ruby metrics-mysql-select-count.rb --host=localhost --port=3306 --user=collectd --pass=tflypass --socket=/data/mysql.sock --query 'SELECT COUNT(*) FROM table t'
+```
+
+**metrics-mysql-multiple-select-count** example
+```bash
+/opt/sensu/embedded/bin$ /opt/sensu/embedded/bin/metrics-mysql-multiple-select-count.rb --host=localhost --port=3306 --user=collectd --pass=tflypass --socket=/data/mysql.sock --query '{"t1_count":"SELECT COUNT(*) FROM table t1", "t2_count":"SELECT COUNT(*) FROM table t2"}'
+```
+### Security
+
+In keeping with the principle of least privilege you should create a new user with the minimum required permissions. See the table below for minimum permissions for each check.
+
+| Check                                  | Permissions                                               |
+|:---------------------------------------|:----------------------------------------------------------|
+| check-mysql-alive.rb                   | `SELECT`                                                  |
+| check-mysql-connections.rb             | `SELECT`                                                  |
+| check-mysql-disk.rb                    | `SELECT`                                                  |
+| check-mysql-innodb-lock.rb             | `PROCESS`                                                 |
+| check-mysql-query-result-count.rb      | depends on query                                          |
+| check-mysql-select-count.rb            | `SELECT`                                                  |
+| check-mysql-replication-status.rb      | `SUPER` OR `REPLICATION_CLIENT` (the latter is preferable)|
+| check-mysql-msr-replication-status.rb  | `SELECT`                                                  |
+| check-mysql-status.rb                  | `SELECT`                                                  |
+| check-mysql-threads.rb                 | `SELECT`                                                  |
+| metrics-mysql-graphite.rb              | `SELECT`                                                  |
+| metrics-mysql-processes.rb             | `SELECT`                                                  |
+| metrics-mysql-query-result-count.rb    | depends on query                                          |
+| metrics-mysql-select-count.rb          | depends on query                                          |
+| metrics-mysql-multiple-select-count    | depends on query                                          |
+| metrics-mysql-raw.rb                   | `SELECT`                                                  |
+| metrics-mysql.rb                       | `INSERT` into `sensumetrics.sensu_historic_metrics`       |
+
+I would recommend using different users when you need to have more than RO access (`REPLICATION_CLIENT` or using the metrics handler) to limit the potential ramifications of that user being compromised.
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes
+The ruby executables are install in path similar to `/opt/sensu/embedded/lib/ruby/gems/2.0.0/gems/sensu-plugins-mysql-0.0.4/bin`
+
+## Troubleshooting
+When used in `chef`, if the dependencies are missing, an error may abort the chef-client run:
+```bash
+*** extconf.rb failed ***
+Could not create Makefile due to some reason, probably lack of
+necessary libraries and/or headers.  Check the mkmf.log file for more
+details.  You may need configuration options.
+```
+This may be fixed by installing the mysql client library before the plugin:
+```ruby
+# http://serverfault.com/questions/415392/install-mysql-gem-for-use-in-chef-client
+package "libmysqlclient-dev" do
+  action :install
+end
+
+sensu_gem 'sensu-plugins-mysql' do version '0.0.4' end
+
+```

data/bin/check-mysql-alive.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+#
+# MySQL Alive Plugin
+# ===
+#
+# This plugin attempts to login to mysql with provided credentials.
+#
+# Copyright 2011 Joe Crim <josephcrim@gmail.com>
+# Updated by Lewis Preson 2012 to accept a database parameter
+# 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'
+#     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 CheckMySQL < Sensu::Plugin::Check::CLI
+  option :user,
+         description: 'MySQL User',
+         short: '-u USER',
+         long: '--user USER'
+
+  option :password,
+         description: 'MySQL Password',
+         short: '-p PASS',
+         long: '--password PASS'
+
+  option :ini,
+         description: 'My.cnf ini file',
+         short: '-i VALUE',
+         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'
+
+  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'
+
+  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[:password]
+    end
+
+    begin
+      db = Mysql.real_connect(config[:hostname], db_user, db_pass, config[:database], config[:port].to_i, config[:socket])
+      info = db.get_server_info
+      ok "Server version: #{info}"
+    rescue Mysql::Error => e
+      critical "Error message: #{e.error}"
+    ensure
+      db.close if db
+    end
+  end
+end

data/bin/check-mysql-connections.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+#
+# MySQL Health Plugin
+# ===
+#
+# This plugin counts the maximum connections your MySQL has reached and warns you according to specified limits
+#
+# Copyright 2012 Panagiotis Papadomitsos <pj@ezgr.net>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu-plugin/check/cli'
+require 'mysql'
+require 'inifile'
+
+class CheckMySQLHealth < 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'
+
+  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 :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 :maxwarn,
+         description: "Number of connections upon which we'll issue a warning",
+         short: '-w NUMBER',
+         long: '--warnnum NUMBER',
+         default: 100
+
+  option :maxcrit,
+         description: "Number of connections upon which we'll issue an alert",
+         short: '-c NUMBER',
+         long: '--critnum NUMBER',
+         default: 128
+
+  option :usepc,
+         description: 'Use percentage of defined max connections instead of absolute number',
+         short: '-a',
+         long: '--percentage',
+         default: false
+
+  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[:password]
+    end
+    db = Mysql.real_connect(config[:hostname], db_user, db_pass, config[:database], config[:port].to_i, config[:socket])
+    max_con = db
+              .query("SHOW VARIABLES LIKE 'max_connections'")
+              .fetch_hash
+              .fetch('Value')
+              .to_i
+    used_con = db
+               .query("SHOW GLOBAL STATUS LIKE 'Threads_connected'")
+               .fetch_hash
+               .fetch('Value')
+               .to_i
+    if config[:usepc]
+      pc = used_con.fdiv(max_con) * 100
+      critical "Max connections reached in MySQL: #{used_con} out of #{max_con}" if pc >= config[:maxcrit].to_i
+      warning "Max connections reached in MySQL: #{used_con} out of #{max_con}" if pc >= config[:maxwarn].to_i
+      ok "Max connections is under limit in MySQL: #{used_con} out of #{max_con}" # rubocop:disable Style/IdenticalConditionalBranches
+    else
+      critical "Max connections reached in MySQL: #{used_con} out of #{max_con}" if used_con >= config[:maxcrit].to_i
+      warning "Max connections reached in MySQL: #{used_con} out of #{max_con}" if used_con >= config[:maxwarn].to_i
+      ok "Max connections is under limit in MySQL: #{used_con} out of #{max_con}" # rubocop:disable Style/IdenticalConditionalBranches
+    end
+  rescue Mysql::Error => e
+    critical "MySQL check failed: #{e.error}"
+  ensure
+    db.close if db
+  end
+end

data/bin/check-mysql-disk.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+#
+# MySQL Disk Usage Check
+# ===
+#
+# Copyright 2011 Sonian, Inc <chefs@sonian.net>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+#
+# Check the size of the database and compare to crit and warn thresholds
+
+require 'sensu-plugin/check/cli'
+require 'mysql'
+require 'inifile'
+
+class CheckMysqlDisk < Sensu::Plugin::Check::CLI
+  option :host,
+         short: '-h',
+         long: '--host=VALUE',
+         description: 'Database host'
+
+  option :user,
+         short: '-u',
+         long: '--username=VALUE',
+         description: 'Database username'
+
+  option :pass,
+         short: '-p',
+         long: '--password=VALUE',
+         description: 'Database password'
+
+  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 :size,
+         short: '-s',
+         long: '--size=VALUE',
+         description: 'Database size',
+         proc: proc(&:to_f),
+         required: true
+
+  option :warn,
+         short: '-w',
+         long: '--warning=VALUE',
+         description: 'Warning threshold',
+         proc: proc(&:to_f),
+         default: 85
+
+  option :crit,
+         short: '-c',
+         long: '--critical=VALUE',
+         description: 'Critical threshold',
+         proc: proc(&:to_f),
+         default: 95
+
+  option :port,
+         description: 'Port to connect to',
+         short: '-P PORT',
+         long: '--port PORT',
+         proc: proc(&:to_i),
+         default: 3306
+
+  option :socket,
+         description: 'Socket to use',
+         short: '-S SOCKET',
+         long: '--socket SOCKET',
+         default: nil
+
+  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]
+    disk_size = config[:size]
+    critical_usage = config[:crit]
+    warning_usage = config[:warn]
+
+    if [db_host, db_user, db_pass, disk_size].any?(&:nil?)
+      unknown 'Must specify host, user, password and size'
+    end
+
+    begin
+      total_size = 0.0
+      db = Mysql.real_connect(config[:host], db_user, db_pass, nil, config[:port], config[:socket])
+
+      results = db.query <<-SQL
+        SELECT table_schema,
+        count(*) TABLES,
+        concat(round(sum(table_rows)/1000000,2),'M') rows,
+        round(sum(data_length)/(1024*1024*1024),2) DATA,
+        round(sum(index_length)/(1024*1024*1024),2) idx,
+        round(sum(data_length+index_length)/(1024*1024*1024),2) total_size,
+        round(sum(index_length)/sum(data_length),2) idxfrac
+        FROM information_schema.TABLES group by table_schema
+      SQL
+
+      unless results.nil?
+        results.each_hash do |row|
+          # #YELLOW
+          total_size = total_size + row['total_size'].to_f # rubocop:disable Style/SelfAssignment
+        end
+      end
+
+      disk_use_percentage = total_size / disk_size * 100
+      diskstr = "DB size: #{total_size}, disk use: #{disk_use_percentage}%"
+
+      if disk_use_percentage > critical_usage
+        critical "Database size exceeds critical threshold: #{diskstr}"
+      elsif disk_use_percentage > warning_usage
+        warning "Database size exceeds warning threshold: #{diskstr}"
+      else
+        ok diskstr
+      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 e
+    ensure
+      db.close if db
+    end
+  end
+end