sensu-plugins-disk-checks 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ae84371b0313755e6f35d66f15a27c7fd3a5391
-  data.tar.gz: 3a97790fc26b5d294325fec99d69a94a8c4d4cb4
+  metadata.gz: 5d69846d3e98c17975dccd7363228e869ac3b734
+  data.tar.gz: ddcb9c5ee9e02cca40778d1203a5544304a0dc52
 SHA512:
-  metadata.gz: 335e15d42b7fbf28249abe3a7f817a6aab89438b963e962a38858c2226a43cb2eb8fca4c227ffe606b73d474e349043d13fd9ae064e0a13c63e755a17b2625e2
-  data.tar.gz: c7c602682333821a181a5a06d6bf9d736898cb209542213311006193c45975547031def9759aca660232e28c75de1bde7136b4be03dd5c444e9218c4d144cadc
+  metadata.gz: 8313f14f4c20ca876ae5905cec5cef2fea5026c35d2c16f5bc27b2274005e9dc0f601b41818724a581b50d610e5b0484cfcb3e53d351bc5c6140ad01dfcd18cf
+  data.tar.gz: 293372a87d24a68f3e1d7f257ced4ecafd1657c6edd5f18e6afd6761112685e2a22be9fb157b0604d7df71814d305bd9e81a326d03b0a51619cf91738beefe18

data/CHANGELOG.md

@@ -1,10 +1,14 @@
-#Change Log
+# 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]
 
+## [2.4.0] - 2017-07-20
+- check-smart.rb: Add path overrides via smart.json (@ArakniD)
+- check-smart-status.rb: Add path overrides via smart.json (@ArakniD)
+
 ## [2.3.0] - 2017-07-03
 ### Added
 - travis testing on ruby 2.4.1 (@majormoses)
@@ -133,7 +137,9 @@ https://mathias-kettner.de/checkmk_filesystems.html
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.2.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.4.0...HEAD
+[2.4.0]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.3.0...2.4.0
+[2.3.0]: https://github.com/sensu-plugins/sensu-plugins-disk-checks/compare/2.2.0...2.3.0
 [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

data/README.md

@@ -68,7 +68,7 @@ Check the status of SMART offline tests and optionally check if tests were execu
 
 ## Usage
 
-This is a sample input file used by check-smart-status, see the script for further details.
+This is a sample input file used by check-smart-status and check-smart, see the script for further details.
 ```json
 {
   "smart": {
@@ -89,6 +89,12 @@ This is a sample input file used by check-smart-status, see the script for furth
       { "id": 201, "name": "Unc_Soft_read_Err_Rate", "read": "left16bit" },
       { "id": 230, "name": "Life_Curve_Status", "crit_min": 100, "warn_min": 100, "warn_max": 100, "crit_max": 100 }
     ]
+  },
+  "hardware": {
+    "devices": [
+	  { "path": "sda", "ignore" : [ 187 ] },
+	  { "path": "sdb", "override": "/dev/twa0 -d 3ware,0" }
+	]
   }
 }
 ```

data/bin/check-smart-status.rb

@@ -61,6 +61,33 @@
 require 'sensu-plugin/check/cli'
 require 'json'
 
+class Disk
+  # Setup variables
+  #
+  def initialize(name, override, ignore)
+    @device_path = "/dev/#{name}"
+    @override_path = override
+    @att_ignore = ignore
+  end
+
+  # Is the device SMART capable and enabled
+  #
+  def device_path
+    if @override_path.nil?
+      @device_path
+    else
+      @override_path
+    end
+  end
+
+  def smart_ignore?(num)
+    return if @att_ignore.nil?
+    @att_ignore.include? num
+  end
+
+  public :device_path, :smart_ignore?
+end
+
 #
 # Smart Check Status
 #
@@ -130,6 +157,9 @@ class SmartCheckStatus < Sensu::Plugin::Check::CLI
     @smart_attributes = JSON.parse(IO.read(config[:json]), symbolize_names: true)[:smart][:attributes]
     @smart_debug = config[:debug] == 'on'
 
+    # Load in the device configuration
+    @hardware = JSON.parse(IO.read(config[:json]), symbolize_names: true)[:hardware][:devices]
+
     # Set default threshold
     default_threshold = config[:defaults].split(',')
     raise 'Invalid default threshold parameter count' unless default_threshold.size == 4
@@ -160,7 +190,7 @@ class SmartCheckStatus < Sensu::Plugin::Check::CLI
     att_check_list = find_attributes
 
     # Devices to check
-    devices = config[:debug_file].nil? ? find_devices : ['sda']
+    devices = config[:debug_file].nil? ? find_devices : [Disk.new('sda', nil, nil)]
 
     # Overall health and attributes parameter
     parameters = '-H -A'
@@ -174,10 +204,10 @@ class SmartCheckStatus < Sensu::Plugin::Check::CLI
     warnings = []
     criticals = []
     devices.each do |dev|
-      puts "#{config[:binary]} #{parameters} /dev/#{dev}" if @smart_debug
+      puts "#{config[:binary]} #{parameters} #{dev.device_path}" if @smart_debug
       # check if debug file specified
       if config[:debug_file].nil?
-        output[dev] = `sudo #{config[:binary]} #{parameters} /dev/#{dev}`
+        output[dev] = `sudo #{config[:binary]} #{parameters} #{dev.device_path}`
       else
         test_file = File.open(config[:debug_file], 'rb')
         output[dev] = test_file.read
@@ -186,13 +216,13 @@ class SmartCheckStatus < Sensu::Plugin::Check::CLI
 
       # check overall helath status
       if config[:overall] == 'on' && !output[dev].include?('SMART overall-health self-assessment test result: PASSED')
-        criticals << "Overall health check failed on #{dev}"
+        criticals << "Overall health check failed on #{dev.name}"
       end
 
       # #YELLOW
       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)
