sensu-plugins-fsmounts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 142690832f3a193c3724334ff4d8b1820d4b668d
+  data.tar.gz: d84b25fba93332847c82b17e70a699db2f150d77
+SHA512:
+  metadata.gz: 20f9df903c18182b6179299d7ce62e761641230ff88c0a491e5257f3815fa39742e170299642c3f039419189213a8bbac5c54cb5c93d3b9d659c61977b9e88b4
+  data.tar.gz: e9bc17b5197a64aae998620a0e4aa9e43cb6ad49c500af344f1c219de1462c4906bff77ef67c01a4b89d37d3d3c88a58e67ac05b125b941e3e626ede1add40fa

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 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] - 2015-12-29
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Matteo Cerutti
+
+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 plugin for monitoring mount points
+
+A sensu plugin to monitor whether entries listed in /etc/fstab are mounted and the other way around, as in currently mounted volumes have an entry in /etc/fstab.
+
+The plugin generates multiple OK/WARN/CRIT/UNKNOWN events via the sensu client socket (https://sensuapp.org/docs/latest/clients#client-socket-input)
+so that you do not miss state changes when monitoring multiple mountpoints.
+
+## Usage
+
+The plugin accepts the following command line options:
+
+```
+Usage: check-fsmounts.rb (options)
+        --fstype <TYPE>              Comma separated list of file system type(s) (default: all)
+        --ignore-fstype <TYPE>       Comma separated list of file system type(s) to ignore
+        --ignore-mount <MOUNTPOINT>  Comma separated list of mount point(s) to ignore
+        --ignore-mount-regex <MOUNTPOINT>
+                                     Comma separated list of mount point(s) to ignore (regex)
+        --mount <MOUNTPOINT>         Comma separated list of mount point(s) (default: all)
+        --mount-regex <MOUNTPOINT>   Comma separated list of mount point(s) (regex)
+    -w, --warn                       Warn instead of throwing a critical failure
+```
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-fsmounts.rb

@@ -0,0 +1,265 @@
+#!/usr/bin/env ruby
+#
+# check-fsmounts.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-plugin/check/cli'
+require 'json'
+require 'socket'
+require 'sys/filesystem'
+require 'fstab'
+
+class CheckFsMounts < Sensu::Plugin::Check::CLI
+  option :fstype,
+         :description => "Comma separated list of file system type(s) (default: all)",
+         :long => "--fstype <TYPE>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :ignore_fstype,
+         :description => "Comma separated list of file system type(s) to ignore",
+         :long => "--ignore-fstype <TYPE>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :mount,
+         :description => "Comma separated list of mount point(s) (default: all)",
+         :long => "--mount <MOUNTPOINT>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :mount_regex,
+         :description => "Comma separated list of mount point(s) (regex)",
+         :long => "--mount-regex <MOUNTPOINT>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :ignore_mount,
+         :description => "Comma separated list of mount point(s) to ignore",
+         :long => "--ignore-mount <MOUNTPOINT>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :ignore_mount_regex,
+         :description => "Comma separated list of mount point(s) to ignore (regex)",
+         :long => "--ignore-mount-regex <MOUNTPOINT>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :warn,
+         :description => "Warn instead of throwing a critical failure",
+         :short => "-w",
+         :long => "--warn",
+         :boolean => false
+
+  option :dryrun,
+         :description => "Do not send events to sensu client socket",
+         :long => "--dryrun",
+         :boolean => true,
+         :default => false
+
+  def initialize()
+    super
+
+    # retrieve all entries in the system fstab
+    @fstab_entries = get_fstab_entries()
+
+    # discover currently mounted filesystems
+    @mounted_filesystems = get_mounted_filesystems()
+  end
+
+  def get_fstab_entries()
+    entries = {}
+
+    fstab = Fstab.new("/etc/fstab")
+    fstab.entries.each do |device, entry|
+      if config[:ignore_fstype].size > 0
+        next if config[:ignore_fstype].include?(entry[:type])
+      end
+
+      if config[:fstype].size > 0
+        next unless config[:fstype].include?(entry[:type])
+      end
+
+      if config[:ignore_mount].size > 0
+        next if config[:ignore_mount].include?(entry[:mount_point])
+      end
+
+      if config[:ignore_mount_regex].size > 0
+        b = false
+        config[:ignore_mount_regex].each do |mnt|
+          if entry[:mount_point] =~ Regexp.new(mnt)
+            b = true
+            break
+          end
+        end
+        next if b
+      end
+
+      if config[:mount].size > 0
+        next unless config[:mount].include?(entry[:mount_type])
+      end
+
+      if config[:mount_regex].size > 0
+        b = true
+        config[:mount_regex].each do |mnt|
+          if entry[:mount_point] =~ Regexp.new(mnt)
+            b = false
+            break
+          end
+        end
+        next if b
+      end
+
+      entries[device] = {
+        :mount_point => entry[:mount_point]
+      }
+    end
+
+    entries
+  end
+
+  def get_mounted_filesystems()
+    mounts = {}
+
+    Sys::Filesystem.mounts.each do |fs|
+      # always ignore the following mount types
+      #next if ["rootfs", "proc", "sysfs", "devtmpfs", "devpts", "securityfs", "autofs", "pstore"].include?(fs.mount_type)
+
+      if config[:ignore_fstype].size > 0
+        next if config[:ignore_fstype].include?(fs.mount_type)
+      end
+
+      if config[:fstype].size > 0
+        next unless config[:fstype].include?(fs.mount_type)
+      end
+
+      if config[:ignore_mount].size > 0
+        next if config[:ignore_mount].include?(fs.mount_type)
+      end
+
+      if config[:ignore_mount_regex].size > 0
+        b = false
+        config[:ignore_mount_regex].each do |mnt|
+          if fs.mount_point =~ Regexp.new(mnt)
+            b = true
+            break
+          end
+        end
+        next if b
+      end
+
+      if config[:mount].size > 0
+        next unless config[:mount].include?(fs.mount_type)
+      end
+
+      if config[:mount_regex].size > 0
+        b = true
+        config[:mount_regex].each do |mnt|
+          if fs.mount_point =~ Regexp.new(mnt)
+            b = false
+            break
+          end
+        end
+        next if b
+      end
+
+      mounts[fs.name] = {
+        :mount_point => fs.mount_point
+      }
+    end
+
+    mounts
+  end
+
+  def send_client_socket(data)
+    if config[:dryrun]
+      puts data.inspect
+    else
+      sock = UDPSocket.new
+      sock.send(data + "\n", 0, "127.0.0.1", 3030)
+    end
+  end
+
+  def send_ok(check_name, msg)
+    event = {"name" => check_name, "status" => 0, "output" => "OK: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_warning(check_name, msg)
+    event = {"name" => check_name, "status" => 1, "output" => "WARNING: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_critical(check_name, msg)
+    event = {"name" => check_name, "status" => 2, "output" => "CRITICAL: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_unknown(check_name, msg)
+    event = {"name" => check_name, "status" => 3, "output" => "UNKNOWN: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def run
+    problems = 0
+
+    # check if currently mounted filesystems have an entry in fstab
+    @mounted_filesystems.each do |device, mount|
+      check_name = "fsmounts-#{mount[:mount_point].gsub('/', '_')}"
+
+      if @fstab_entries.has_key?(device)
+        if @fstab_entries[device][:mount_point] == mount[:mount_point]
+          send_ok(check_name, "Device #{device} mounted at #{mount[:mount_point]} found in /etc/fstab")
+        else
+          msg = "Device #{device} found in /etc/fstab but mountpoints do not match!"
+
+          if config[:warn]
+            send_warning(check_name, msg)
+          else
+            send_critical(check_name, msg)
+          end
+
+          problems += 1
+        end
+      else
+        msg = "Device #{device} mounted at #{mount[:mount_point]} not found in /etc/fstab"
+
+        if config[:warn]
+          send_warning(check_name, msg)
+        else
+          send_critical(check_name, msg)
+        end
+
+        problems += 1
+      end
+    end
+
+    # now check if fstab entries are mounted
+    @fstab_entries.each do |device, entry|
+      check_name = "fsmounts-#{entry[:mount_point].gsub('/', '_')}"
+
+      unless @mounted_filesystems.has_key?(device)
+        msg = "Fstab entry with device #{device} and mountpoint #{entry[:mount_point]} is not mounted"
+
+        if config[:warn]
+          send_warning(check_name, msg)
+        else
+          send_critical(check_name, msg)
+        end
+
+        problems += 1
+      end
+    end
+
+    if problems > 0
+      message("Found #{problems} problems")
+      warning if config[:warn]
+      critical
+    else
+      ok("All mountpoints are OK")
+    end
+  end
+end

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

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

data/lib/sensu-plugins-fsmounts.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-fsmounts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-05 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: sys-filesystem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: fstab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: This plugin provides facilities for monitoring mount points
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-fsmounts.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-fsmounts.rb
+- lib/sensu-plugins-fsmounts.rb
+- lib/sensu-plugins-fsmounts/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-fsmounts
+licenses:
+- MIT
+metadata:
+  maintainer: "@m4ce"
+  development_status: active
+  production_status: stable
+  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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for monitoring mount points
+test_files: []