sensu-plugins-disk-checks 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2128f9ac86a11db57c3c29eb2108ed2e3c4b8989
-  data.tar.gz: 991a1ca89514c39e1e893f04606c2863031cfb93
+  metadata.gz: 6928e842b69da0370f869cc6bb4ad23002b04730
+  data.tar.gz: 11046434136bfc5fb222777795accc7ab1965987
 SHA512:
-  metadata.gz: 382cdbf84b139b3569dd86b5b78fa82aa5595559156fdb391de1a106ac4bbc6e6a216006f752a5fa3f23c3eb2057838a3bb22b443fd3fbbe52c469022c84bd42
-  data.tar.gz: 206c818747e1fb194efbc0e70b11103e89686f32d99c4714d7778676da34d7030dcc552134e8939dea7f10d27e73e80d285892febbb7c328a15fc3c0a8ab28bc
+  metadata.gz: f19fd7cf5136f02b029069cc28e0f7c35121a4de6eeff1839d09b01b509feb6893a7d851dc69b3730514d087e42da95cc05ed211bf0a383619e8f34330f1b69c
+  data.tar.gz: 7c8657194de211450f0fb26555e52f19427aecb7e4d229a6120eaf835894f5d08045cc53f16ab409dbc9b8908d62a0c2bb6f5a5e7dedd5ebeaa0d17dccd2d891

data/CHANGELOG.md

@@ -6,6 +6,33 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ## [Unreleased][unreleased]
 - nothing
 
+## [1.0.3] - 2015-10-25
+### Changed
+- Adds Ignore option(s) to check-disk-usage.rb
+- Adaptive thresholds
+
+### Adaptive Thresholds
+
+This borrows from check_mk's "df" check, which has the ability to
+adaptively adjust thresholds for filesystems based on their sizes.
+
+For example, a hard threshold of "warn at 85%" is quite different
+between small filesystems and very large filesystems -  85% utilization
+of a 20GB filesystem is arguably more serious than 85% utilization of a
+10TB filesystem.
+
+This uses check_mk's original alorithm to optionally adjust the
+percentage thresholds based on size, using a "magic factor", a
+"normalized size", and a "minium size to adjust".
+
+The magic factor defaults to '1.0', which will not adjust thresholds.
+The minimum size defaults to '100' (GB).  Filesystems smaller than this
+will not be adapted.
+
+check_mk's documentation has a lot more information on this, including
+examples of adjustments based on the magic factor:
+https://mathias-kettner.de/checkmk_filesystems.html
+
 ## [1.0.2] - 2015-08-04
 ### Changed
 - general cleanup

data/README.md

@@ -20,6 +20,22 @@ Check disk capacity and inodes based upon the output of df.
 
 Check disk capacity and inodes based upon the gem sys-filesystem.
 
