sensu-plugins-postgres 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb32b29fe582ff05c9d25ce34b2d237bfc8dde4c
-  data.tar.gz: 801c70d64604e479a9c23fe384307d1a5fb17c51
+  metadata.gz: 7432563f70c59b745e34559e6d58844600a547b1
+  data.tar.gz: fbfd4cdbd878c065217450e3eb55f1bcf88f72e7
 SHA512:
-  metadata.gz: 80e5108376f6092b232006ba414756c9c2b12097d6cd9d5e47d1687232a1040135e842a147158ce286d43b1658f394dc343e92efe0e3b77e5a9b286093eb74b9
-  data.tar.gz: 723f595792aac689aadea338989456775c874d7d7af0cc49238bd76ad63eca4dc70c17ee9ae53e0b3154daf585c678cbd3df8f69a0551bec4d4f1e9633e59972
+  metadata.gz: ac24ac7ab6da0069be23a23fb2b5b73372be1c97da058c18c86730cff23bce6fd3707be6fb8f0ab116ba7b1fde6880acf563111d951b6396ab11e6af635bb18c
+  data.tar.gz: 46cb43f2a13a044a0f8e86c7bd4d2ac7567784ce83e6cb7ae5b42cd659e5a841dc5c58cbb71d1293e15981ee49f926b7411e9e92594352b4a47c1b5df8d66005

data/CHANGELOG.md

@@ -3,12 +3,17 @@ 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.6] - 2015-10-08
+### Changed
+- standardized headers
+
+### Added
+- added plugins for querying postgres
 
 ## [0.0.5] - 2015-10-06
 ### Changed
 - updated pg gem to 0.18.3
-Added port cli option to postgres-graphite.rb.
+- Added port cli option to postgres-graphite.rb.
 
 ## [0.0.4] - 2015-08-04
 ### Changed

data/README.md

@@ -20,6 +20,8 @@
  * bin/metric-postgres-connections.rb
  * bin/metric-postgres-locks.rb
  * bin/metric-postgres-statsio.rb
+ * bin/check-postgres-query.rb
+ * bin/metrics-postgres-query.rb
 
 ## Usage
 

data/bin/check-postgres-alive.rb

@@ -1,13 +1,31 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
-# Postgres Alive Plugin
+#   check-postgres-alive
 #
-# This plugin attempts to login to postgres with provided credentials.
+# DESCRIPTION:
 #
-# Copyright 2012 Lewis Preson & Tom Bassindale
+#   This plugin attempts to login to postgres with provided credentials.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./check-postgres-alive.rb -u db_user -p db_pass -h db_host -d db
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright (c) 2012 Lewis Preson & Tom Bassindale
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 #
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
 
 require 'sensu-plugin/check/cli'
 require 'pg'

data/bin/check-postgres-query.rb

