sensu-plugins-disk-checks 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84f05a4a6178a02e5798248cd1c67eadcb6235e2
-  data.tar.gz: fa409bbe0762c858f885127cb29633e397a57ca4
+  metadata.gz: 0a0594b4df04654a37e7b4d624dde2b98f05ddb0
+  data.tar.gz: 2d9517a0bfe0d24326eb36b8445227ad4081399d
 SHA512:
-  metadata.gz: e66515d72f04a69716714af53fae709d47ad377f35f7fc2ebec35d8ce5d86f3602fc064f3a973e582374c1dc31323fcf04dbec6be7072c37cfe459c6702b90c0
-  data.tar.gz: 6170411f699673da8e69ca097cd3df92224fedd8b76e68ce4b56fdb2572994ae15ffcf64e87e4e1fe575cbf305c78ee21bbc71d909c26f596b9bb7ed51e70fa5
+  metadata.gz: 58ad8ffee7a966ae83f9ac3665d0eb79c18d2f9fd03abd53559fa10103c84e52441aed239f4701d0839c6d2c7036a23a7c605863900ea4e671dd6405cddaaea0
+  data.tar.gz: c88d37c9f50bd289c288daaaa764742f2011ce5a3fcc46b3b01fe62852305eb4c84bc7a37962e825cfae189edbd98d15ba856e0b4dcf442a6f76a4a94a04f355

data/CHANGELOG.md

@@ -4,6 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
+
+## [2.2.0] - 2017-06-24
+### Added
+- check-smart-tests.rb: a plugin to check S.M.A.R.T. self tests status (@sndl)
+
 ## [2.1.0] - 2017-05-04
 ### Changed
 - check-disk-usage.rb: show the decimals for disk usage figures
@@ -119,7 +124,8 @@ https://mathias-kettner.de/checkmk_filesystems.html
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.1.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.2.0...HEAD
+[2.2.0]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.0.1...2.1.0
 [2.0.1]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/1.1.3...2.0.0

data/README.md

@@ -52,11 +52,16 @@ Check the SMART status of hardrives and alert based upon a given set of threshol
 
 Check the health of a disk using `smartctl`
 
+**check-smart-tests**
+
+Check the status of SMART offline tests and optionally check if tests were executed in a specified interval
+
 ## Files
  * bin/check-disk-usage.rb
  * bin/check-fstab-mounts.rb
  * bin/check-smart-status.rb
  * bin/check-smart.rb
+ * bin/check-smart-tests.rb
  * bin/metrics-disk.rb
  * bin/metrics-disk-capacity.rb
  * bin/metrics-disk-usage.rb

data/bin/check-smart-tests.rb