+Can adjust thresholds for larger filesystems by providing a 'magic factor'
+(`-m`).  The default, `1.0`, will not adapt threshold percentages for volumes.
+
+The `-l` option can be used in combination with the 'magic factor' to specify
+the minimum size volume to adjust the thresholds for.
+
+Refer to [check_mk's](https://mathias-kettner.de/checkmk_filesystems.html)
+documentation on adaptive thresholds.
+
+You can also visualize the adjustment using
+[WolframAlpha]([https://www.wolframalpha.com/input/) with the following:
+
+    y = 100 - (100-P)*(N^(1-m))/(x^(1-m)), y = P for x in 0 to 1024
+
+Where P = base percentage, N = normalize factor, and m = magic factor
+
 **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.

data/bin/check-disk-usage.rb

@@ -48,6 +48,11 @@ class CheckDisk < Sensu::Plugin::Check::CLI
          description: 'Ignore mount point(s)',
          proc: proc { |a| a.split(',') }
 
+  option :ignoreopt,
+         short: '-o TYPE[.TYPE]',
+         description: 'Ignore option(s)',
+         proc: proc { |a| a.split('.') }
+
   option :bwarn,
          short: '-w PERCENT',
          description: 'Warn if PERCENT or more of disk full',
@@ -72,6 +77,26 @@ class CheckDisk < Sensu::Plugin::Check::CLI
          proc: proc(&:to_i),
          default: 95
 
+  option :magic,
+         short: '-m MAGIC',
+         description: 'Magic factor to adjust warn/crit thresholds. Example: .9',
+         proc: proc(&:to_f),
+         default: 1.0
+
+  option :normal,
+         short: '-n NORMAL',
+         description: 'Levels are not adapted for filesystems of excatly this '\
+          'size, where levels are reduced for smaller filesystems and raised '\
+          'for larger filesystems.',
+         proc: proc(&:to_f),
+         default: 20
+
+  option :minimum,
+         short: '-l MINIMUM',
+         description: 'Minimum size to adjust (in GB)',
+         proc: proc(&:to_f),
+         default: 100
+
   # Setup variables
   #
   def initialize
@@ -88,6 +113,7 @@ class CheckDisk < Sensu::Plugin::Check::CLI
         next if config[:fstype] && !config[:fstype].include?(line.mount_type)
         next if config[:ignoretype] && config[:ignoretype].include?(line.mount_type)
         next if config[:ignoremnt] && config[:ignoremnt].include?(line.mount_point)
+        next if config[:ignoreopt] && config[:ignoreopt].include?(line.options)
       rescue
         unknown 'An error occured getting the mount info'
       end
@@ -95,6 +121,15 @@ class CheckDisk < Sensu::Plugin::Check::CLI
     end
   end
 
+  # Adjust the percentages based on volume size
+  #
+  def adj_percent(size, percent)
+    hsize = (size / (1024.0 * 1024.0)) / config[:normal].to_f
+    felt  = hsize**config[:magic]
+    scale = felt / hsize
+    100 - ((100 - percent) * scale)
+  end
+
   def check_mount(line)
     fs_info = Filesystem.stat(line.mount_point)
     if fs_info.respond_to?(:inodes) # needed for windows
@@ -106,11 +141,34 @@ class CheckDisk < Sensu::Plugin::Check::CLI
       end
     end
     percent_b = percent_bytes(fs_info)
-    if percent_b >= config[:bcrit]
-      @crit_fs << "#{line.mount_point} #{percent_b}% bytes usage"
-    elsif percent_b >= config[:bwarn]
-      @warn_fs << "#{line.mount_point} #{percent_b}% bytes usage"
+
+    if fs_info.bytes_total < (config[:minimum] * 1_000_000_000)
+      bcrit = config[:bcrit]
+      bwarn = config[:bwarn]
+    else
+      bcrit = adj_percent(fs_info.bytes_total, config[:bcrit])
+      bwarn = adj_percent(fs_info.bytes_total, config[:bwarn])
+    end
+
+    used = to_human(fs_info.bytes_used)
+    total = to_human(fs_info.bytes_total)
+
+    if percent_b >= bcrit
+      @crit_fs << "#{line.mount_point} #{percent_b}% bytes usage (#{used}/#{total})"
+    elsif percent_b >= bwarn
+      @warn_fs << "#{line.mount_point} #{percent_b}% bytes usage (#{used}/#{total})"
+    end
+  end
+
+  def to_human(s)
+    prefix = %w(TiB GiB MiB KiB B)
+    s.to_f
+    i = prefix.length - 1
+    while s > 512 && i > 0
+      s /= 1024
+      i -= 1
     end
+    ((s > 9 || s.modulo(1) < 0.1 ? '%d' : '%.1f') % s) + ' ' + prefix[i]
   end
 
   # Determine the percent inode usage

data/bin/check-smart-status.rb

@@ -119,7 +119,7 @@ class SmartCheckStatus < Sensu::Plugin::Check::CLI
 
   # Main function
   #
-  def run # rubocop:disable all
+  def run
     @smart_attributes = JSON.parse(IO.read(File.dirname(__FILE__) + '/smart.json'), symbolize_names: true)[:smart][:attributes]
     @smart_debug = config[:debug] == 'on'
 
@@ -183,7 +183,7 @@ class SmartCheckStatus < Sensu::Plugin::Check::CLI
       end
 
       # #YELLOW
-      output[dev].split("\n").each do |line| # rubocop:disable Style/Next
+      output[dev].split("\n").each do |line|
         fields = line.split
         if fields.size == 10 && fields[0].to_i != 0 && att_check_list.include?(fields[0].to_i)
           smart_att = @smart_attributes.find { |att| att[:id] == fields[0].to_i }

data/bin/metrics-disk-usage.rb

@@ -96,7 +96,7 @@ class DiskUsageMetrics < Sensu::Plugin::Metric::CLI::Graphite
     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
+    `df -PB#{config[:block_size]} #{config[:local] ? '-l' : ''}`.split("\n").drop(1).each do |line|
       _, _, used, avail, used_p, mnt = line.split
 
       unless %r{/sys|/dev|/run}.match(mnt)

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-disk-checks
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filesystem

metadata.gz.sig

@@ -1,2 +1 @@
-���0s�s�E�b����O��7���)��r!_`�oG�kiM;�q�f�Ns�J��>v��%4s��!7�7��2s&�~��G�)ͺ��R� vjA*d��v�M�.��@B_,F-��4v쭃#��ES�T7u��N9re��}z
�.�ViE��]�/+�;NZj���(�Qg-^��:��h��>�Mӷ�bvń����_)���([��&��4#�����vl.P�����CK�m$O�������Z�
-�~��7
+WG��x:I��+�Rb���t}���+>�C���E>� ��\C/0����es�T"U��&�^v��
)��ku$_ABeA�Kk9Ҧ�w����pZf�<�V{C0��>��׷�
�N�(�Mߋ����iE�`���:D~�L&����|���:]xrNؠ6�k����=�*=?K.�a,5~#]c|��'Ś����X��4��Q�寢�ݛ�ս-���,l��B��r}')�1M������(E�Q��������6µ