+        if fields.size == 10 && fields[0].to_i != 0 && att_check_list.include?(fields[0].to_i) && (dev.smart_ignore?(fields[0].to_i) == false)
           smart_att = @smart_attributes.find { |att| att[:id] == fields[0].to_i }
           att_value = fields[9].to_i
           att_value = send(smart_att[:read], att_value) unless smart_att[:read].nil?
@@ -235,24 +265,40 @@ class SmartCheckStatus < Sensu::Plugin::Check::CLI
   # find all devices from /proc/partitions or from parameter
   #
   def find_devices
+    # Search for devices without number
+    devices = []
+
     # Return parameter value if it's defined
-    return config[:devices].split(',') unless config[:devices] == 'all'
+    if config[:devices] != 'all'
+      config[:devices].split(',').each do |dev|
+        devices << Disk.new(dev.to_s, '', nil)
+      end
+      return devices
+    end
 
-    # List all device and split it by new line
-    all = `cat /proc/partitions`.split("\n")
+    `lsblk -nro NAME,TYPE`.each_line do |line|
+      name, type = line.split
 
-    # Delete first two row (header and empty line)
-    (1..2).each { all.delete_at(0) }
+      if type == 'disk'
+        jconfig = @hardware.find { |h1| h1[:path] == name }
 
-    # Search for devices without number
-    devices = []
-    all.each do |line|
-      partition = line.scan(/\w+/).last.scan(/^\D+$/).first
-      next if partition.nil?
-      output = `sudo #{config[:binary]} -i /dev/#{partition}`
-      available = !output.scan(/SMART support is: Available/).empty?
-      enabled = !output.scan(/SMART support is: Enabled/).empty?
-      devices << partition if available && enabled
+        if jconfig.nil?
+          override = nil
+          ignore = nil
+        else
+          override = jconfig[:override]
+          ignore = jconfig[:ignore]
+        end
+
+        device = Disk.new(name, override, ignore)
+
+        output = `sudo #{config[:binary]} -i #{device.device_path}`
+
+        # Check if we can use this device or not
+        available = !output.scan(/SMART support is:\+sAvailable/).empty?
+        enabled = !output.scan(/SMART support is:\+sEnabled/).empty?
+        devices << device if available && enabled
+      end
     end
 
     devices

