sensu-plugins-disk-checks 0.0.1.alpha.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa3b81d298dd7521cb60c728ee9a27f4b100471e
+  data.tar.gz: 45087c070f23db20b7405de83871fa523319dc87
+SHA512:
+  metadata.gz: 666ea2928769d72dbe5b0744a426f761f9e8d87a024c97b0953ef5772f965d71ebee51875c9ad77f5ebff6eff5b764c15093a074b00638da2b23baa72108d791
+  data.tar.gz: 886067b90da285a1ca28e1f4b76cdc0593fade73a7ba7ca38e5f2125104dc72fbee33c8808b591716346a3b9f15d3add270af5d03c1cb93bb76477c6a6e77c7a

data.tar.gz.sig

@@ -0,0 +1,2 @@
+)"}��D`�kiz{���z�uc���J�1�Kܒ��_ʛ�c"N�
+,���A�_�S�c�}��:d�^a����M�

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+#### 0.1.0-alpha.1
+
+* baseline release identical to **sensu-community-plugins** repo
+* basic yard coverage
+* pinned dependencies
+* built against 1.9.3, 2.0, 2.1
+* cryptographically signed
+
+#### 0.0.1-alpha.2
+
+* bump Vagrant box to Cent 6.6
+* update LICENSE and gemspec authors
+* update README
+* add required Ruby version *>= 1.9.3*
+* add test/spec_help.rb

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 devops@yieldbot.com
+
+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,60 @@
+## Sensu-Plugins-disk-checks
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-disk-checks.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-disk-checks)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-disk-checks.svg)](http://badge.fury.io/rb/sensu-plugins-disk-checks)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-disk-checks/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-disk-checks)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-disk-checks/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-disk-checks)
+
+## Functionality
+
+**check-disk-fail**
+
+Check the output of dmesg for a given set of strings that may correspond to a failure
+
+**check-disk**
+
+Check disk capacity and inodes based upon the output of df.
+
+**check-fs-writeable**
+
+Check to make sure a filesytem is writable.  This will check both proc and do a smoke test of each given mountpoint.  It can also auto-discover mount points in the self namespace.
+
+**check-fstab-mounts**
+
+Check the mount points in */etc/fstab* to ensure they are all accounted for.
+
+**disk-capacity-metrics**
+
+Acquire disk capacity metrics from `df` and convert them to a form usable by graphite
+
+**disk-metrics**
+
+Read */proc/iostats* for disk metrics and put them in a form usable by Graphite.  See [iostats.txt](http://www.kernel.org/doc/Documentation/iostats.txt) for more details.
+
+**disk-usage-metrics**
+
+Based on disk-capacity-metrics.rb by bhenerey and nstielau. The difference here being how the key is defined in graphite and the size we emit to graphite(now using megabytes), inode info has also been dropped.
+
+
+## Files
+ * bin/check-disk-fail.rb
+ * bin/check-process-restart.rb
+ * bin/check-process.rb
+
+## Installation
+
+
+Add the public key (if you haven’t already) as a trusted certificate
+
+```
+gem cert --add <(curl -Ls https://raw.githubusercontent.com/sensu-plugins/sensu-plugins.github.io/master/certs/sensu-plugins.pem)
+gem install <gem> -P MediumSecurity
+```
+
+You can also download the key from /certs/ within each repository.
+
+`gem install sensu-plugins-disk-checks`
+
+Add *sensu-plugins-disk-checks* to your Gemfile, manifest, cookbook, etc
+
+## Notes

data/bin/check-disk-fail.rb

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+#
+#   check-disk-fail
+#
+# DESCRIPTION:
+#   Check for failing disks
+#   Greps through dmesg output looking for indications that a drive is failing.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Coppyright 07/14/2014 Shane Feek and  Alan Smith.
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+
+#
+# Check Disk Fail
+#
+class CheckDiskFail < Sensu::Plugin::Check::CLI
+  # Main function
+  #
+  # Check the contents of dmesg for a set of given strings
+  def run
+    dmesg = `dmesg`.lines
+
+    %w(Read Write Smart).each do |v|
+      found = dmesg.grep(/failed command\: #{v.upcase}/)
+      # #YELLOW
+      unless found.empty?  # rubocop:disable IfUnlessModifier
+        critical "Disk #{v} Failure"
+      end
+    end
+    ok
+  end
+end

data/bin/check-disk.rb

@@ -0,0 +1,157 @@
+#! /usr/bin/env ruby
+#
+#   check-disk
+#
+# DESCRIPTION:
+#   Uses GNU's -T option for listing filesystem type; unfortunately, this
+#   is not portable to BSD. Warning/critical levels are percentages only.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2011 Sonian, Inc <chefs@sonian.net>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+
+#
+# Check Disk
+#
+class CheckDisk < Sensu::Plugin::Check::CLI
+  option :fstype,
+         short: '-t TYPE[,TYPE]',
+         description: 'Only check fs type(s)',
+         proc: proc { |a| a.split(',') }
+
+  option :ignoretype,
+         short: '-x TYPE[,TYPE]',
+         description: 'Ignore fs type(s)',
+         proc: proc { |a| a.split(',') }
+
+  option :ignoremnt,
+         short: '-i MNT[,MNT]',
+         description: 'Ignore mount point(s)',
+         proc: proc { |a| a.split(',') }
+
+  option :ignoreline,
+         short: '-l PATTERN[,PATTERN]',
+         description: 'Ignore df line(s) matching pattern(s)',
+         proc: proc { |a| a.split(',') }
+
+  option :includeline,
+         short: '-L PATTERN[,PATTERN]',
+         description: 'Only include df line(s) matching pattern(s)',
+         proc: proc { |a| a.split(',') }
+
+  option :warn,
+         short: '-w PERCENT',
+         description: 'Warn if PERCENT or more of disk full',
+         proc: proc(&:to_i),
+         default: 85
+
+  option :crit,
+         short: '-c PERCENT',
+         description: 'Critical if PERCENT or more of disk full',
+         proc: proc(&:to_i),
+         default: 95
+
+  option :iwarn,
+         short: '-W PERCENT',
+         description: 'Warn if PERCENT or more of inodes used',
+         proc: proc(&:to_i),
+         default: 85
+
+  option :icrit,
+         short: '-K PERCENT',
+         description: 'Critical if PERCENT or more of inodes used',
+         proc: proc(&:to_i),
+         default: 95
+
+  option :debug,
+         short: '-d',
+         long: '--debug',
+         description: 'Output list of included filesystems'
+
+  # Setup variables
+  #
+  def initialize
+    super
+    @crit_fs = []
+    @warn_fs = []
+    @line_count = 0
+  end
+
+  # Read the output of `df` spliting the lines based upon their fields
+  # This will check both blocks and inodes
+  def read_df
+    `df -lPT`.split("\n").drop(1).each do |line|
+      begin
+        _fs, type, _blocks, _used, _avail, capacity, mnt = line.split
+        next if config[:includeline] && !config[:includeline].find { |x| line.match(x) }
+        next if config[:fstype] && !config[:fstype].include?(type)
+        next if config[:ignoretype] && config[:ignoretype].include?(type)
+        next if config[:ignoremnt] && config[:ignoremnt].include?(mnt)
+        next if config[:ignoreline] && config[:ignoreline].find { |x| line.match(x) }
+        puts line if config[:debug]
+      rescue
+        unknown "malformed line from df: #{line}"
+      end
+      @line_count += 1
+      if capacity.to_i >= config[:crit]
+        @crit_fs << "#{mnt} #{capacity}"
+      elsif capacity.to_i >= config[:warn]
+        @warn_fs <<  "#{mnt} #{capacity}"
+      end
+    end
+
+    `df -lPTi`.split("\n").drop(1).each do |line|
+      begin
+        _fs, type, _inodes, _used, _avail, capacity, mnt = line.split
+        next if config[:includeline] && !config[:includeline].find { |x| line.match(x) }
+        next if config[:fstype] && !config[:fstype].include?(type)
+        next if config[:ignoretype] && config[:ignoretype].include?(type)
+        next if config[:ignoremnt] && config[:ignoremnt].include?(mnt)
+        next if config[:ignoreline] && config[:ignoreline].find { |x| line.match(x) }
+        puts line if config[:debug]
+      rescue
+        unknown "malformed line from df: #{line}"
+      end
+      @line_count += 1
+      if capacity.to_i > config[:icrit]
+        @crit_fs << "#{mnt} inodes #{capacity}"
+      elsif capacity.to_i >= config[:iwarn]
+        @warn_fs << "#{mnt} inodes #{capacity}"
+      end
+    end
+  end
+
+  # Generate output
+  #
+  def usage_summary
+    (@crit_fs + @warn_fs).join(', ')
+  end
+
+  # Main function
+  #
+  def run
+    unknown 'Do not use -l and -L options concurrently' if config[:includeline] && config[:ignoreline]
+    read_df
+    unknown 'No filesystems found' unless @line_count > 0
+    critical usage_summary unless @crit_fs.empty?
+    warning usage_summary unless @warn_fs.empty?
+    ok "All disk usage under #{config[:warn]}% and inode usage under #{config[:iwarn]}%"
+  end
+end

data/bin/check-fs-writable.rb

@@ -0,0 +1,143 @@
+#! /usr/bin/env ruby
+#
+# check-fs-writable
+#
+# DESCRIPTION:
+# This plugin checks that a filesystem is writable. Useful for checking for stale NFS mounts.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   all
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rubysl-tempfile
+#
+# USAGE:
+#   ./check-fs-writable.rb --auto  (check all volgroups in fstab)
+#   ./check-fs-writable.rb --dir /,/var,/usr,/home  (check a defined list of directories)
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2014 Yieldbot, Inc  <devops@yieldbot.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'tempfile'
+
+#
+# Check Filesystem Writable
+#
+class CheckFSWritable < Sensu::Plugin::Check::CLI
+  option :dir,
+         description: 'Directory to check for writability',
+         short: '-d DIRECTORY',
+         long: '--directory DIRECTORY',
+         proc: proc { |a| a.split(',') }
+
+  option :auto,
+         description: 'Auto discover mount points via fstab',
+         short: '-a',
+         long: '--auto-discover'
+
+  option :debug,
+         description: 'Print debug statements',
+         long: '--debug'
+
+  # Setup variables
+  #
+  def initialize
+    super
+    @crit_pt_proc = []
+    @crit_pt_test = []
+  end
+
+  # Generate output
+  #
+  def usage_summary
+    if @crit_pt_test.empty? && @crit_pt_proc.empty?
+      ok 'All filesystems are writable'
+    elsif @crit_pt_test || @crit_pt_proc
+      critical "The following file systems are not writeable: #{ @crit_pt_test }, #{@crit_pt_proc}"
+    end
+  end
+
+  # Get the mount points from the self namespace
+  #
+  def acquire_mnt_pts
+    `grep VolGroup /proc/self/mounts | awk '{print $2, $4}' | awk -F, '{print $1}' | awk '{print $1, $2}'`
+  end
+
+  # Does proc list the mount point as rw
+  #
+  def rw_in_proc?(mount_info)
+    mount_info.each  do |pt|
+      @crit_pt_proc <<  "#{ pt.split[0] }" if pt.split[1] != 'rw'
+    end
+  end
+
+  # Create a tempfile at each mount point and attempt to write a line to it
+  # If it can't write the line, or the mount point does not exist it will
+  # generate a critical error
+  #
+  def rw_test?(mount_info)
+    mount_info.each do |pt|
+      (Dir.exist? pt.split[0]) || (@crit_pt_test << "#{ pt.split[0] }")
+      file = Tempfile.new('.sensu', pt.split[0])
+      puts "The temp file we are writing to is: #{ file.path }" if config[:debug]
+      # #YELLOW
+      #  need to add a check here to validate permissions, if none it pukes
+      file.write('mops') || @crit_pt_test <<  "#{ pt.split[0] }"
+      file.read || @crit_pt_test <<  "#{ pt.split[0] }"
+      file.close
+      file.unlink
+    end
+  end
+
+  # Auto-generate a list of mount points to check based upon the self
+  # namespace in proc
+  #
+  def auto_discover
+    # #YELLOW
+    # this will only work for a single namespace as of now
+    mount_info = acquire_mnt_pts.split("\n")
+    warning 'No mount points found' if mount_info.length == 0
+    # #YELLOW
+    #  I want to map this at some point to make it pretty and eaiser to read for large filesystems
+    puts 'This is a list of mount_pts and their current status: ', mount_info if config[:debug]
+    rw_in_proc?(mount_info)
+    rw_test?(mount_info)
+    puts "The critical mount points according to proc are: #{ @crit_pt_proc }" if config[:debug]
+    puts "The critical mount points according to actual testing are: #{ @crit_pt_test }" if config[:debug]
+  end
+
+  # Create a tempfile as each mount point and attempt to write a line to it
+  # If it can't write the line, or the mount point does not exist it will
+  # generate a critical error
+  #
+  def manual_test
+    config[:dir].each do |d|
+      (Dir.exist? d) || (@crit_pt_test << "#{ d }")
+      file = Tempfile.new('.sensu', d)
+      puts "The temp file we are writing to is: #{ file.path }" if config[:debug]
+      # #YELLOW
+      #  need to add a check here to validate permissions, if none it pukes
+      file.write('mops') || @crit_pt_test <<  "#{ d }"
+      file.read || @crit_pt_test <<  "#{ d }"
+      file.close
+      file.unlink
+    end
+  end
+
+  # Main function
+  #
+  def run
+    (auto_discover if config[:auto]) || (manual_test if config[:dir]) || (warning 'No directorties to check')
+    usage_summary
+  end
+end

data/bin/check-fstab-mounts.rb

@@ -0,0 +1,81 @@
+#! /usr/bin/env ruby
+#
+#   check-fstab-mounts
+#
+# DESCRIPTION:
+#   Check /etc/mtab to ensure all filesystems of the requested type(s) from
+#   fstab are currently mounted.  If no fstypes are specified, will check all
+#   entries in fstab.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: pathname
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Peter Fern <ruby@0xc0dedbad.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'pathname'
+
+#
+# Check Fstab Mounts
+#
+class CheckFstabMounts < Sensu::Plugin::Check::CLI
+  option :fstypes,
+         description: 'Filesystem types to check, comma-separated',
+         short: '-t TYPES',
+         long: '--types TYPES',
+         proc: proc { |a| a.split(',') },
+         required: false
+
+  # Setup variables
+  #
+  def initialize
+    super
+    @fstab = IO.readlines '/etc/fstab'
+    @mtab = IO.readlines '/etc/mtab'
+    @swap_mounts = IO.readlines '/proc/swaps'
+    @missing_mounts = []
+  end
+
+  # Check by mount destination (col 2 in fstab and proc/mounts)
+  #
+  def check_mounts
+    @fstab.each do |line|
+      next if line =~ /^\s*#/
+      next if line =~ /^\s*$/
+      fields = line.split(/\s+/)
+      next if fields[1] == 'none' || (fields[3].include? 'noauto')
+      next if config[:fstypes] && !config[:fstypes].include?(fields[2])
+      if fields[2] != 'swap'
+        @missing_mounts << fields[1] if @mtab.select { |m| m.split(/\s+/)[1] == fields[1] }.empty?
+      else
+        @missing_mounts << fields[1] if @swap_mounts.select { |m| m.split(/\s+/)[0] == Pathname.new(fields[0]).realpath.to_s }.empty?
+      end
+    end
+  end
+
+  # Main function
+  #
+  def run
+    check_mounts
+    if @missing_mounts.any?
+      critical "Mountpoint(s) #{@missing_mounts.join(',')} not mounted!"
+    else
+      ok 'All mountpoints accounted for'
+    end
+  end
+end

data/bin/disk-capacity-metrics.rb

@@ -0,0 +1,114 @@
+#! /usr/bin/env ruby
+#  encoding: UTF-8
+#
+#   disk-capacity-metrics
+#
+# DESCRIPTION:
+#   This plugin uses df to collect disk capacity metrics
+#   disk-metrics.rb looks at /proc/stat which doesnt hold capacity metricss.
+#   could have intetrated this into disk-metrics.rb, but thought I'd leave it up to
+#   whomever implements the checks.
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: socket
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2012 Sonian, Inc <chefs@sonian.net>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+#
+# Disk Capacity
+#
+class DiskCapacity < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to .$parent.$child',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.disk"
+
+  # Unused ?
+  #
+  def convert_integers(values)
+    values.each_with_index do |value, index|
+      begin
+        converted = Integer(value)
+        values[index] = converted
+        # #YELLOW
+      rescue ArgumentError # rubocop:disable HandleExceptions
+      end
+    end
+    values
+  end
+
+  # Main function
+  #
+  def run
+    # Get capacity metrics from DF as they don't appear in /proc
+    `df -PT`.split("\n").drop(1).each do |line|
+      begin
+        fs, _type, _blocks, used, avail, capacity, _mnt = line.split
+
+        timestamp = Time.now.to_i
+        if fs.match('/dev')
+          fs = fs.gsub('/dev/', '')
+          metrics = {
+            disk: {
+              "#{fs}.used" => used,
+              "#{fs}.avail" => avail,
+              "#{fs}.capacity" => capacity.gsub('%', '')
+            }
+          }
+          metrics.each do |parent, children|
+            children.each do |child, value|
+              output [config[:scheme], parent, child].join('.'), value, timestamp
+            end
+          end
+        end
+      rescue
+        unknown "malformed line from df: #{line}"
+      end
+    end
+
+    # Get inode capacity metrics
+    `df -Pi`.split("\n").drop(1).each do |line|
+      begin
+        fs, _inodes, used, avail, capacity, _mnt = line.split
+
+        timestamp = Time.now.to_i
+        if fs.match('/dev')
+          fs = fs.gsub('/dev/', '')
+          metrics = {
+            disk: {
+              "#{fs}.iused" => used,
+              "#{fs}.iavail" => avail,
+              "#{fs}.icapacity" => capacity.gsub('%', '')
+            }
+          }
+          metrics.each do |parent, children|
+            children.each do |child, value|
+              output [config[:scheme], parent, child].join('.'), value, timestamp
+            end
+          end
+        end
+      rescue
+        unknown "malformed line from df: #{line}"
+      end
+    end
+    ok
+  end
+end

data/bin/disk-metrics.rb

@@ -0,0 +1,70 @@
+#! /usr/bin/env ruby
+#  encoding: UTF-8
+#
+#   disk-metrics
+#
+# DESCRIPTION:
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: socket
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2012 Sonian, Inc <chefs@sonian.net>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+#
+# Disk Graphite
+#
+class DiskGraphite < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.disk"
+
+  # this option uses lsblk to convert the dm-<whatever> name to the LVM name.
+  # sample metric scheme without this:
+  # <hostname>.disk.dm-0
+  # sample metric scheme with this:
+  # <hostname>.disk.vg-root
+  option :convert,
+         description: 'Convert devicemapper to logical volume name',
+         short: '-c',
+         long: '--convert',
+         default: false
+
+  # Main function
+  def run
+    # http://www.kernel.org/doc/Documentation/iostats.txt
+    metrics = %w(reads readsMerged sectorsRead readTime writes writesMerged sectorsWritten writeTime ioInProgress ioTime ioTimeWeighted)
+
+    File.open('/proc/diskstats', 'r').each_line do |line|
+      stats = line.strip.split(/\s+/)
+      _major, _minor, dev = stats.shift(3)
+      if config[:convert]
+        dev = `lsblk -P -o NAME /dev/"#{dev}"| cut -d\\" -f2`.lines.first.chomp! if dev =~ /^dm-.*$/
+      end
+      next if stats == ['0'].cycle.take(stats.size)
+
+      metrics.size.times { |i| output "#{config[:scheme]}.#{dev}.#{metrics[i]}", stats[i] }
+    end
+
+    ok
+  end
+end

data/bin/disk-usage-metrics.rb

@@ -0,0 +1,121 @@
+#! /usr/bin/env ruby
+#  encoding: UTF-8
+#
+#   disk-usage-metrics
+#
+# DESCRIPTION:
+#   This plugin uses df to collect disk capacity metrics
+#   disk-usage-metrics.rb looks at /proc/stat which doesnt hold capacity metricss.
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: socket
+#
+# USAGE:
+#
+# NOTES:
+#   Based on disk-capacity-metrics.rb by bhenerey and nstielau
+#   The difference here being how the key is defined in graphite and the
+#   size we emit to graphite(now using megabytes). Also i dropped inode info.
+#   Using this as an example
+#   Filesystem                                 Size  Used Avail Use% Mounted on
+#   /dev/mapper/precise64-root                  79G  3.5G   72G   5% /
+#   /dev/sda1                                  228M   25M  192M  12% /boot
+#   /dev/sdb1                                   99G    2G   97G   2% /media/sda1
+#   The keys with this plugin will be
+#    disk_usage.root, disk_usage.root.boot, and disk_usage.root.media.sda1
+#    instead of disk.dev.mapper.precise64-root, disk.sda1, and disk.sda2
+#
+#   Use --flatten option to reduce graphite "tree" by using underscores rather
+#   then dots for subdirs. Also eliminates 'root' on mounts other than '/'.
+#   Keys with --flatten option would be
+#    disk_usage.root, disk_usage.boot, and disk_usage.media_sda1
+#
+#   Mountpoints can be specifically included or ignored using -i or -I options:
+#     e.g. disk-usage-metric.rb -i ^/boot,^/media
+#
+# LICENSE:
+#   Copyright 2012 Sonian, Inc <chefs@sonian.net>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+#
+# Disk Usage Metrics
+#
+class DiskUsageMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to .$parent.$child',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.disk_usage"
+
+  option :ignore_mnt,
+         description: 'Ignore mounts matching pattern(s)',
+         short: '-i MNT[,MNT]',
+         long: '--ignore-mount',
+         proc: proc { |a| a.split(',') }
+
+  option :include_mnt,
+         description: 'Include only mounts matching pattern(s)',
+         short: '-I MNT[,MNT]',
+         long: '--include-mount',
+         proc: proc { |a| a.split(',') }
+
+  option :flatten,
+         description: 'Output mounts with underscore rather than dot',
+         short: '-f',
+         long: '--flatten',
+         boolean: true,
+         default: false
+
+  option :local,
+         description: 'Only check local filesystems (df -l option)',
+         short: '-l',
+         long: '--local',
+         boolean: true,
+         default: false
+
+  option :block_size,
+         description: 'Set block size for sizes printed',
+         short: '-B BLOCK_SIZE',
+         long: '--block-size BLOCK_SIZE',
+         default: 'M'
+
+  # Main function
+  #
+  def run
+    delim = config[:flatten] == true ? '_' : '.'
+    # Get disk usage from df with used and avail in megabytes
+    # #YELLOW
+    `df -PB#{config[:block_size]} #{config[:local] ? '-l' : ''}`.split("\n").drop(1).each do |line| # rubocop:disable Style/Next
+      _, _, used, avail, used_p, mnt = line.split
+
+      unless %r{/sys|/dev|/run}.match(mnt)
+        next if config[:ignore_mnt] && config[:ignore_mnt].find { |x| mnt.match(x) }
+        next if config[:include_mnt] && !config[:include_mnt].find { |x| mnt.match(x) }
+        if config[:flatten]
+          mnt = mnt.eql?('/') ? 'root' : mnt.gsub(/^\//, '')
+        else
+          # If mnt is only / replace that with root if its /tmp/foo
+          # replace first occurance of / with root.
+          mnt = mnt.length == 1 ? 'root' : mnt.gsub(/^\//, 'root.')
+        end
+        # Fix subsequent slashes
+        mnt = mnt.gsub '/', delim
+        output [config[:scheme], mnt, 'used'].join('.'), used.gsub(config[:block_size], '')
+        output [config[:scheme], mnt, 'avail'].join('.'), avail.gsub(config[:block_size], '')
+        output [config[:scheme], mnt, 'used_percentage'].join('.'), used_p.gsub('%', '')
+      end
+    end
+    ok
+  end
+end

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

@@ -0,0 +1,7 @@
+#
+# Set gem version
+#
+module SensuPluginsDiskChecks
+  # Gem version
+  VERSION = '0.0.1.alpha.2'
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-disk-checks
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha.2
+platform: ruby
+authors:
+- Yieldbot, Inc. and contributors
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDgDCCAmigAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRIwEAYDVQQDDAltYXR0
+  am9uZXMxGDAWBgoJkiaJk/IsZAEZFgh5aWVsZGJvdDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0xNTAxMjgyMTAyNTFaFw0xNjAxMjgyMTAyNTFaMEMxEjAQBgNVBAMM
+  CW1hdHRqb25lczEYMBYGCgmSJomT8ixkARkWCHlpZWxkYm90MRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyTSzVYnO
+  CLgyrIyT1mBQakArQyW8xhi6MlDqyzXHJGeERT790U6EgoBVeS4XoK0ptFZNR8Tf
+  zko0w+Nv47TarSCgkPOaxY+mxWnAVR10dOmfeLr7huiMyps+YD56/EF2FqQ3jf/+
+  qohENfKD91qy1ieEy+Fn7Pf74ltbNKUdkb9a9eFXQ0DQ4ip5vik7DzjQkUTj4lca
+  k6ArwnmHX4YDhZoYtrQJ8jVktN0/+NtA40M5qkCYHNe5tUW25b/tKVYuioxG6b2Z
+  oIzaZxRLxf6HVAWpCVRT/F5+/yjigkX4u++eYacfLGleXQzoK7BL65vHGMJygWEE
+  0TKGqFOrl/L0AQIDAQABo38wfTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+  HQ4EFgQUEf6a8Td7MrSZc8ImbLFZAENPbz0wIQYDVR0RBBowGIEWbWF0dGpvbmVz
+  QHlpZWxkYm90LmNvbTAhBgNVHRIEGjAYgRZtYXR0am9uZXNAeWllbGRib3QuY29t
+  MA0GCSqGSIb3DQEBBQUAA4IBAQBbzXAYA3BVGw8DZ0YYoY1VHPNEcH5qPIApmHO8
+  rvSmuUT0yMEi7u00H/5uHRFf4LleGT/+sTdyXKsNPGT9kdRuQEgwi+vf7Zfvd8aX
+  UF/+4VkEYf/8rV8Ere6u2QaWPgApdMV6JjKr1fAwCTd8AuGXNaWItiPPMseSQzLJ
+  JKP4hVvbc1d+oS925B1lcBiqn2aYvElbyNAVmQPywNNqkWmvtlqj9ZVJfV5HQLdu
+  8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
+  HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
+  -----END CERTIFICATE-----
+date: 2015-02-01 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.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sensu disk checks
+email: <sensu-users@googlegroups.com>
+executables:
+- check-disk-fail.rb
+- check-disk.rb
+- check-fs-writable.rb
+- check-fstab-mounts.rb
+- disk-capacity-metrics.rb
+- disk-metrics.rb
+- disk-usage-metrics.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/check-disk-fail.rb
+- bin/check-disk.rb
+- bin/check-fs-writable.rb
+- bin/check-fstab-mounts.rb
+- bin/disk-capacity-metrics.rb
+- bin/disk-metrics.rb
+- bin/disk-usage-metrics.rb
+- lib/sensu-plugins-disk-checks.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+homepage: https://github.com/sensu-plugins/sensu-plugins-disk-checks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Sensu disk checks
+test_files: []
+has_rdoc: