sensu-plugins-barman-checks 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daecdff7dc4c470c8666cb281c1c6d1b0b46bb09
-  data.tar.gz: 70b3c3b5262d559cbcfff0f10a0086b20c756a44
+  metadata.gz: 03bbb0aaed34536c05481b43bd9c268e30d9b615
+  data.tar.gz: db700583a86523ade199db6b5409c4fb4a15b7b0
 SHA512:
-  metadata.gz: 0eaba82aed8a591915df6db942354855e6a19053537f518b7d683710049bf8ccbb45ba45490364d4fdb03f78c2d64c3d4b1e8c6b0800a3d5773ad437fc8d8677
-  data.tar.gz: 817decc9332870a7b3c5b9935577f945ad25c622d4057eabff29b720b749ff243b98f05b4ad5191b9ab1e3320f8483381f3127f2f3e88009a33dd87b1c914a35
+  metadata.gz: 59f41557878938ea94caf7c6cc05ebf3fb503d3326ca5c7df9e8ad1c3f483353d81548cd77f3fdb05c523d997c7320c203c96004d9e164761cd8cf9030cb8d84
+  data.tar.gz: a6a370736737dd56b320f43207d375e83f0da66274c5f1dfa1ba9defd2d1ff8f68fa27a146fcb9b4892a90f6aea8077bb4335c6531b7bc78aaf918c4b464623b

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.3 - 2016-11-30
+### Fixed
+- The plugin now actually works
+
+### Removed
+- Dropped rbarman + sudo gems and rewrote plugin using regular sudo calls
 
 ## 0.0.2 - 2016-11-30
 ### Fixed

data/README.md

@@ -16,7 +16,13 @@ checked to ensure it has backups, that backup status is successful, and that the
 
 ## Usage
 
-/path_to_sensu/embedded/bin/ruby /path_to_sensu/embedded/bin/check-barman-backup-status.rb [-m MIN_NUMBER_BACKUPS] [--max-age MAX_AGE_IN_HOURS_OF_LATEST_BACKUP] [--warn WARN_AGE_IN_HOURS_OF_LATEST_BACKUP]
+This plugin requires the use of sudo, as barman requires either the barman user or sudo user and we can only use the sensu user.  To configure sudo access, setup the following in your sudoers file:
+
+`sensu ALL=(ALL) NOPASSWD:/usr/bin/barman, /opt/sensu/embedded/bin/ruby, /opt/sensu/embedded/bin/check-barman-backup-status.rb`
+
+`Defaults:sensu !requiretty`
+
+`/path_to_sensu/embedded/bin/ruby /path_to_sensu/embedded/bin/check-barman-backup-status.rb [-m MIN_NUMBER_BACKUPS] [--max-age MAX_AGE_IN_HOURS_OF_LATEST_BACKUP] [--warn WARN_AGE_IN_HOURS_OF_LATEST_BACKUP]`
 
 ## Installation
 

data/bin/check-barman-backup-status.rb

@@ -1,12 +1,14 @@
 #!/usr/bin/env ruby
 #  encoding: UTF-8
 #
-# Sudo wrapper for running barman backup status check
+# Check Barman Backup Status
 # ===
 #
 # DESCRIPTION:
 # This plugin checks the status and age of Barman backups for each configured server
-# The sensu user must be configured as NOPASSWD in sudoers for this script in order to work.
+# Do not run this script directly.  It needs to be called via check-barman-backup-status.rb
+# because the barman gem requires sudo access to work properly and we have to run as
+# the sensu user, so we use a sudo wrapper in check-barman-backup-status.rb
 #
 # PLATFORMS:
 #   Linux, BSD, Solaris
@@ -23,13 +25,124 @@
 # Released under the same terms as Sensu (the MIT license); see LICENSE
 # for details.
 
-require_relative './check-barman-backup-status-class'
-require 'sudo'
+require 'sensu-plugin/check/cli'
+require 'time'
 