data/bin/check-smart.rb

@@ -37,6 +37,7 @@
 #
 
 require 'sensu-plugin/check/cli'
+require 'json'
 
 #
 # Disk
@@ -44,11 +45,13 @@ require 'sensu-plugin/check/cli'
 class Disk
   # Setup variables
   #
-  def initialize(name)
+  def initialize(name, override, binary)
     @device_path = "/dev/#{name}"
     @smart_available = false
     @smart_enabled = false
     @smart_healty = nil
+    @smart_binary = binary
+    @override_path = override
     check_smart_capability!
     check_health! if smart_capable?
   end
@@ -61,10 +64,20 @@ class Disk
     @smart_available && @smart_enabled
   end
 
+  # Is the device SMART capable and enabled
+  #
+  def device_path
+    if @override_path.nil?
+      @device_path
+    else
+      @override_path
+    end
+  end
+
   # Check for SMART cspability
   #
   def check_smart_capability!
-    output = `sudo smartctl -i #{@device_path}`
+    output = `sudo #{@smart_binary} -i #{@device_path}`
     @smart_available = !output.scan(/SMART support is:\s+Available/).empty?
     @smart_enabled = !output.scan(/SMART support is:\s+Enabled/).empty?
     @capability_output = output
@@ -73,7 +86,7 @@ class Disk
   # Check the SMART health
   #
   def check_health!
-    output = `sudo smartctl -H #{@device_path}`
+    output = `sudo #{@smart_binary} -H #{@device_path}`
     @smart_healthy = !output.scan(/PASSED|OK$/).empty?
     @health_output = output
   end
@@ -89,11 +102,29 @@ class CheckSMART < Sensu::Plugin::Check::CLI
          proc: proc(&:to_sym),
          default: :unknown
 
+  option :binary,
+         short: '-b path/to/smartctl',
+         long: '--binary /usr/sbin/smartctl',
+         description: 'smartctl binary to use, in case you hide yours',
+         required: false,
+         default: 'smartctl'
+
+  option :json,
+         short: '-j path/to/smart.json',
+         long: '--json path/to/smart.json',
+         description: 'Path to SMART attributes JSON file',
+         required: false,
+         default: File.dirname(__FILE__) + '/smart.json'
+
   # Setup variables
   #
   def initialize
     super
     @devices = []
+
+    # Load in the device configuration
+    @hardware = JSON.parse(IO.read(config[:json]), symbolize_names: true)[:hardware][:devices]
+
     scan_disks!
   end
 
@@ -102,7 +133,22 @@ class CheckSMART < Sensu::Plugin::Check::CLI
   def scan_disks!
     `lsblk -nro NAME,TYPE`.each_line do |line|
       name, type = line.split
-      @devices << Disk.new(name) if type == 'disk'
+
+      if type == 'disk'
+        jconfig = @hardware.find { |h1| h1[:path] == name }
+
+        override = !jconfig.nil? ? jconfig[:override] : nil
+
+        device = Disk.new(name, override, config[:binary])
+
+        output = `sudo #{config[:binary]} -i #{device.device_path}`
+
+        # Check if we can use this device or not
+        available = !output.scan(/SMART support is:\s+Available/).empty?
+        enabled = !output.scan(/SMART support is:\s+Enabled/).empty?
+
+        @devices << device if available && enabled
+      end
     end
   end
 

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

@@ -1,7 +1,7 @@
 module SensuPluginsDiskChecks
   module Version
     MAJOR = 2
-    MINOR = 3
+    MINOR = 4
     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.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-03 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for disk checks