sensu-plugins-postgres-mrtrotl 4.3.1

data/bin/metric-postgres-locks.rb

@@ -0,0 +1,114 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   metric-postgres-locks
+#
+# DESCRIPTION:
+#
+#   This plugin collects postgres database lock metrics
+#
+# 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.
+#
+
+require 'sensu-plugins-postgres/pgpass'
+require 'sensu-plugin/metric/cli'
+require 'pg'
+require 'socket'
+
+class PostgresStatsDBMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :pgpass,
+         description: 'Pgpass file',
+         short: '-f FILE',
+         long: '--pgpass',
+         default: ENV['PGPASSFILE'] || "#{ENV['HOME']}/.pgpass"
+
+  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'
+
+  option :port,
+         description: 'Database port',
+         short: '-P PORT',
+         long: '--port PORT'
+
+  option :database,
+         description: 'Database name',
+         short: '-d DB',
+         long: '--db DB'
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to $queue_name.$metric',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.postgresql"
+
+  option :timeout,
+         description: 'Connection timeout (seconds)',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: 10,
+         proc: proc(&:to_i)
+
+  include Pgpass
+
+  def run
+    timestamp = Time.now.to_i
+
+    locks_per_type = Hash.new(0)
+    pgpass
+    con = PG.connect(host: config[:hostname],
+                     dbname: config[:database],
+                     user: config[:user],
+                     password: config[:password],
+                     port: config[:port],
+                     connect_timeout: config[:timeout])
+    request = [
+      'SELECT mode, count(mode) AS count FROM pg_locks',
+      "WHERE database = (SELECT oid FROM pg_database WHERE datname = '#{config[:database]}')",
+      'GROUP BY mode'
+    ]
+
+    con.exec(request.join(' ')) do |result|
+      result.each do |row|
+        lock_name = row['mode'].downcase.to_sym
+        locks_per_type[lock_name] = row['count']
+      end
+    end
+
+    locks_per_type.each do |lock_type, count|
+      output "#{config[:scheme]}.locks.#{config[:database]}.#{lock_type}", count, timestamp
+    end
+
+    ok
+  end
+end

data/bin/metric-postgres-relation-size.rb

@@ -0,0 +1,119 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#  metrics-postgres-relation-size.rb
+# DESCRIPTION:
+#
+#   This plugin finds the total size of the largest tables.
+#
+#   https://www.postgresql.org/docs/current/functions-admin.html#FUNCTIONS-ADMIN-DBOBJECT
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-relation-size.rb -u db_user -p db_pass -h db_host -d db
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright (c) 2020 Airbrake Technologies, Inc <support@airbrake.io>
+#   Author Patrick Humpal <patrick@netvilla.net>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugins-postgres/pgpass'
+require 'sensu-plugin/metric/cli'
+require 'pg'
+require 'socket'
+
+class PostgresStatsDBMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :pgpass,
+         description: 'Pgpass file',
+         short: '-f FILE',
+         long: '--pgpass',
+         default: ENV['PGPASSFILE'] || "#{ENV['HOME']}/.pgpass"
+
+  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'
+
+  option :port,
+         description: 'Database port',
+         short: '-P PORT',
+         long: '--port PORT'
+
+  option :database,
+         description: 'Database name',
+         short: '-d DB',
+         long: '--db DB'
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to $queue_name.$metric',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.postgresql"
+
+  option :timeout,
+         description: 'Connection timeout (seconds)',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: 10,
+         proc: proc(&:to_i)
+
+  option :limit,
+         description: 'Limit query to this many results',
+         short: '-L LIMIT',
+         login: '--limit LIMIT',
+         default: 25
+
+  include Pgpass
+
+  def run
+    timestamp = Time.now.to_i
+    pgpass
+    con = PG.connect(host: config[:hostname],
+                     dbname: config[:database],
+                     user: config[:user],
+                     password: config[:password],
+                     port: config[:port],
+                     connect_timeout: config[:timeout])
+
+    # https://wiki.postgresql.org/wiki/Disk_Usage
+    request = [
+      "SELECT nspname || '.' || relname AS relation,
+       pg_total_relation_size(C.oid) AS total_size
+       FROM pg_class C
+       LEFT JOIN pg_namespace N on (N.oid = C.relnamespace)
+       WHERE nspname NOT IN ('pg_catalog', 'information_schema')
+       ORDER BY pg_total_relation_size(C.oid) DESC
+       LIMIT '#{config[:limit]}'"
+    ]
+
+    con.exec(request.join(' ')) do |result|
+      result.each do |row|
+        output "#{config[:scheme]}.size.#{config[:database]}.#{row['relation']}", row['total_size'], timestamp
+      end
+    end
+
+    ok
+  end
+end

