sensu-plugins-postgres-mrtrotl 4.3.1

data/bin/metric-postgres-statstable.rb

@@ -0,0 +1,124 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   metric-postgres-statstable
+#
+# DESCRIPTION:
+#
+#   This plugin collects postgres database metrics from the pg_stat tables
+#
+# 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.
+#
+
+require 'sensu-plugins-postgres/pgpass'
+require 'sensu-plugin/metric/cli'
+require 'pg'
+require 'socket'
+
+class PostgresStatsTableMetrics < 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(seq_scan) as seq_scan, sum(seq_tup_read) as seq_tup_read,',
+      'sum(idx_scan) as idx_scan, sum(idx_tup_fetch) as idx_tup_fetch,',
+      'sum(n_tup_ins) as n_tup_ins, sum(n_tup_upd) as n_tup_upd, sum(n_tup_del) as n_tup_del,',
+      'sum(n_tup_hot_upd) as n_tup_hot_upd, sum(n_live_tup) as n_live_tup, sum(n_dead_tup) as n_dead_tup',
+      "from pg_stat_#{config[:scope]}_tables"
+    ]
+    con.exec(request.join(' ')) do |result|
+      result.each do |row|
+        output "#{config[:scheme]}.statstable.#{config[:database]}.seq_scan", row['seq_scan'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.seq_tup_read", row['seq_tup_read'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.idx_scan", row['idx_scan'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.idx_tup_fetch", row['idx_tup_fetch'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.n_tup_ins", row['n_tup_ins'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.n_tup_upd", row['n_tup_upd'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.n_tup_del", row['n_tup_del'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.n_tup_hot_upd", row['n_tup_hot_upd'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.n_live_tup", row['n_live_tup'], timestamp
+        output "#{config[:scheme]}.statstable.#{config[:database]}.n_dead_tup", row['n_dead_tup'], timestamp
+      end
+    end
+
+    ok
+  end
+end

data/bin/metric-postgres-vaccum.rb

@@ -0,0 +1,125 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pg
+#
+# USAGE:
+#   ./metric-postgres-vaccum.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) 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 PostgresVacuumDBMetrics < 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 phase_mapping(vacuum_phase)
+    ['initializing',
+     'scanning heap',
+     'vacuuming indexes',
+     'vacuuming heap',
+     'cleaning up indexes',
+     'truncating heap',
+     'performing final cleanup'].find_index(vacuum_phase)
+  end
+
+  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_progress_vacuum'
+    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].include?(key)
+
+          if key == 'phase'
+            output "#{config[:scheme]}.vacuum.#{database}.phase", phase_mapping(value).to_s, timestamp
+          else
+            output "#{config[:scheme]}.vacuum.#{database}.#{key}", value.to_s, timestamp
+          end
+        end
+      end
+    end
+
+    ok
+  end
+end

data/bin/metrics-postgres-query.rb

@@ -0,0 +1,132 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+# 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-plugins-postgres/pgpass'
+require 'sensu-plugin/metric/cli'
+require 'pg'
+
+class MetricsPostgresQuery < 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 :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'
+
+  option :multirow,
+         description: 'Determines if we return first row or all rows',
+         short: '-m',
+         long: '--multirow',
+         boolean: true,
+         default: false
+
+  option :timeout,
+         description: 'Connection timeout (seconds)',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: 10,
+         proc: proc(&:to_i)
+
+  include Pgpass
+
+  def run
+    begin
+      pgpass
+      con = PG.connect(host: config[:hostname],
+                       dbname: config[:database],
+                       user: config[:user],
+                       password: config[:password],
+                       port: config[:port],
+                       connect_timeout: config[:timeout])
+      res = con.exec(config[:query].to_s)
+    rescue PG::Error => e
+      unknown "Unable to query PostgreSQL: #{e.message}"
+    end
+
+    value = if config[:count_tuples]
+              res.ntuples
+            else
+              res.first&.values&.first
+            end
+
+    if config[:multirow] && !config[:count_tuples]
+      res.values.each do |row|
+        output "#{config[:scheme]}.#{row[0]}", row[1]
+      end
+    else
+      output config[:scheme], value
+    end
+    ok
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pgpass
+  def read_pgpass(pg_pass_file)
+    File.readlines(pg_pass_file).each do |line|
+      return line.strip.split(':') unless line.start_with?('#')
+
+      next
+    end
+  end
+
+  def pgpass
+    if File.file?(config[:pgpass])
+      pgpass = Hash[%i[hostname port database user password].zip(read_pgpass(config[:pgpass]))]
+      pgpass[:database] = nil if pgpass[:database] == '*'
+      pgpass.each do |k, v|
+        config[k] ||= v
+      end
+    else
+      config[:hostname] ||= ENV['PGHOST']     || 'localhost'
+      config[:port]     ||= ENV['PGPORT']     || 5432
+      config[:database] ||= ENV['PGDATABASE'] || 'postgres'
+      config[:user]     ||= ENV['PGUSER']     || 'postgres'
+      config[:password] ||= ENV['PGPASSWORD']
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PgUtil
+  def check_vsn_newer_than_postgres9(conn)
+    pg_vsn = conn.exec("SELECT current_setting('server_version')").getvalue(0, 0)
+    pg_vsn = pg_vsn.split(' ')[0]
+    Gem::Version.new(pg_vsn) < Gem::Version.new('10.0') && Gem::Version.new(pg_vsn) >= Gem::Version.new('9.0')
+  end
+
+  def compute_lag(master, slave, m_segbytes)
+    m_segment, m_offset = master.split('/')
+    s_segment, s_offset = slave.split('/')
+    ((m_segment.hex - s_segment.hex) * m_segbytes) + (m_offset.hex - s_offset.hex)
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SensuPluginsPostgres
+  module Version
+    MAJOR = 4
+    MINOR = 3
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/sensu-plugins-postgres.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'sensu-plugins-postgres/version'
+require 'sensu-plugins-postgres/pgpass'