sensu-plugins-barman-checks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4df5e979e193f81bfb4ac5a5dd83cd705a18cf33
+  data.tar.gz: 947aa108e79831daca10d7c47ea7a5305c00bdb4
+SHA512:
+  metadata.gz: f72757bd3332be66d4208fb49375044b714f08fafd3971d69d8d4f06a3295817149c7526881ae9876058d561cc7a5c5bd43bae3907d1f28e964d7908c80fc6e4
+  data.tar.gz: 238230be8b3f1c022be0c855f472074877f231c8e899b34d032d952d56558d1c90ce8172eaf391ff99fcf86e90071a2c8daec0e2ec3754bb74c3f7cef43a0e0e

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+#Change Log
+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.1 - 2016-11-29
+### Added
+- Added barman backup age check
+- Added barman backup minimum check
+- Added barman backup status check
+
+[Unreleased]: https://github.com/sbrimhall/sensu-plugins-barman-checks/compare/0.1.0...HEAD

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+## Sensu-Plugins-barman-checks
+
+[![Build Status](https://travis-ci.org/sbrimhall/sensu-plugins-barman-checks.svg?branch=master)](https://travis-ci.org/sbrimhall/sensu-plugins-barman-checks)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-barman-checks.svg)](http://badge.fury.io/rb/sensu-plugins-barman-checks)
+[![Code Climate](https://codeclimate.com/github/sbrimhall/sensu-plugins-barman-checks/badges/gpa.svg)](https://codeclimate.com/github/sbrimhall/sensu-plugins-barman-checks)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-barman-checks/badges/coverage.svg)](https://codeclimate.com/github/sbrimhall/sensu-plugins-barman-checks)
+[![Dependency Status](https://gemnasium.com/sbrimhall/sensu-plugins-barman-checks.svg)](https://gemnasium.com/sbrimhall/sensu-plugins-barman-checks)
+
+## Functionality
+
+This plugin is for monitoring Barman PostgreSQL backups.  Each configured server on the barman instance is
+checked to ensure it has backups, that backup status is successful, and that the age of backups is not too old.
+
+## Files
+ * bin/check-barman-backup-status.rb
+
+## 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]
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes

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

@@ -0,0 +1,121 @@
+#!/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

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

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+# Sudo wrapper for running barman backup status check
+# ===
+#
+# 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.
+#
+# 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 './check-barman-backup-status-class'
+require 'sudo'
+
+# 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!

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

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

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

@@ -0,0 +1 @@
+require 'sensu-plugins-barman-checks/version'

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-barman-checks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scott Brimhall
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: |-
+  This plugin provides checking of Barman
+                                PostgreSQL backups to ensure they are being
+                                properly generated.
+email: "<scottbrimhall@gmail.com>"
+executables:
+- check-barman-backup-status-class.rb
+- check-barman-backup-status.rb
+extensions: []
+extra_rdoc_files: []
+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
+homepage: https://github.com/sbrimhall/sensu-plugins-barman-checks
+licenses:
+- MIT
+metadata:
+  maintainer: sbrimhall
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Sensu plugin for checking Barman backups
+test_files: []