data/bin/metric-postgres-statsbgwriter.rb

@@ -0,0 +1,113 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   metric-postgres-statsbgwriter
+#
+# DESCRIPTION:
+#
+#   This plugin collects postgres database bgwriter metrics
+#
+# 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.
+#
+
+require 'sensu-plugins-postgres/pgpass'
+require 'sensu-plugin/metric/cli'
+require 'pg'
+require 'socket'
+
+class PostgresStatsDBMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :pgpass,
+         description: 'Pgpass file',
+         short: '-f FILE',
+         long: '--pgpass',
+         default: ENV['PGPASSFILE'] || "#{ENV['HOME']}/.pgpass"
+
+  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'
+
+  option :port,
+         description: 'Database port',
+         short: '-P PORT',
+         long: '--port PORT'
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to $queue_name.$metric',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.postgresql"
+
+  option :timeout,
+         description: 'Connection timeout (seconds)',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: 10,
+         proc: proc(&:to_i)
+
+  include Pgpass
+
+  def run
+    timestamp = Time.now.to_i
+    pgpass
+    con = PG.connect(host: config[:hostname],
+                     dbname: 'postgres',
+                     user: config[:user],
+                     password: config[:password],
+                     port: config[:port],
+                     connect_timeout: config[:timeout])
+    request = [
+      'select checkpoints_timed, checkpoints_req,',
+      'checkpoint_write_time, checkpoint_sync_time,',
+      'buffers_checkpoint, buffers_clean,',
+      'maxwritten_clean, buffers_backend, buffers_backend_fsync',
+      'buffers_alloc',
+      'from pg_stat_bgwriter'
+    ]
+    con.exec(request.join(' ')) do |result|
+      result.each do |row|
+        output "#{config[:scheme]}.bgwriter.checkpoints_timed", row['checkpoints_timed'], timestamp
+        output "#{config[:scheme]}.bgwriter.checkpoints_req", row['checkpoints_req'], timestamp
+        output "#{config[:scheme]}.bgwriter.checkpoints_write_time", row['checkpoint_write_time'], timestamp
+        output "#{config[:scheme]}.bgwriter.checkpoints_sync_time", row['checkpoint_sync_time'], timestamp
+        output "#{config[:scheme]}.bgwriter.buffers_checkpoint", row['buffers_checkpoint'], timestamp
+        output "#{config[:scheme]}.bgwriter.buffers_clean", row['buffers_clean'], timestamp
+        output "#{config[:scheme]}.bgwriter.maxwritten_clean", row['maxwritten_clean'], timestamp
+        output "#{config[:scheme]}.bgwriter.buffers_backend", row['buffers_backend'], timestamp
+        output "#{config[:scheme]}.bgwriter.buffers_backend_fsync", row['buffers_backend_fsync'], timestamp
+        output "#{config[:scheme]}.bgwriter.buffers_alloc", row['buffers_alloc'], timestamp
+      end
+    end
+
+    ok
+  end
+end

data/bin/metric-postgres-statsdb.rb

@@ -0,0 +1,124 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   metric-postgres-statsdb
+#
+# DESCRIPTION:
+#
+#   This plugin collects postgres database metrics from the pg_stat_database table
+#
+# 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.
+#
+
+require 'sensu-plugins-postgres/pgpass'
+require 'sensu-plugin/metric/cli'
+require 'pg'
+require 'socket'
+
+class PostgresStatsDBMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :pgpass,
+         description: 'Pgpass file',
+         short: '-f FILE',
+         long: '--pgpass',
+         default: ENV['PGPASSFILE'] || "#{ENV['HOME']}/.pgpass"
+
+  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'
+
+  option :port,
+         description: 'Database port',
+         short: '-P PORT',
+         long: '--port PORT'
+
+  option :database,
+         description: 'Database to connect on',
+         short: '-d DB',
+         long: '--db DB',
+         default: 'postgres'
+
+  option :all_databases,
+         description: 'Get stats for all available databases',
+         short: '-a',
+         long: '--all-databases',
+         boolean: true,
+         default: false
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to $queue_name.$metric',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.postgresql"
+
+  option :timeout,
+         description: 'Connection timeout (seconds)',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: 10,
+         proc: proc(&:to_i)
+
+  include Pgpass
+
+  def run
+    timestamp = Time.now.to_i
+    pgpass
+    con = PG.connect(host: config[:hostname],
+                     dbname: config[:database],
+                     user: config[:user],
+                     password: config[:password],
+                     port: config[:port],
+                     connect_timeout: config[:timeout])
+
+    query = 'SELECT * FROM pg_stat_database'
+    params = []
+    unless config[:all_databases]
+      query += ' WHERE datname = $1'
+      params.push config[:database]
+    end
+
+    con.exec_params(query, params) do |result|
+      result.each do |row|
+        database = row['datname']
+
+        row.each do |key, value|
+          next if %w[datid datname stats_reset].include?(key)
+
+          output "#{config[:scheme]}.statsdb.#{database}.#{key}", value.to_s, timestamp
+        end
+      end
+    end
+
+    ok
+  end
+end

