sensu-plugins-postgres 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c96168d5cf1c89531c5cf9f704a6332cee262b94f7f0468ccc51fe7d8a549f2
-  data.tar.gz: 72efe21b417524311cbe898606aaffb8a2e4fac9d07ad11ccab0b9eb8f4671c5
+  metadata.gz: 2d435ce57d91a2e6a71c1971cd1602f19b82004f70f82aa498770c110c8bf266
+  data.tar.gz: 64ddf283f041bd5b70eac42d7433e8a0dad64226858723e4e8c56a5f983f819f
 SHA512:
-  metadata.gz: 4c90282c49b0b8a00afbcef7d8a3aa0442e69c3eaf5d64edcfcccf07d3ea8127c55faa770f05f4bd7fea025ee767ad3afc4d1b85a503645b53519d2d8498153c
-  data.tar.gz: ee9cccd264eacc1e41ece5e6ba6bafb2e21f18f7c3d65ea853f29611517eab71303ada9e654efea35975f94b140000c6fc4b0b6c2e939ec7c6ee8d510d96ccd9
+  metadata.gz: d91e6b7648feab7e75431930bc7a739448276d233df4c2afd8cb9084ebbbb488878ab5a5936422355fcb9a34dcec6699db279afeeee52798b66390d32761bcb8
+  data.tar.gz: 824cc884e247f23a9ffdb0aa60e4e3a90bda1fd2e4d10badcbaf8934d6e08fa77d00a53599c8331ea209381696923779d8d7bb9f433c5aeee78ec6418df4150b

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [4.1.0] - 2020-06-04
+### Added
+- new `metric-postgres-vaccum.rb` metric gathering script for postgres vacuum process (@phumpal)
+
 ## [4.0.2] - 2020-06-02
 - Fixed `# frozen_string_literal: true` does not play nicely with mixlib-cli.
 
@@ -213,7 +217,8 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-postgres/compare/4.0.2...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-postgres/compare/4.1.0...HEAD
+[4.1.0]: https://github.com/sensu-plugins/sensu-plugins-postgres/compare/4.0.2...4.1.0
 [4.0.2]: https://github.com/sensu-plugins/sensu-plugins-postgres/compare/4.0.1...4.0.2
 [4.0.1]: https://github.com/sensu-plugins/sensu-plugins-postgres/compare/4.0.0...4.0.1
 [4.0.0]: https://github.com/sensu-plugins/sensu-plugins-postgres/compare/3.0.0...4.0.0

data/bin/metric-postgres-vaccum.rb

@@ -0,0 +1,124 @@
+#! /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: nil
+
+  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/lib/sensu-plugins-postgres/version.rb

@@ -3,8 +3,8 @@
 module SensuPluginsPostgres
   module Version
     MAJOR = 4
-    MINOR = 0
-    PATCH = 2
+    MINOR = 1
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-postgres
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -270,6 +270,7 @@ executables:
 - metric-postgres-locks.rb
 - metric-postgres-statsbgwriter.rb
 - check-postgres-replication.rb
+- metric-postgres-vaccum.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -288,6 +289,7 @@ files:
 - bin/metric-postgres-statsdb.rb
 - bin/metric-postgres-statsio.rb
 - bin/metric-postgres-statstable.rb
+- bin/metric-postgres-vaccum.rb
 - bin/metrics-postgres-query.rb
 - lib/sensu-plugins-postgres.rb
 - lib/sensu-plugins-postgres/pgpass.rb