@@ -0,0 +1,114 @@
+#! /usr/bin/env ruby
+#
+# check-postgres-query
+#
+# DESCRIPTION:
+#   This plugin queries a PostgreSQL database. It alerts when the numeric
+#   result hits a threshold. Can optionally alert on the number of tuples
+#   (rows) returned by the query.
+#
+# OUTPUT:
+#   plain-text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: pg
+#   gem: sensu-plugin
+#   gem: dentaku
+#
+# USAGE:
+#   check-postgres-query.rb -u db_user -p db_pass -h db_host -d db -q 'select foo from bar' -w 'value > 5' -c 'value > 10'
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2015, Eric Heydrick <eheydrick@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'pg'
+require 'dentaku'
+
+# Check PostgresSQL Query
+class CheckPostgresQuery < Sensu::Plugin::Check::CLI
+  option :user,
+         description: 'Postgres User',
+         short: '-u USER',
+         long: '--user USER'
+
+  option :password,
+         description: 'Postgres Password',
+         short: '-p PASS',
+         long: '--password PASS'
+
+  option :hostname,
+         description: 'Hostname to login to',
+         short: '-h HOST',
+         long: '--hostname HOST',
+         default: 'localhost'
+
+  option :port,
+         description: 'Database port',
+         short: '-P PORT',
+         long: '--port PORT',
+         default: 5432
+
+  option :db,
+         description: 'Database name',
+         short: '-d DB',
+         long: '--db DB',
+         default: 'postgres'
+
+  option :query,
+         description: 'Database query to execute',
+         short: '-q QUERY',
+         long: '--query QUERY',
+         required: true
+
+  option :check_tuples,
+         description: 'Check against the number of tuples (rows) returned by the query',
+         short: '-t',
+         long: '--tuples',
+         boolean: true,
+         default: false
+
+  option :warning,
+         description: 'Warning threshold expression',
+         short: '-w WARNING',
+         long: '--warning WARNING',
+         default: nil
+
+  option :critical,
+         description: 'Critical threshold expression',
+         short: '-c CRITICAL',
+         long: '--critical CRITICAL',
+         default: nil
+
+  def run
+    begin
+      con = PG::Connection.new(config[:hostname], config[:port], nil, nil, config[:db], config[:user], config[:password])
+      res = con.exec("#{config[:query]}")
+    rescue PG::Error => e
+      unknown "Unable to query PostgreSQL: #{e.message}"
+    end
+
+    if config[:check_tuples]
+      value = res.ntuples
+    else
+      value = res.first.values.first.to_f
+    end
+
+    calc = Dentaku::Calculator.new
+    if config[:critical] && calc.evaluate(config[:critical], value: value)
+      critical "Results: #{res.values}"
+    elsif config[:warning] && calc.evaluate(config[:warning], value: value)
+      warning "Results: #{res.values}"
+    else
+      ok 'Query OK'
+    end
+  end
+end

data/bin/check-postgres-replication.rb

@@ -1,4 +1,30 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
+#
+#   check-postgres-replication
+#
+# DESCRIPTION:
+#
+#   This plugin checks postgresql replication lag
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./check-postgres-replication.rb -m master_host -s slave_host -d db -u db_user -p db_pass -w warn_threshold -c crit_threshold
+#
+# NOTES:
+#
+# LICENSE:
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
 
 require 'sensu-plugin/check/cli'
 require 'pg'

data/bin/metric-postgres-connections.rb

@@ -1,18 +1,32 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
-# Postgres Connection Metrics
-# ===
+#   metric-postgres-connections
 #
-# Dependencies
-# -----------
-# - Ruby gem `pg`
+# DESCRIPTION:
 #
+#   This plugin collects postgres connection metrics
 #
-# Copyright 2012 Kwarter, Inc <platforms@kwarter.com>
-# Author Gilles Devaux <gilles.devaux@gmail.com>
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-connections.rb -u db_user -p db_pass -h db_host -d db
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright (c) 2012 Kwarter, Inc <platforms@kwarter.com>
+#   Author Gilles Devaux <gilles.devaux@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 #
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
 
 require 'sensu-plugin/metric/cli'
 require 'pg'

data/bin/metric-postgres-dbsize.rb

@@ -1,18 +1,32 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
-# Postgres DBSize Metrics
-# ===
+#   metric-postgres-dbsize
 #
-# Dependencies
-# -----------
-# - Ruby gem `pg`
+# DESCRIPTION:
 #
+#   This plugin collects postgres database size metrics
 #
-# Copyright 2012 Kwarter, Inc <platforms@kwarter.com>
-# Author Gilles Devaux <gilles.devaux@gmail.com>
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-dbsize.rb -u db_user -p db_pass -h db_host -d db
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright (c) 2012 Kwarter, Inc <platforms@kwarter.com>
+#   Author Gilles Devaux <gilles.devaux@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 #
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
 
 require 'sensu-plugin/metric/cli'
 require 'pg'

data/bin/metric-postgres-graphite.rb

@@ -1,4 +1,30 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
+#
+#   metric-postgres-graphite
+#
+# DESCRIPTION:
+#
+#   This plugin collects postgres replication lag metrics
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-graphite.rb -m master_host -s slave_host -d db -u db_user -p db_pass
+#
+# NOTES:
+#
+# LICENSE:
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
 
 require 'pg'
 require 'sensu-plugin/metric/cli'

data/bin/metric-postgres-locks.rb