data/bin/metric-postgres-statsio.rb

@@ -0,0 +1,122 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   metric-postgres-statsio
+#
+# DESCRIPTION:
+#
+#   This plugin collects postgres database IO metrics
+#
+# 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.
+#
+
+require 'sensu-plugins-postgres/pgpass'
+require 'sensu-plugin/metric/cli'
+require 'pg'
+require 'socket'
+
+class PostgresStatsIOMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :pgpass,
+         description: 'Pgpass file',
+         short: '-f FILE',
+         long: '--pgpass',
+         default: ENV['PGPASSFILE'] || "#{ENV['HOME']}/.pgpass"
+
+  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'
+
+  option :port,
+         description: 'Database port',
+         short: '-P PORT',
+         long: '--port PORT'
+
+  option :database,
+         description: 'Database name',
+         short: '-d DB',
+         long: '--db DB'
+
+  option :scope,
+         description: 'Scope, see http://www.postgresql.org/docs/9.2/static/monitoring-stats.html',
+         short: '-s SCOPE',
+         long: '--scope SCOPE',
+         default: 'user'
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to $queue_name.$metric',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.postgresql"
+
+  option :timeout,
+         description: 'Connection timeout (seconds)',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: 10,
+         proc: proc(&:to_i)
+
+  include Pgpass
+
+  def run
+    timestamp = Time.now.to_i
+    pgpass
+    con = PG.connect(host: config[:hostname],
+                     dbname: config[:database],
+                     user: config[:user],
+                     password: config[:password],
+                     port: config[:port],
+                     connect_timeout: config[:timeout])
+    request = [
+      'select sum(heap_blks_read) as heap_blks_read, sum(heap_blks_hit) as heap_blks_hit,',
+      'sum(idx_blks_read) as idx_blks_read, sum(idx_blks_hit) as idx_blks_hit,',
+      'sum(toast_blks_read) as toast_blks_read, sum(toast_blks_hit) as toast_blks_hit,',
+      'sum(tidx_blks_read) as tidx_blks_read, sum(tidx_blks_hit) as tidx_blks_hit',
+      "from pg_statio_#{config[:scope]}_tables"
+    ]
+    con.exec(request.join(' ')) do |result|
+      result.each do |row|
+        output "#{config[:scheme]}.statsio.#{config[:database]}.heap_blks_read", row['heap_blks_read'], timestamp
+        output "#{config[:scheme]}.statsio.#{config[:database]}.heap_blks_hit", row['heap_blks_hit'], timestamp
+        output "#{config[:scheme]}.statsio.#{config[:database]}.idx_blks_read", row['idx_blks_read'], timestamp
+        output "#{config[:scheme]}.statsio.#{config[:database]}.idx_blks_hit", row['idx_blks_hit'], timestamp
+        output "#{config[:scheme]}.statsio.#{config[:database]}.toast_blks_read", row['toast_blks_read'], timestamp
+        output "#{config[:scheme]}.statsio.#{config[:database]}.toast_blks_hit", row['toast_blks_hit'], timestamp
+        output "#{config[:scheme]}.statsio.#{config[:database]}.tidx_blks_read", row['tidx_blks_read'], timestamp
+        output "#{config[:scheme]}.statsio.#{config[:database]}.tidx_blks_hit", row['tidx_blks_hit'], timestamp
+      end
+    end
+
+    ok
+  end
+end