@@ -0,0 +1,179 @@
+#! /usr/bin/env ruby
+#
+#   check-smart-tests.rb
+#
+# DESCRIPTION:
+#   This script checks S.M.A.R.T. self-tests status and optionally time of last
+#   test run
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+# check-smart-tests.rb # Use default options
+# check-smart-tests.rb -d /dev/sda,/dev/sdb -l 24 -t 336 # Check smart tests status for
+#   /dev/sda and /dev/sdb devices, also check if short tests were run in last 24 hours and
+#   extended tests were run in last 14 days(336 hours)
+#
+# NOTES:
+#   The plugin requires smartmontools to be installed and smartctl utility in particular.
+#
+#   smartctl requires root rights to run, so you should allow sensu to execute
+#   this command as root without password by adding following line to /etc/sudoers:
+#
+#   sensu ALL=(ALL) NOPASSWD: /usr/sbin/smartctl
+#
+#   Tested only on Debian.
+#
+# LICENSE:
+#   Stanislav Sandalnikov <s.sandalnikov@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+
+require 'sensu-plugin/check/cli'
+
+class Device
+  attr_accessor :name, :pwh, :str
+
+  def initialize(name, smartctl_executable)
+    @name = name
+    @exec = smartctl_executable
+    @pwh = poweron_hours
+    @str = selftest_results
+  end
+
+  def poweron_hours
+    `sudo #{@exec} -A #{@name}`.split("\n").each do |line|
+      columns = line.split
+      if columns[1] == 'Power_On_Hours'
+        return columns[9]
+      end
+    end
+  end
+
+  def selftest_results
+    results = []
+    headers = %w(num test_description status remaining lifetime lba_of_first_error)
+
+    `sudo #{@exec} -l selftest #{@name}`.split("\n").grep(/^#/).each do |test|
+      test = test.gsub!(/\s\s+/m, "\t").split("\t")
+      res = {}
+
+      headers.each_with_index do |v, k|
+        res[v] = test[k]
+      end
+
+      results << res
+    end
+
+    results
+  end
+end
+
+class CheckSMARTTests < Sensu::Plugin::Check::CLI
+  option :executable,
+         long:  '--executable EXECUTABLE',
+         short: '-e EXECUTABLE',
+         default: '/usr/sbin/smartctl',
+         description: 'Path to smartctl executable'
+  option :devices,
+         long: '--devices *DEVICES',
+         short: '-d *DEVICES',
+         default: 'all',
+         description: 'Comma-separated list of devices to check, i.e. "/dev/sda,/dev/sdb"'
+  option :short_test_interval,
+         long: '--short_test_interval INTERVAL',
+         short: '-s INTERVAL',
+         description: 'If more time then this value passed since last short test run, then warning will be raised'
+  option :long_test_interval,
+         long: '--long_test_interval INTERVAL',
+         short: '-l INTERVAL',
+         description: 'If more time then this value passed since last extedned test run, then warning will be raised'
+
+  def initialize
+    super
+    @devices = []
+    @warnings = []
+    @criticals = []
+    set_devices
+  end
+
+  def set_devices
+    if config[:devices] == 'all'
+      `lsblk -plnd -o NAME`.split.each do |name|
+        unless name =~ /\/dev\/loop.*/
+          dev = Device.new(name, config[:executable])
+          @devices.push(dev)
+        end
+      end
+    else
+      config[:devices].split(',').each do |name|
+        dev = Device.new(name, config[:executable])
+        @devices.push(dev)
+      end
+    end
+  end
+
+  def check_tests(dev)
+    if dev.str.empty?
+      @warnings << "#{dev.name}: No self-tests have been logged."
+      return
+    end
+
+    unless dev.str[0]['status'] == 'Completed without error' || dev.str[0]['status'] =~ /Self-test routine in progress/
+      @criticals << "#{dev.name}: Last test failed - #{dev.str[0]['status']}"
+    end
+
+    unless config[:short_test_interval].nil?
+      dev.str.each_with_index do |t, i|
+        if t['test_description'] != 'Short offline'
+          if i == dev.str.length - 1
+            @warnings << "#{dev.name}: No short tests were run for this device in last #{dev.str.length} executions"
+          end
+          next
+        else
+          if dev.pwh.to_i - t['lifetime'].to_i > config[:short_test_interval].to_i
+            @warnings << "#{dev.name}: More than #{config[:short_test_interval]} hours passed since the last short test"
+          end
+          break
+        end
+      end
+    end
+
+    unless config[:long_test_interval].nil?
+      dev.str.each_with_index do |t, i|
+        if t['test_description'] != 'Extended offline'
+          if i == dev.str.length - 1
+            @warnings << "#{dev.name}: No extended tests were run for this device in last #{dev.str.length} executions"
+          end
+          next
+        else
+          if dev.pwh.to_i - t['lifetime'].to_i > config[:long_test_interval].to_i
+            @warnings << "#{dev.name}: More than #{config[:long_test_interval]} hours passed since the last extended test"
+          end
+          break
+        end
+      end
+    end
+  end
+
+  def run
+    @devices.each do |device|
+      check_tests(device)
+    end
+
+    if @criticals.any?
+      critical @criticals.join(' ')
+    elsif @warnings.any?
+      warning @warnings.join(' ')
+    else
+      ok 'All devices are OK'
+    end
+  end
+end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-disk-checks
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -173,6 +173,7 @@ executables:
 - check-disk-usage.rb
 - check-fstab-mounts.rb
 - check-smart-status.rb
+- check-smart-tests.rb
 - check-smart.rb
 - metrics-disk-capacity.rb
 - metrics-disk-usage.rb
@@ -186,6 +187,7 @@ files:
 - bin/check-disk-usage.rb
 - bin/check-fstab-mounts.rb
 - bin/check-smart-status.rb
+- bin/check-smart-tests.rb
 - bin/check-smart.rb
 - bin/metrics-disk-capacity.rb
 - bin/metrics-disk-usage.rb