sensu-plugins-disk-usage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87993f3afe5c1f43afb52e49ce432607e2c81ceb
+  data.tar.gz: b6ca5b7e0dce4db451592071baa7ad30f7435a13
+SHA512:
+  metadata.gz: 1b35b0d41f9f69ecc958c9ae791c1d5b89b24413643ee90db13f8d5f7b50711d022e95df6c3c252e07fc6c00d9a7f5b912d8471d819a92a43bfbd563c06027d4
+  data.tar.gz: 5fb18017ad8419e3ac541fbe9a860da373434d582bb33eb7495299bd6d8ccc4c00e361a23687d19e91a28175aeacf0be909199b4ea8e9fa1185230614b22addc

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,49 @@
+# Sensu plugin for monitoring disk usage
+
+A sensu plugin to monitor disk usage on Linux.
+
+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 volumes.
+
+## Usage
+
+The plugin accepts the following command line options:
+
+```
+Usage: check-disk-usage.rb (options)
+    -c, --config <PATH>              Optional configuration file (default: ./disk-usage.json)
+        --crit-inodes <PERCENT>      Critical if PERCENT or more of inodes used
+        --crit-space <PERCENT>       Critical if PERCENT or more of disk space used
+        --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
+        --warn-inodes <PERCENT>      Warn if PERCENT or more of inodes used
+        --warn-space <PERCENT>       Warn if PERCENT or more of disk space used
+```
+
+By default, the warning and critical parameters are global to all mountpoints. However, each mountpoint can override the defaults in an optional JSON configuration file which must be placed
+in the same location as the plugin.
+
+JSON example:
+
+```
+{
+  "mountpoints": {
+    "/": {
+      "warn_space": 70,
+      "crit_space": 85,
+      "warn_inodes": 65,
+      "crit_inodes": 75
+    },
+    ..
+  }
+}
+```
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-disk-usage.rb

@@ -0,0 +1,248 @@
+#!/usr/bin/env ruby
+#
+# check-disk-usage.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-plugin/check/cli'
+require 'json'
+require 'socket'
+require 'sys/filesystem'
+
+class CheckDiskUsage < 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 :config_file,
+         :description => "Optional configuration file (default: #{File.dirname(__FILE__)}/disk-usage.json)",
+         :short => "-c <PATH>",
+         :long => "--config <PATH>",
+         :default => File.dirname(__FILE__) + "/disk-usage.json"
+
+  option :warn_space,
+         :description => "Warn if PERCENT or more of disk space used",
+         :short => "--warn-space <PERCENT>",
+         :proc => proc(&:to_i),
+         :default => 85
+
+  option :crit_space,
+         :description => "Critical if PERCENT or more of disk space used",
+         :short => "--crit-space <PERCENT>",
+         :proc => proc(&:to_i),
+         :default => 95
+
+  option :warn_inodes,
+         :description => "Warn if PERCENT or more of inodes used",
+         :short => "--warn-inodes <PERCENT>",
+         :proc => proc(&:to_i),
+         :default => 85
+
+  option :crit_inodes,
+         :description => "Critical if PERCENT or more of inodes used",
+         :short => "--crit-inodes <PERCENT>",
+         :proc => proc(&:to_i),
+         :default => 95
+
+  option :warn,
+         :description => "Warn instead of throwing a critical failure",
+         :short => "-w",
+         :long => "--warn",
+         :boolean => false
+
+  def initialize()
+    super
+
+    # discover mount points
+    @mounts = get_mounts()
+
+    @json_config = {}
+    if File.exists?(config[:config_file])
+      @json_config = JSON.parse(File.read(config[:config_file]))
+    end
+  end
+
+  def get_mounts()
+    mounts = []
+
+    Sys::Filesystem.mounts.each do |fs|
+      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.mount_point
+    end
+
+    mounts
+  end
+
+  def send_client_socket(data)
+    sock = UDPSocket.new
+    sock.send(data + "\n", 0, "127.0.0.1", 3030)
+  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
+
+    @mounts.uniq.each do |mount|
+      stat = Sys::Filesystem.stat(mount)
+
+      if stat.bytes_total > 0
+        if @json_config.has_key?('mountpoints') and @json_config['mountpoints'].has_key?(mount) and @json_config['mountpoints'][mount].has_key?("warn_space")
+          warn_space = @json_config['mountpoints'][mount]['warn_space']
+        else
+          warn_space = config[:warn_space]
+        end
+
+        if @json_config.has_key?('mountpoints') and @json_config['mountpoints'].has_key?(mount) and @json_config['mountpoints'][mount].has_key?("crit_space")
+          crit_space = @json_config['mountpoints'][mount]['crit_space']
+        else
+          crit_space = config[:crit_space]
+        end
+
+        percent_bytes_used = (100.0 - (100.0 * stat.bytes_free / stat.bytes_total)).round(2)
+
+        check_name = "disk-usage-space-#{mount.gsub('/', '_')}"
+        msg = "Filesystem #{mount} space usage is #{percent_bytes_used}%"
+
+        if percent_bytes_used >= crit_space
+          msg += ", expected < #{crit_space}%"
+          send_critical(check_name, msg)
+          problems += 1
+        elsif percent_bytes_used >= warn_space
+          msg += ", expected < #{warn_space}%"
+          send_warning(check_name, msg)
+          problems += 1
+        else
+          send_ok(check_name, msg)
+        end
+      end
+
+      if stat.inodes > 0
+        if @json_config.has_key?('mountpoints') and @json_config['mountpoints'].has_key?(mount) and @json_config['mountpoints'][mount].has_key?("warn_inodes")
+          warn_inodes = @json_config['mountpoints'][mount]['warn_inodes']
+        else
+          warn_inodes = config[:warn_inodes]
+        end
+
+        if @json_config.has_key?('mountpoints') and @json_config['mountpoints'].has_key?(mount) and @json_config['mountpoints'][mount].has_key?("crit_inodes")
+          crit_inodes = @json_config['mountpoints'][mount]['crit_inodes']
+        else
+          crit_inodes = config[:crit_inodes]
+        end
+
+        percent_inodes_used = (100.0 - (100.0 * stat.inodes_free / stat.inodes)).round(2)
+
+        check_name = "disk-usage-inodes-#{mount.gsub('/', '_')}"
+        msg = "Filesystem #{mount} inodes usage is #{percent_inodes_used}%"
+
+        if percent_inodes_used >= crit_inodes
+          msg += ", expected < #{crit_inodes}%"
+          send_critical(check_name, msg)
+          problems += 1
+        elsif percent_inodes_used >= warn_inodes
+          msg += ", expected < #{warn_inodes}%"
+          send_warning(check_name, msg)
+          problems += 1
+        else
+          send_ok(check_name, msg)
+        end
+      end
+    end
+
+    if problems > 0
+      message "Found #{problems} problems"
+      warning if config[:warn]
+      critical
+    else
+      ok "All mountpoints (#{@mounts.join(', ')}) are OK"
+    end
+  end
+end

data/bin/disk-usage.json.example

@@ -0,0 +1,7 @@
+{
+  "mountpoints": {
+    "/": {
+      "warn_space": 10
+    }
+  }
+}

data/lib/sensu-plugins-disk-usage/version.rb

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

data/lib/sensu-plugins-disk-usage.rb

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-disk-usage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: This plugin provides facilities for monitoring disk usage
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-disk-usage.rb
+- disk-usage.json.example
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-disk-usage.rb
+- bin/disk-usage.json.example
+- lib/sensu-plugins-disk-usage.rb
+- lib/sensu-plugins-disk-usage/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-disk-usage
+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 disk usage
+test_files: []