-# Wrapper around the actual check class since barman requires root or the barman user
-# and we have to run as the sensu user to run the plugin
-CheckBarmanBackupStatus.new
-sudo = Sudo::Wrapper.new
-sudo.start!
-sudo[CheckBarmanBackupStatus].run
-sudo.stop!
+# main plugin class
+class CheckBarmanBackupStatus < Sensu::Plugin::Check::CLI
+  option :min_backups,
+         description: 'Minimum number of backups that should exist before alerting',
+         short:       '-m',
+         long:        '--min-backups',
+         required:    true,
+         default:     1
+
+  option :warn_age,
+         description: 'The maximum age of backup before warning (in hours)',
+         short:       '-w',
+         long:        '--warn-age',
+         required:    true,
+         default:     24
+
+  option :max_age,
+         description: 'The maximum age of backup before critical alert (in hours)',
+         long:        '--max-age',
+         required:    true,
+         default:     25
+
+  option :homedir,
+         description: 'The home directory path for barman',
+         long:        '--homedir PATH',
+         required:    true,
+         default:     '/var/lib/barman'
+
+  def time_diff(start_time, end_time)
+    diff = end_time.to_i - start_time.to_i
+    hours = (diff / 60 / 60)
+    hours
+  end
+
+  def run
+    start_time = Time.now
+    @crit = []
+    @warn = []
+
+    servers = `sudo barman list-server | awk '{print $1}'`.split(/\n/).map(&:strip)
+
+    servers.each do |server|
+      @server_hash = {
+        server.to_s => {
+          'attrs'   => {},
+          'status'  => {}
+        }
+      }
+
+      @backup_hash = {
+        server.to_s => {}
+      }
+
+      # No YAML or other supported output to parse so we'll have to do it manually
+      server_attrs = `sudo barman show-server #{server}`.split(/\n/).map(&:strip)
+      server_attrs.each do |attr|
+        key, value = attr.split(':').map(&:strip)
+        @server_hash[server]['attrs'][key] = value
+      end
+
+      server_status = `sudo barman status #{server}`.split(/\n/).map(&:strip)
+      server_status.each do |status|
+        key, value = status.split(':').map(&:strip)
+        @server_hash[server]['status'][key] = value
+      end
+
+      if @server_hash[server]['status']['Active'] == 'False'
+        @crit << "Server #{server} is not in active status.  Status is: #{@server_hash[server]['status']['Active']}"
+      end
+
+      check_status = `sudo barman check #{server} | grep -v 'Server #{server}'`.split(/\n/).map(&:strip)
+      check_status.each do |check|
+        key, value = check.split(':').map(&:strip)
+        unless value =~ /^OK/
+          @crit << "Status check failed on configured server #{server}.  #{key}: #{value}"
+        end
+      end
+
+      backups = `sudo barman list-backup #{server} | awk '{print $2}'`.split(/\n/).map(&:strip)
+
+      if backups.count < config[:min_backups].to_i
+        @crit << "Minimum backups not met for server #{server}.  Count is #{backups.count}"
+      else
+        puts "Number of backups for server #{server}: #{backups.count}"
+      end
+
+      backups.each do |backup|
+        status = `sudo barman show-backup #{server} #{backup} | grep Status | awk '{print $NF}'`.strip
+        unless status.casecmp('done') || status.casecmp('started')
+          @crit << "Backup for server #{server} with ID #{backup} is in error state: #{status.downcase}"
+        end
+      end
+
+      latest = @server_hash[server]['status']['Last available backup']
+      latest_time = Time.parse(`sudo barman show-backup #{server} #{latest} | grep 'Begin time' | awk '{print $4,$5}'`.strip)
+      backup_age = time_diff(latest_time, start_time).to_i
+
+      if backup_age > config[:warn_age].to_i
+        @warn << "Warning threshold for backup age exceeded for latest backup on server #{server}.  Age is #{backup_age} hour(s)"
+      end
+
+      if backup_age > config[:max_age].to_i
+        @crit << "Maximum age exceeded for latest backup on server #{server}. Age is: #{backup_age} hour(s)"
+      else
+        puts "Age of latest backup for server #{server}: #{backup_age} hour(s)"
+      end
+    end
+
+    # Assuming we got this far, exit cleanly
+    if @crit.empty? && @warn.empty?
+      ok 'Recent backups exist for each configured server. Each configured server is also active and in a good state.'
+    elsif !@crit.empty?
+      critical "critical: #{@crit}"
+    elsif !@warn.empty?
+      warning "warning: #{@warn}"
+    end
+  end
+end

data/lib/sensu-plugins-barman-checks/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-barman-checks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Scott Brimhall
@@ -25,34 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: rbarman
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.15
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.15
-- !ruby/object:Gem::Dependency
-  name: sudo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +157,6 @@ description: |-
                                 properly generated.
 email: "<scottbrimhall@gmail.com>"
 executables:
-- check-barman-backup-status-class.rb
 - check-barman-backup-status.rb
 extensions: []
 extra_rdoc_files: []