@@ -1,18 +1,32 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
-# Postgres Locks Metrics
-# ===
+#   metric-postgres-locks
 #
-# Dependencies
-# -----------
-# - Ruby gem `pg`
+# DESCRIPTION:
 #
+#   This plugin collects postgres database lock metrics
 #
-# Copyright 2012 Kwarter, Inc <platforms@kwarter.com>
-# Author Gilles Devaux <gilles.devaux@gmail.com>
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-locks.rb -u db_user -p db_pass -h db_host -d db
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright (c) 2012 Kwarter, Inc <platforms@kwarter.com>
+#   Author Gilles Devaux <gilles.devaux@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 #
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
 
 require 'sensu-plugin/metric/cli'
 require 'pg'

data/bin/metric-postgres-statsbgwriter.rb

@@ -1,18 +1,32 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
-# Postgres Stat BGWriter Metrics
-# ===
+#   metric-postgres-statsbgwriter
 #
-# Dependencies
-# -----------
-# - Ruby gem `pg`
+# DESCRIPTION:
 #
+#   This plugin collects postgres database bgwriter metrics
 #
-# Copyright 2012 Kwarter, Inc <platforms@kwarter.com>
-# Author Gilles Devaux <gilles.devaux@gmail.com>
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-statsbgwriter.rb -u db_user -p db_pass -h db_host -d db
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright (c) 2012 Kwarter, Inc <platforms@kwarter.com>
+#   Author Gilles Devaux <gilles.devaux@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 #
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
 
 require 'sensu-plugin/metric/cli'
 require 'pg'

data/bin/metric-postgres-statsdb.rb

@@ -1,19 +1,33 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
-# Postgres Stat DB Metrics
-# ===
+#   metric-postgres-statsdb
 #
-# Dependencies
-# -----------
-# - PSQL `track_counts` `track_io_timing` for some metrics enabled
-# - Ruby gem `pg`
+# DESCRIPTION:
 #
+#   This plugin collects postgres database metrics from the pg_stat_database table
 #
-# Copyright 2012 Kwarter, Inc <platforms@kwarter.com>
-# Author Gilles Devaux <gilles.devaux@gmail.com>
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-statsdb.rb -u db_user -p db_pass -h db_host -d db
+#
+# NOTES:
+#   Requires PSQL `track_counts` `track_io_timing` for some metrics enabled
+#
+# LICENSE:
+#   Copyright (c) 2012 Kwarter, Inc <platforms@kwarter.com>
+#   Author Gilles Devaux <gilles.devaux@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 #
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
 
 require 'sensu-plugin/metric/cli'
 require 'pg'

data/bin/metric-postgres-statsio.rb

@@ -1,19 +1,33 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
-# Postgres StatIO Metrics
-# ===
+#   metric-postgres-statsio
 #
-# Dependencies
-# -----------
-# - PSQL `track_io_timing` enabled
-# - Ruby gem `pg`
+# DESCRIPTION:
 #
+#   This plugin collects postgres database IO metrics
 #
-# Copyright 2012 Kwarter, Inc <platforms@kwarter.com>
-# Author Gilles Devaux <gilles.devaux@gmail.com>
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-statsio.rb -u db_user -p db_pass -h db_host -d db -s scope
+#
+# NOTES:
+#   Requires PSQL `track_io_timing` enabled
+#
+# LICENSE:
+#   Copyright (c) 2012 Kwarter, Inc <platforms@kwarter.com>
+#   Author Gilles Devaux <gilles.devaux@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 #
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
 
 require 'sensu-plugin/metric/cli'
 require 'pg'

data/bin/metric-postgres-statstable.rb

@@ -1,19 +1,33 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
-# Postgres Stat Table Metrics
-# ===
+#   metric-postgres-statstable
 #
-# Dependencies
-# -----------
-# - PSQL `track_counts` enabled
-# - Ruby gem `pg`
+# DESCRIPTION:
 #
+#   This plugin collects postgres database metrics from the pg_stat tables
 #
