sensu-plugins-hardware 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b0808938e170d4f1c1c5d5d0800f71244799bb078b4d7fa393bb84deb40f93b
-  data.tar.gz: aa3f027ae6110b8b7f8a6670b631d33f1f8e87157d230e097f4dca26c7470b0c
+  metadata.gz: add709f0d1e2d01a5c413288108b35aba31da5969574d89202d89642ae5d71c5
+  data.tar.gz: bc700abd5e7165dd0c0cd304cadc0dbe76505deb0e2b3cb034fe8e5cbb693964
 SHA512:
-  metadata.gz: 38409723515a4b590f3faac6f6866b0b7218947b83106e550cfac36c733cff32e7d3e8c735f948fa5423207eabd6372bd60963b3779124abed442fbc77b0d7bd
-  data.tar.gz: 35f506342c62ad47eeb9f69f5e4e51e469faf3356a9e941f0cf00e365e9827b6823c3d220598ba2ca21e0558cd3caaafe79ea275160c97b7f158142b7a45cb00
+  metadata.gz: 6128d23dd44c90d1584a8e7d19436e5a1ef21a620d5e4fdf87f19b61a91e5186cb89cd11fda23834c0e666d1ac59501f4f012d325ee0adeb469f88a782282efb
+  data.tar.gz: 93305d33ec53cd2dcca52fbc5c9ad90b5abd42cfc4f9e822d9e09c7ca3a828463cc590f27a740a62809abffdb538b3348f0a42b7432636000e4425c2a4bdb3f5

data/CHANGELOG.md

