sensu-plugins-restic 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3040f21918c252212b29a508c07aefbb7fc9a8b90b36346713c0b4ac5d10a708
+  data.tar.gz: f639061282c9ad44440762e7af85af1a9968907b342865012d5654a17d26057a
+SHA512:
+  metadata.gz: f82c76f754963de4543c95c53bce14b1ba458713aea27b283f99e1b4c30ad5d95313a6ee30f6098686550636480809ce873ab96a59a333e79bd73eec4ed53421
+  data.tar.gz: 1578bb4b4b6a87309d1b3015536d97777f5707bfa404c6448357572e5a9e033ff7a0c02a5fe2ed6a2988da7439a2b1ead7c35d1c6033789d06234fb77cc0e7c4

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format located [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
+
+## [Unreleased]
+
+### Added
+- Check to test for restic snapshot age

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sensu Community Plugins
+
+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,48 @@
+# sensu-plugins-restic
+
+[![Build Status](https://travis-ci.org/erasys/sensu-plugins-restic.svg?branch=master)](https://travis-ci.org/erasys/sensu-plugins-restic)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-restic.svg)](http://badge.fury.io/rb/sensu-plugins-restic)
+[![Dependency Status](https://gemnasium.com/erasys/sensu-plugins-restic.svg)](https://gemnasium.com/erasys/sensu-plugins-restic)
+[![Community Slack](https://slack.sensu.io/badge.svg)](https://slack.sensu.io/badge)
+
+## Functionality
+
+## Files
+
+* bin/check-restic-snapshot.rb
+
+## Usage
+
+### check-restic-snapshot
+
+Checks the presence and the age of the latest restic backup snapshot.
+
+By default it expects the restic binary to be installed at `/usr/bin/restic`. Repository location and password are passed into the check
+through the environment variables `$RESTIC_REPOSITORY` and `$RESTIC_PASSWORD_FILE`. Please check the
+[restic documentation](https://restic.readthedocs.io/en/latest/manual_rest.html) for details.
+
+This example checks the repository configured through the environment variables mentioned before. It warns if the last backup is older
+than 1 day + 1 hour, and becomes critical after 2 days + 1 hour:
+
+```
+check-restic-snapshot.rb -w 90000 -c 176400
+```
+
+If your restic binary is in a different location and/or you prefer to pass repository location and password via parameters, use the `-p`
+option to specify how the restic binary is invoked:
+
+```
+check-restic-snapshot.rb -w 90000 -c 176400 -p '/opt/bin/restic -r /mnt/backups -p /etc/restic/password'
+```
+
+The `--missing-status` allows you to specify the check's result if no backup has been created so far (defaults to `critical`).
+
+```
+check-restic-snapshot.rb -w 90000 -c 176400 --missing-status warning
+```
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes

data/bin/check-restic-snapshot.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+#
+#   check-snapshot
+#
+# DESCRIPTION:
+#   Check the age of the last restic snapshot
+#
+# OUTPUT:
+#   Plain text
+#
+# PLATFORMS:
+#   Any platform with restic client
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   ./check-snapshot.rb [-p path_to_restic] -w warn -c crit
+#
+# LICENSE:
+#   Jan Kunzmann <jan.kunzmann@erasys.de>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'json'
+require 'time'
+require 'sensu-plugin/check/cli'
+
+class ResticSnapshot < Sensu::Plugin::Check::CLI
+
+  option :path,
+         short: '-p RESTIC_PATH',
+         long: '--path RESTIC_PATH',
+         description: 'Path to the restic client binary.  Defaults to /usr/bin/restic',
+         default: '/usr/bin/restic'
+
+  option :missing_status,
+         long: '--missing-status STATUS',
+         description: 'Returns this exit status there there is no snapshot',
+         default: 'critical',
+         in: %w[unknown ok warning critical]
+
+  option :warning_age,
+         short: '-w SECONDS',
+         long: '--warning SECONDS',
+         description: 'Warn if latest snapshot is older than provided age in seconds',
+         proc: proc(&:to_i),
+         required: true
+
+  option :critical_age,
+         short: '-c SECONDS',
+         long: '--critical SECONDS',
+         description: 'Critical if latest snapshot is older than provided age in seconds',
+         proc: proc(&:to_i),
+         required: true
+
+  def run
+    snapshots = available_snapshots
+    if snapshots.length == 0
+      send(config[:missing_status], 'No backup found')
+    end
+    last_snap = Time.parse(snapshots[-1][:time])
+    age = (Time.now - last_snap).to_i
+
+    msg = "Last backup was at #{last_snap}"
+    if age >= config[:critical_age]
+      critical msg
+    elsif age >= config[:warning_age]
+      warning msg
+    else
+      ok msg
+    end
+  end
+
+  #
+  # Return an array of hashes with details about the snapshots
+  #
+  def available_snapshots
+    snapshot_info = `#{config[:path]} --json snapshots`
+    JSON.parse(snapshot_info, { symbolize_names: true })
+  end
+end

data/lib/sensu-plugins-restic.rb

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

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

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

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-restic
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-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: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: kitchen-docker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: kitchen-localhost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.36.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.36.1
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: Sensu restic plugins
+email: "<jan.kunzmann@erasys.de>"
+executables:
+- check-restic-snapshot.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-restic-snapshot.rb
+- lib/sensu-plugins-restic.rb
+- lib/sensu-plugins-restic/version.rb
+homepage: https://github.com/erasys/sensu-plugins-restic
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for restic backups
+test_files: []