sensu-plugins-ipmi-sensors 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cd50e5f6e1100f3316e5b8182704137a989d146
+  data.tar.gz: 3e96ff9b07019093aa6b3700482d6aef7474f742
+SHA512:
+  metadata.gz: 0d11309b9f857a456ab1275efd6758703feea73130ed5f43d3ab30a56492cfc35063756cfac2ffe379717d956420e6b0d515daa6e0eaf4a808f2e1e46c997fd7
+  data.tar.gz: 0fb17887d5f10c129338dfcfe49a5bb477713fad41ef6bcbabaf246746521eb6bfd192652d7dc7f8cb8dce3f7c8ce13f9cf2170e1e2ed071e4929a9bab90ba37

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 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
+
+## [0.0.1] - 2015-12-28
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Matteo Cerutti
+
+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,28 @@
+# Sensu plugin for monitoring IPMI sensors
+
+A sensu plugin to monitor IPMI sensors.
+
+The plugin generates multiple OK/WARN/CRIT/UNKNOWN events via the sensu client socket (https://sensuapp.org/docs/latest/clients#client-socket-input)
+so that you do not miss state changes when monitoring multiple sensors.
+
+## Usage
+
+The plugin accepts the following command line options:
+
+```
+Usage: check-ipmi-sensors.rb (options)
+        --driver <driver>            IPMI driver (default: auto)
+    -H, --host <HOST>                IPMI host (default: localhost)
+        --ignore-sensor <SENSOR>     Comma separated list of IPMI sensors to ignore
+        --ignore-sensor-regex <SENSOR>
+                                     Comma separated list of IPMI sensors to ignore (regex)
+    -p, --password <PASSWORD>        IPMI password (required)
+        --provider <PROVIDER>        IPMI provider (default: auto)
+        --sensor <SENSOR>            Comma separated list of IPMI sensors (default: ALL)
+        --sensor-regex <SENSOR>      Comma separated list of IPMI sensors (regex)
+    -u, --user <USER>                IPMI username (required)
+    -w, --warn                       Warn instead of throwing a critical failure
+```
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-ipmi-sensors.rb

@@ -0,0 +1,177 @@
+#!/usr/bin/env ruby
+#
+# check-ipmi-sensors.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-plugin/check/cli'
+require 'rubyipmi'
+require 'json'
+require 'socket'
+
+class CheckIPMISensors < Sensu::Plugin::Check::CLI
+  option :user,
+         :description => "IPMI username",
+         :short => "-u <USER>",
+         :long => "--user <USER>",
+         :required => true
+
+  option :password,
+         :description => "IPMI password",
+         :short => "-p <PASSWORD>",
+         :long => "--password <PASSWORD>",
+         :required => true
+
+  option :host,
+         :description => "IPMI host (default: localhost)",
+         :short => "-H <HOST>",
+         :long => "--host <HOST>",
+         :default => "localhost"
+
+  option :provider,
+         :description => "IPMI provider (default: auto)",
+         :long => "--provider <PROVIDER>",
+         :in => ["any", "freeipmi", "openipmi"],
+         :default => "any"
+
+  option :driver,
+         :description => "IPMI driver (default: auto)",
+         :long => "--driver <driver>",
+         :in => ["auto", "lan15", "lan20", "open"],
+         :default => "auto"
+
+  option :sensor,
+         :description => "Comma separated list of IPMI sensors (default: ALL)",
+         :long => "--sensor <SENSOR>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :sensor_regex,
+         :description => "Comma separated list of IPMI sensors (regex)",
+         :long => "--sensor-regex <SENSOR>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :ignore_sensor,
+         :description => "Comma separated list of IPMI sensors to ignore",
+         :long => "--ignore-sensor <SENSOR>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :ignore_sensor_regex,
+         :description => "Comma separated list of IPMI sensors to ignore (regex)",
+         :long => "--ignore-sensor-regex <SENSOR>",
+         :proc => proc { |a| a.split(',') },
+         :default => []
+
+  option :warn,
+         :description => "Warn instead of throwing a critical failure",
+         :short => "-w",
+         :long => "--warn",
+         :boolean => false
+
+  def initialize()
+    super
+    @ipmi = Rubyipmi.connect(config[:user], config[:password], config[:host], config[:provider], {:driver => config[:driver]})
+  end
+
+  def send_client_socket(data)
+    sock = UDPSocket.new
+    sock.send(data + "\n", 0, "127.0.0.1", 3030)
+  end
+
+  def send_ok(check_name, msg)
+    event = {"name" => check_name, "status" => 0, "output" => "OK: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_warning(check_name, msg)
+    event = {"name" => check_name, "status" => 1, "output" => "WARNING: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_critical(check_name, msg)
+    event = {"name" => check_name, "status" => 2, "output" => "CRITICAL: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_unknown(check_name, msg)
+    event = {"name" => check_name, "status" => 3, "output" => "UNKNOWN: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def get_ipmi_sensors()
+    sensors = {}
+
+    @ipmi.sensors.list.each do |name, sensor|
+      if config[:ignore_sensor].size > 0
+        next if config[:ignore_sensor].include?(name)
+      end
+
+      if config[:ignore_sensor_regex].size > 0
+        b = false
+        config[:ignore_sensor_regex].each do |sensor|
+          if name =~ Regexp.new(sensor)
+            b = true
+            break
+          end
+        end
+        next if b
+      end
+
+      if config[:sensor].size > 0
+        next unless config[:sensor].include?(name)
+      end
+
+      if config[:sensor_regex].size > 0
+        b = true
+        config[:sensor_regex].each do |sensor|
+          if name =~ Regexp.new(sensor)
+            b = false
+            break
+          end
+        end
+        next if b
+      end
+
+      sensors[name] = sensor
+    end
+
+    sensors
+  end
+
+  def run
+    problems = 0
+
+    ipmi_sensors = get_ipmi_sensors()
+    ipmi_sensors.each do |name, sensor|
+      check_name = "ipmi-sensor-#{name}"
+      case sensor[:unit].downcase
+        when "n/a", "nominal"
+          # life's good
+          next
+
+        when "warning"
+          send_critical(check_name, "IPMI sensor #{name} is not healthy (State: #{sensor[:state]})")
+          problems += 1
+
+        when "critical"
+          send_critical(check_name, "IPMI sensor #{name} is not healthy (State: #{sensor[:state]})")
+          problems += 1
+
+        else
+          send_ok(check_name, "IPMI sensor #{name} is healthy (State: #{sensor[:state]})")
+
+      end
+    end
+
+    if problems > 0
+      message "Found #{problems} problems"
+      warning if config[:warn]
+      critical
+    else
+      ok "All IPMI sensors (#{ipmi_sensors.keys.join(', ')}) are OK"
+    end
+  end
+end

data/lib/sensu-plugins-ipmi-sensors.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-ipmi-sensors/version'

data/lib/sensu-plugins-ipmi-sensors/version.rb

@@ -0,0 +1,9 @@
+module SensuPluginsIPMISensors
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-ipmi-sensors
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-29 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.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rubyipmi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: This plugin provides facilities for monitoring IPMI sensors
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-ipmi-sensors.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-ipmi-sensors.rb
+- lib/sensu-plugins-ipmi-sensors.rb
+- lib/sensu-plugins-ipmi-sensors/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-ipmi-sensors
+licenses:
+- MIT
+metadata:
+  maintainer: "@m4ce"
+  development_status: active
+  production_status: stable
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for monitoring IPMI sensors
+test_files: []