sensu-plugins-mysql-nagyt 2.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0574e1b596d0d9f104670b489dc9c0fb4c245202572d912f94a9e8f9b140c326
+  data.tar.gz: fbcb7258c7ad529bc7612b2d095ca8e64f87d71e095ea92e1a4618b9105c1647
+SHA512:
+  metadata.gz: 804afcd1f806e4bbb0256301ebe64f46f8252d0c58bdd080785d0adacc9357b5beab64b7cde515118f99c71a4e7101c63613328d170353dee8150205212cdb31
+  data.tar.gz: 206bf05399577f37942c18950aed105b29bec8d6b058005109f41e5ea5baef34488cf1d0c094959e1ba538f437379e7e09be27b1e438a15eeb4514b5f26693dd

data/CHANGELOG.md

@@ -0,0 +1,155 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
+
+## [Unreleased]
+### Added
+- metrics-mysql-select-count.rb script (@nagyt234)
+
+## [2.5.1] - 2018-06-21
+### Fixed
+- check-mysql-alive.rb: allow specifying a value for `-i` (@scones)
+
+## [2.5.0] - 2018-06-12
+### Added
+- metrics-mysql-raw.rb: added `Qcache_free_memory` collection (@alchandia)
+
+## [2.4.0] - 2018-06-4
+### Added
+- Add check-mysql-select-count.rb script (@negachov)
+
+## [2.3.0] - 2018-03-17
+### Added
+- check-mysql-msr-replication-status.rb: new script that helps with monitoring mysql multi-source replication (@ndelic0)
+
+### Changed
+- appeased cops (@majormoses)
+
+## [2.1.1] - 2018-02-07
+### Fixed
+- check-mysql-status.rb: if --socket flag is specified, it overrides config (@tinle)
+
+## [2.2.0] - 2017-11-19
+### Changed
+- check-mysql-alive.rb: Add support for custom section in inifile. (@oba11)
+- check-mysql-connections.rb: Add support for custom section in inifile. (@oba11)
+- check-mysql-disk.rb: Add support for custom section in inifile. (@oba11)
+- check-mysql-innodb-lock.rb: Add support for custom section in inifile. (@oba11)
+- check-mysql-query-result-count.rb: Add support for custom section in inifile. (@oba11)
+- check-mysql-replication-status.rb: Add support for custom section in inifile. (@oba11)
+- check-mysql-status.rb: Add support for custom section in inifile. (@oba11)
+- check-mysql-threads.rb: Add support for custom section in inifile. (@oba11)
+- metrics-mysql-graphite.rb: Add support for custom section in inifile. (@oba11)
+- metrics-mysql-processes.rb: Add support for custom section in inifile. (@oba11)
+- metrics-mysql-query-result-count.rb: Add support for custom section in inifile. (@oba11)
+- metrics-mysql-raw.rb: Add support for custom section in inifile. (@oba11)
+- README.md: update useage to have an example using the custom ini section (@majormoses)
+- update changelog guidelines location (@majormoses)
+
+### Fixed
+- misc spelling and whitespace (@majormoses)
+
+## [2.1.2] - 2017-10-04
+### Changed
+- In `README` clarify why they should not use privileged users for monitoring with sensu. (@majormoses)
+- In `README` add more usage examples. (@rwillmer)
+
+### Fixed
+- check-mysql-disk.rb: fixed short option `-s` to `-S` for `--socket` as it conflicted with `--size` (@2autunni)
+
+## [2.1.1] - 2017-06-25
+### Added
+- Added minimum viable permissions in `README` for all the checks, metrics, and handlers. (@majormoses)
+
+### Fixed
+- check-mysql-disk.rb: make required options required. (@majormoses)
+
+### Changed
+- check-mysql-disk.rb: misc changes on where option output is cast. (@majormoses)
+
+## [2.1.0] - 2017-06-10
+### Added
+- metrics-mysql-query-result-count.rb: Creates a graphite-formatted metric for the length of a result set from a MySQL query. (@athal7)
+
+## [2.0.0] - 2017-06-05
+### Breaking Change
+- check-mysql-status.rb: renamed short arg of `--check` due to conflicts (@majormoses)
+
+### Changed
+- check-mysql-status.rb: made the options easier to read by splitting them across multiple lines (@majormoses)
+
+### Added
+- Add testing on Ruby 2.4 (@eheydrick)
+
+## [1.2.1] - 2017-05-03
+### Fixed
+- Fix configuration for check-mysql-query-result-count.rb script (@athal7)
+
+## [1.2.0] - 2017-03-23
+- Add check-mysql-query-result-count.rb script (@athal7)
+
+## [1.1.0] - 2017-01-15
+### Added
+- Added minimum thresholds to the check-mysql-threads.rb script
+- Added metrics plugin with mysql gem requirement
+- Added metrics plugin metrics-mysql-processes from `SHOW PROCESSLIST`
+- Added fallback plugin check-mysql-status.rb with no mysql gem requirement - status and replication
+- Added multi source replication parameter on check-mysql-replication-status.rb
+
+### Fixed
+- metrics-mysql-graphite.rb: Properly close mysql connection
+
+## [1.0.0] - 2016-08-15
+### Added
+- added check-mysql-threads.rb script
+- changed metrics-mysql-graphite.rb to use mysql / ruby-mysql gem
+
+### Changed
+- Removed compatibility with Ruby 1.9
+- Updated sensu-plugin dependency from `= 1.2.0` to `~> 1.2`
+- removed --help option as it comes from opt parser
+
+### Removed
+- check-cloudwatch-mysql-sensu.rb - sensu-plugins-aws check-cloudwatch-metric.rb should be used
+
+## [0.0.4] - 2015-08-04
+### Changed
+- updated sensu-plugin gem to 1.2.0
+
+## [0.0.3] - 2015-07-14
+### Changed
+- updated sensu-plugin gem to 1.2.0
+
+### Added
+- ability to read configuration data from an ini file
+
+## [0.0.2] - 2015-06-03
+### Fixed
+- added binstubs
+
+### Changed
+- removed cruft from /lib
+
+## 0.0.1 - 2015-05-29
+### Added
+- initial release
+
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.5.1...HEAD
+[2.5.1]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.5.0...2.5.1
+[2.5.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.4.0...2.5.0
+[2.4.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.3.0...2.4.0
+[2.3.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.2.1...2.3.0
+[2.2.1]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.2.0..2.2.1
+[2.2.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.1.1...2.2.0
+[2.1.2]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.1.1...2.1.2
+[2.1.1]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.1.0...2.1.1
+[2.1.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/2.0.0...2.1.0
+[2.0.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/1.2.1...2.0.0
+[1.2.1]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/1.2.0...1.2.1
+[1.2.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/1.1.0...1.2.0
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/1.0.0...1.1.0
+[1.0.0]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/0.0.4...1.0.0
+[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/0.0.3...0.0.4
+[0.0.3]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-mysql/compare/0.0.1...0.0.2

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,156 @@
+## Sensu-Plugins-mysql
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-mysql.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-mysql)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-mysql.svg)](http://badge.fury.io/rb/sensu-plugins-mysql)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mysql/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mysql)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mysql/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mysql)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-mysql.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-mysql)
+
+## Functionality
+
+## 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-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'
+```
+
+### 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-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