@@ -1,10 +1,22 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+This CHANGELOG follows the format listed at [Our CHANGELOG Guidelines](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 ## [Unreleased]
 
+## [1.3.0] - 2017-12-05
+### Added
+- Options `--facility`, `--level` and `--kernel` to restrict dmesg output on linux OS (@epierotto)
+- Option `--seconds` to specify the amount of seconds to lookbehind on dmesg output on linux OS (@epierotto)
+- Options validation to prevent running incompatible arguments (@epierotto)
+
+### Changed
+- updated changelog guidelines location (@majormoses)
+- Replaced the use of `tail` and `head` commands when specifying the option `--invert`, now uses pure ruby (@epierotto)
+- Updated rubocop version to 0.49.0 (@epierotto)
+- Rubocop test pass (@epierotto)
+
 ## [1.2.0] - 2017-11-02
 ### Changed
 - check-hardware-fail.rb: Return the actual and entire query line match if found (@phantasm66)
@@ -44,7 +56,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Changed
 - removed cruft from /lib
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-hardware/compare/1.2.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-hardware/compare/1.3.0...HEAD
+[1.3.0]: https://github.com/sensu-plugins/sensu-plugins-hardware/compare/1.2.0...1.3.0
 [1.2.0]: https://github.com/sensu-plugins/sensu-plugins-hardware/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/sensu-plugins/sensu-plugins-hardware/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-hardware/compare/0.0.4...1.0.0

data/README.md

@@ -7,14 +7,57 @@
 [![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-hardware.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-hardware)
 
 ## Functionality
+**check-hardware-fail** will lookup in the output of `dmesg` for lines matching a provided query, it accepts `--facility`, `--level` and `--kernel` options to run `dmesg` command. Returns CRITICAL if any occurrence is found and UNKNOWN if provided options are invalid or the command execution fails.
 
 ## Files
  * bin/check-hardware-fail
 
 ## Usage
+```
+Usage: ./check-hardware-fail.rb (options)
+    -f FACILITY[,FACILITY],          Restrict output to defined facilities. Supported log facilities: kern,user,mail,daemon,auth,syslog,lpr,news
+        --facility
+        --invert                     Invert order
+    -k, --kernel                     Include kernel messages
+    -L, --level LEVEL[,LEVEL]        Restrict output to defined levels, otherwise all levels are included. Supported log levels: emerg,alert,crit,err,warn,notice,info,debug
+    -l, --lines NUMBER               Maximum number of lines to read from dmesg, 0 (default) means all
+    -q, --query QUERY                What pattern to look for in the output of dmesg (regex or literal)
+    -s, --seconds SECONDS            Amount of seconds to lookbehind from dmesg output. This option is incompatible with --lines
+```
+
+Example of usage:
+
+Check the first 100 lines for 'killed as a result of limit'
+```
+check-hardware-fail.rb -l 100 --invert -q 'killed as a result of limit'
+```
+
+Check the last 100 lines for 'killed as a result of limit'
+```
+check-hardware-fail.rb -l 100 -q 'killed as a result of limit'
+```
+
+
+The following options are only available for linux OS:
+
+* `--seconds` Amount of seconds to lookbehind from dmesg output. This option is incompatible with `--lines`
+* `--facility` Restrict output to defined facilities. Supported log facilities: `kern,user,mail,daemon,auth,syslog,lpr,news`
+* `--level` Restrict output to defined levels, otherwise all levels are included. Supported log levels: `emerg,alert,crit,err,warn,notice,info,debug`
+* `--kernel` Include kernel messages
+
+Check the last 300 seconds for 'killed as a result of limit'
+```
+check-hardware-fail.rb -s 300 -q 'killed as a result of limit'
+```
+
+Check the last 300 seconds for 'killed' on `auth` and `syslog` facilities
+```
+check-hardware-fail.rb -s 300 -f auth,syslog -q 'killed'
+```
+
 
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
 
-## Notes
+## Notes

data/bin/check-hardware-fail.rb

@@ -25,6 +25,7 @@
 #   for details.
 #
 
+require 'os'
 require 'English'
 require 'rubygems' if RUBY_VERSION < '1.9.0'
 require 'sensu-plugin/check/cli'
@@ -34,7 +35,6 @@ class CheckHardwareFail < Sensu::Plugin::Check::CLI
          short: '-l NUMBER',
          long: '--lines NUMBER',
          proc: proc(&:to_i),
-         default: 0,
          description: 'Maximum number of lines to read from dmesg, 0 (default) means all'
 
   option :query,
@@ -43,21 +43,104 @@ class CheckHardwareFail < Sensu::Plugin::Check::CLI
          default: 'Hardware Error',
          description: 'What pattern to look for in the output of dmesg (regex or literal)'
 
+  option :seconds,
+         short: '-s SECONDS',
+         long: '--seconds SECONDS',
+         proc: proc(&:to_i),
+         description: 'Amount of seconds to lookbehind from dmesg output. This option is incompatible with --lines'
+
+  option :facility,
+         short: '-f FACILITY[,FACILITY]',
+         long: '--facility FACILITY[,FACILITY]',
+         description: 'Restrict output to defined facilities. Supported log facilities: kern,user,mail,daemon,auth,syslog,lpr,news',
+         required: false,
+         proc: proc { |a| a.split(',') }
+
+  option :level,
+         short: '-L LEVEL[,LEVEL]',
+         long: '--level LEVEL[,LEVEL]',
+         description: 'Restrict output to defined levels, otherwise all levels are included. Supported log levels: emerg,alert,crit,err,warn,notice,info,debug',
+         proc: proc { |a| a.split(',') }
+
+  option :kernel,
+         short: '-k',
+         long: '--kernel',
+         description: 'Include kernel messages',
+         boolean: true
+
   option :invert,
          long: '--invert',
          description: 'Invert order',
-         boolean: true,
-         default: false
+         boolean: true
 
   def run
-    cmd = config[:invert] ? 'head' : 'tail'
-    output = if config[:lines].zero?
-               `dmesg`.lines.select { |l| l[/#{config[:query]}/] }
-             else
-               `dmesg | #{cmd} -n #{config[:lines]}`.lines.select { |l| l[/#{config[:query]}/] }
-             end
+    # Validate options
+    unknown incompatible_options if incompatible_options
+
+    # Build the command based on the options provided
+    cmd = 'dmesg '
+    cmd += "--facility #{config[:facility].join(',')} " if config[:facility]
+    cmd += "--level #{config[:level].join(',')} " if config[:level]
+    cmd += '--kernel ' if config[:kernel]
+
+    # Run command
+    lines = `#{cmd}`.lines
     unknown 'Command execution failed!' unless $CHILD_STATUS.success?
+
+    if config[:seconds]
+      uptime = File.read('/proc/uptime').split(' ').first.to_i
+      seconds_limit = uptime - config[:seconds]
+    end
+
+    # Option --invert
+    # Flipping the array to start the iteration from the last line (newest entry)
+    # unless `--invert` which means that you want to start reading from the first line (oldest entry)
+    lines.reverse! unless config[:invert]
+
+    output = []
+
+    lines.each_with_index do |line, index|
+      break if config[:lines] && index >= config[:lines]
+      if config[:seconds]
+        timestamp = line.split(']').first.delete('[').to_i
+        break if timestamp < seconds_limit
+      end
+      output << line if line[/#{config[:query]}/]
+    end
+
     critical "Problem Detected: #{output[0]}" if output.any?
     ok 'OK'
   end
+
+  def incompatible_options
+    if OS.linux?
+      if incompatible_linux.any?
+        "The use of the options --seconds and [--#{incompatible_linux.join(' --')}] is incompatible."
+      elsif invalid_facility.any?
+        "Invalid dmesg facility requested: #{invalid_facility}"
+      elsif invalid_level.any?
+        "Invalid dmesg level requested: #{invalid_level}"
+      end
+    elsif OS.posix?
+      "Incompatible options: [--#{incompatible_posix.join(' --')}] for OS #{OS.host_os}" if incompatible_posix.any?
+    else
+      "OS #{OS.host_os} is not supported"
+    end
+  end
+
+  def incompatible_linux
+    config[:seconds] ? config.keys & %i[lines invert] : []
+  end
+
+  def incompatible_posix
+    config.keys & %i[facility level kernel seconds]
+  end
+
+  def invalid_facility
+    config[:facility].to_a - %w[kern user mail daemon auth syslog lpr news]
+  end
+
+  def invalid_level
+    config[:level].to_a - %w[emerg alert crit err warn notice info debug]
+  end
 end

data/lib/sensu-plugins-hardware/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-hardware
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.49.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.0
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for physical hardware