@@ -193,7 +164,6 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- bin/check-barman-backup-status-class.rb
 - bin/check-barman-backup-status.rb
 - lib/sensu-plugins-barman-checks.rb
 - lib/sensu-plugins-barman-checks/version.rb

data/bin/check-barman-backup-status-class.rb

@@ -1,121 +0,0 @@
-#!/usr/bin/env ruby
-#  encoding: UTF-8
-#
-# Check Barman Backup Status
-# ===
-#
-# DESCRIPTION:
-# This plugin checks the status and age of Barman backups for each configured server
-# Do not run this script directly.  It needs to be called via check-barman-backup-status.rb
-# because the barman gem requires sudo access to work properly and we have to run as
-# the sensu user, so we use a sudo wrapper in check-barman-backup-status.rb
-#
-# PLATFORMS:
-#   Linux, BSD, Solaris
-#
-# DEPENDENCIES:
-#   Sensu Plugins run as the sensu user and barman needs to run with sudo or barman user
-#   gem: sensu-plugin
-#   gem: sudo
-#   gem: rbarman
-#
-# LICENSE:
-# Copyright 2016 Scott Brimhall <scottbrimhall@gmail.com>
-#
-# Released under the same terms as Sensu (the MIT license); see LICENSE
-# for details.
-
-require 'sensu-plugin/check/cli'
-require 'rbarman'
-require 'time'
-
-# main plugin class
-class CheckBarmanBackupStatus < Sensu::Plugin::Check::CLI
-  option :min_backups,
-         description: 'Minimum number of backups that should exist before alerting',
-         short:       '-m',
-         long:        '--min-backups',
-         required:    true,
-         default:     1
-
-  option :warn_age,
-         description: 'The maximum age of backup before warning (in hours)',
-         short:       '-w',
-         long:        '--warn-age',
-         required:    true,
-         default:     24
-
-  option :max_age,
-         description: 'The maximum age of backup before critical alert (in hours)',
-         long:        '--max-age',
-         required:    true,
-         default:     25
-
-  option :homedir,
-         description: 'The home directory path for barman',
-         long:        '--homedir PATH',
-         required:    true,
-         default:     '/var/lib/barman'
-
-  def time_diff(start_time, end_time)
-    diff = end_time.to_i - start_time.to_i
-    hours = (diff / 60 / 60)
-    hours
-  end
-
-  def run
-    # The rbarman gem defaults to ENV['HOME'] for things.  Need to set this to barman's homedir
-    ENV['HOME'] = config[:homedir]
-    start_time = Time.now
-    @crit = []
-    @warn = []
-
-    servers = Rbarman::Servers.all(opts = {})
-
-    servers.each do |server|
-      puts "Name: #{server.name}"
-      backups = RBarman::Backups.all(server.name, opts = {})
-
-      if backups.count < config[:min_backups].to_i
-        @crit << "Minimum backups not met for server #{server.name}.  Count is #{backups.count}"
-      else
-        puts "Number of backups for server #{server.name}: #{backups.count}"
-      end
-
-      latest_backup = backups.latest.backup_end
-      backup_time   = Time.parse(latest_backup)
-      backup_age    = time_diff(backup_time, start_time)
-
-      if backup_age < config[:warn_age].to_i
-        @warn << "Warning threshold for backup age exceeded for latest backup on server #{server.name}.  Age is #{backup_age} hour(s)"
-      end
-
-      if backup_age < config[:max_age].to_i
-        @crit << "Maximum age exceeded for latest backup on server #{server.name}. Age is: #{backup_age} hour(s)"
-      else
-        puts "Age of latest backup for server #{server.name}: #{backup_age} hour(s)"
-      end
-
-      backups.each do |b|
-        puts "Backup ID: #{b.id}"
-        if b.status != 'done'
-          @crit << "Backup ID #{b.id} is in error state (#{b.status}) for server #{server.name}"
-        else
-          puts "Backup Status: #{b.status}"
-        end
-
-        puts "Backup Size: #{b.size} bytes"
-        puts "Backup Wal file size: #{b.wal_file_size} bytes"
-      end
-    end
-
-    # Assuming we got this far, exit cleanly
-    if @crit.empty? && @warn.empty?
-      ok
-    elsif !@crit.empty?
-      critical "critical: #{@crit}"
-    elsif !@warn.empty?
-      warning "warning: #{@warn}"
-    end
-  end
-end