Merge pull request #4 from eheydrick/headers

Standardize headers

Author: tas50

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'

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'

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'

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'

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'

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'

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'

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'

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'