-# Copyright 2012 Kwarter, Inc <platforms@kwarter.com>
-# Author Gilles Devaux <gilles.devaux@gmail.com>
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-statstable.rb -u db_user -p db_pass -h db_host -d db -s scope
+#
+# NOTES:
+#   Requires PSQL `track_counts` enabled
+#
+# LICENSE:
+#   Copyright (c) 2012 Kwarter, Inc <platforms@kwarter.com>
+#   Author Gilles Devaux <gilles.devaux@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 #
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
 
 require 'sensu-plugin/metric/cli'
 require 'pg'

data/bin/metrics-postgres-query.rb

@@ -0,0 +1,98 @@
+#! /usr/bin/env ruby
+#
+# metrics-postgres-query
+#
+# DESCRIPTION:
+#   This plugin collects metrics from the results of a postgres query. Can optionally
+#   count the number of tuples (rows) returned by the query.
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: pg
+#   gem: sensu-plugin
+#
+# USAGE:
+#   metrics-postgres-query.rb -u db_user -p db_pass -h db_server -d db -q 'select foo from bar'
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2015, Eric Heydrick <eheydrick@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'pg'
+
+class MetricsPostgresQuery < Sensu::Plugin::Metric::CLI::Graphite
+  option :user,
+         description: 'Postgres User',
+         short: '-u USER',
+         long: '--user USER'
+
+  option :password,
+         description: 'Postgres Password',
+         short: '-p PASS',
+         long: '--password PASS'
+
+  option :hostname,
+         description: 'Hostname to login to',
+         short: '-h HOST',
+         long: '--hostname HOST',
+         default: 'localhost'
+
+  option :port,
+         description: 'Database port',
+         short: '-P PORT',
+         long: '--port PORT',
+         default: 5432
+
+  option :db,
+         description: 'Database name',
+         short: '-d DB',
+         long: '--db DB',
+         default: 'postgres'
+
+  option :query,
+         description: 'Database query to execute',
+         short: '-q QUERY',
+         long: '--query QUERY',
+         required: true
+
+  option :count_tuples,
+         description: 'Count the number of tuples (rows) returned by the query',
+         short: '-t',
+         long: '--tuples',
+         boolean: true,
+         default: false
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: 'postgres'
+
+  def run
+    begin
+      con = PG::Connection.new(config[:hostname], config[:port], nil, nil, config[:db], config[:user], config[:password])
+      res = con.exec("#{config[:query]}")
+    rescue PG::Error => e
+      unknown "Unable to query PostgreSQL: #{e.message}"
+    end
+
+    if config[:check_tuples]
+      value = res.ntuples
+    else
+      value = res.first.values.first
+    end
+
+    output config[:scheme], value
+    ok
+  end
+end

data/lib/sensu-plugins-postgres/version.rb

@@ -2,7 +2,7 @@ module SensuPluginsPostgres
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 5
+    PATCH = 6
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-postgres
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -60,6 +60,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.18.3
+- !ruby/object:Gem::Dependency
+  name: dentaku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,14 +178,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: 0.34.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: 0.34.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +209,7 @@ description: |-
                                 more.
 email: "<sensu-users@googlegroups.com>"
 executables:
+- metrics-postgres-query.rb
 - metric-postgres-statstable.rb
 - metric-postgres-statsio.rb
 - metric-postgres-statsdb.rb
@@ -204,6 +219,7 @@ executables:
 - metric-postgres-dbsize.rb
 - metric-postgres-connections.rb
 - check-postgres-replication.rb
+- check-postgres-query.rb
 - check-postgres-alive.rb
 extensions: []
 extra_rdoc_files: []
@@ -212,6 +228,7 @@ files:
 - LICENSE
 - README.md
 - bin/check-postgres-alive.rb
+- bin/check-postgres-query.rb
 - bin/check-postgres-replication.rb
 - bin/metric-postgres-connections.rb
 - bin/metric-postgres-dbsize.rb
@@ -221,6 +238,7 @@ files:
 - bin/metric-postgres-statsdb.rb
 - bin/metric-postgres-statsio.rb
 - bin/metric-postgres-statstable.rb
+- bin/metrics-postgres-query.rb
 - lib/sensu-plugins-postgres.rb
 - lib/sensu-plugins-postgres/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-postgres