sensu-plugins-cpu-usage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 385500e80aa292fccaf05b20a9466e6a400f99a5
+  data.tar.gz: f9b6f16dcb01722a69ba5554673565b74619e575
+SHA512:
+  metadata.gz: 64882b65518b853d2715b986e9f24b8bf6c468afe09b496b2a955c2c27cee5d2479c17eb376d18bb351014452e67dd5dce9fa12e6babb3a42138e60adbf80ac1
+  data.tar.gz: 79c7c69f46d2b695a206d76127100865ec95144d68c4de86aec3f5198dc934e05ccce160b8088bea0f6bf6e5c98e18a523685fc6360001d42d32bea5f94d7635

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] - 2016-01-05
+### 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,46 @@
+# Sensu plugin for monitoring the system CPU usage
+
+A sensu plugin to monitor the system's CPU usage with the option to generate events on specific metrics (e.g. user time, system time)
+
+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 metrics.
+
+## Usage
+
+The plugin accepts the following command line options:
+
+```
+Usage: check-cpu-usage.rb (options)
+    -c, --critical <USAGE>           Critical if USAGE exceeds the overall system cpu usage (default: 90)
+        --crit-guest <USAGE>         Critical if USAGE exceeds the current system guest usage
+        --crit-guest_nice <USAGE>    Critical if USAGE exceeds the current system guest_nice usage
+        --crit-idle <USAGE>          Critical if USAGE exceeds the current system idle usage
+        --crit-iowait <USAGE>        Critical if USAGE exceeds the current system iowait usage
+        --crit-irq <USAGE>           Critical if USAGE exceeds the current system irq usage
+        --crit-nice <USAGE>          Critical if USAGE exceeds the current system nice usage
+        --crit-softirq <USAGE>       Critical if USAGE exceeds the current system softirq usage
+        --crit-steal <USAGE>         Critical if USAGE exceeds the current system steal usage
+        --crit-system <USAGE>        Critical if USAGE exceeds the current system system usage
+        --crit-user <USAGE>          Critical if USAGE exceeds the current system user usage
+    -i <user,nice,system,idle,iowait,irq,softirq,steal,guest,guest_nice>,
+        --ignore-metric              Comma separated list of metrics to ignore
+    -m <user,nice,system,idle,iowait,irq,softirq,steal,guest,guest_nice>,
+        --metric                     Comma separated list of metrics to monitor (default: ALL)
+    -s, --sleep <SECONDS>            Sleep N seconds when sampling metrics
+    -w, --warn <USAGE>               Warn if USAGE exceeds the overall system cpu usage (default: 80)
+        --warn-guest <USAGE>         Warn if USAGE exceeds the current system guest usage
+        --warn-guest_nice <USAGE>    Warn if USAGE exceeds the current system guest_nice usage
+        --warn-idle <USAGE>          Warn if USAGE exceeds the current system idle usage
+        --warn-iowait <USAGE>        Warn if USAGE exceeds the current system iowait usage
+        --warn-irq <USAGE>           Warn if USAGE exceeds the current system irq usage
+        --warn-nice <USAGE>          Warn if USAGE exceeds the current system nice usage
+        --warn-softirq <USAGE>       Warn if USAGE exceeds the current system softirq usage
+        --warn-steal <USAGE>         Warn if USAGE exceeds the current system steal usage
+        --warn-system <USAGE>        Warn if USAGE exceeds the current system system usage
+        --warn-user <USAGE>          Warn if USAGE exceeds the current system user usage
+```
+
+By default, all metrics are taken into consideration when calculating the overall cpu usage.
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-cpu-usage.rb

@@ -0,0 +1,169 @@
+#!/usr/bin/env ruby
+#
+# check-cpu-usage.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-plugin/check/cli'
+require 'json'
+require 'socket'
+
+class CheckCpuUsage < Sensu::Plugin::Check::CLI
+  @@metrics = ['user', 'nice', 'system', 'idle', 'iowait', 'irq', 'softirq', 'steal', 'guest', 'guest_nice']
+
+  option :metric,
+         :description => "Comma separated list of metrics to monitor (default: ALL)",
+         :short => "-m <#{@@metrics.join(',')}>",
+         :long => "--metric <#{@@metrics.join(',')}>",
+         :proc => proc { |s| s.split(',') },
+         :default => @@metrics
+
+  option :ignore_metric,
+         :description => "Comma separated list of metrics to ignore",
+         :short => "-i <#{@@metrics.join(',')}>",
+         :long => "--ignore-metric <#{@@metrics.join(',')}>",
+         :proc => proc { |s| s.split(',') },
+         :default => []
+
+  @@metrics.each do |metric|
+    option "warn_#{metric}".to_sym,
+           :description => "Warn if USAGE exceeds the current system #{metric} usage",
+           :long => "--warn-#{metric} <USAGE>",
+           :proc => proc(&:to_i),
+           :default => nil
+
+    option "crit_#{metric}".to_sym,
+           :description => "Critical if USAGE exceeds the current system #{metric} usage",
+           :long => "--crit-#{metric} <USAGE>",
+           :proc => proc(&:to_i),
+           :default => nil
+  end
+
+  option :sleep,
+         :description => "Sleep N seconds when sampling metrics",
+         :short => "-s <SECONDS>",
+         :long => "--sleep <SECONDS>",
+         :default => 1,
+         :proc => proc(&:to_i)
+
+  option :warn,
+         :description => "Warn if USAGE exceeds the overall system cpu usage (default: 80)",
+         :short => "-w <USAGE>",
+         :long => "--warn <USAGE>",
+         :default => 80,
+         :proc => proc(&:to_i)
+
+  option :crit,
+         :description => "Critical if USAGE exceeds the overall system cpu usage (default: 90)",
+         :short => "-c <USAGE>",
+         :long => "--critical <USAGE>",
+         :default => 90,
+         :proc => proc(&:to_i)
+
+  def initialize()
+    super
+
+    raise "Warning CPU usage threshold must be lower than the critical threshold" if config[:warn] >= config[:crit]
+
+    # sanity checks
+    @@metrics.each do |metric|
+      raise "Must specify both warning and critical thresholds for CPU #{metric}" if (config["warn_#{metric}".to_sym] and config["crit_#{metric}".to_sym].nil?) or (config["warn_#{metric}".to_sym].nil? and config["crit_#{metric}".to_sym])
+
+      if config["warn_#{metric}".to_sym] and config["crit_#{metric}".to_sym]
+        raise "Warning CPU #{metric} threshold must be lower than the critical threshold" if config["warn_#{metric}".to_sym] >= config["crit_#{metric}".to_sym]
+      end
+    end
+  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_cpustats()
+    cpu = {}
+
+    stats = %x[cat /proc/stat]
+    values = stats[/^cpu\s*(.*)$/, 1].split(' ').map(&:to_i)
+
+    # missing guest time (kernel < 2.6.24)
+    values << 0 if values.size < 9
+
+    # missing guest_nice time (kernel < 2.6.33)
+    values << 0 if values.size < 10
+
+    @@metrics.each_with_index do |metric, index|
+      cpu[metric] = values[index]
+    end
+
+    cpu
+  end
+
+  def run
+    stats_before = get_cpustats()
+    sleep(config[:sleep]) if config[:sleep] > 0
+    stats_after = get_cpustats()
+    stats_diff = {}
+    total_diff = 0
+
+    metrics = config[:metric] - config[:ignore_metric]
+    metrics.each do |metric|
+      stats_diff[metric] = stats_after[metric] - stats_before[metric]
+      total_diff += stats_diff[metric]
+    end
+
+    # calculate percentage of total time for each metric
+    usage = {}
+    metrics.each do |metric|
+      usage[metric] = 100 * stats_diff[metric] / total_diff
+    end
+
+    usage.each do |metric, value|
+      check_name = "cpu-usage-#{metric}"
+
+      if config["warn_#{metric}".to_sym] and config["crit_#{metric}".to_sym]
+        if config["crit_#{metric}".to_sym] and value >= config["crit_#{metric}".to_sym]
+          send_critical(check_name, "CPU #{metric} time is too high - Current: #{value}% (>= #{config["crit_#{metric}".to_sym]}%)" if value >= config["crit_#{metric}".to_sym])
+        elsif config["warn_#{metric}".to_sym] and value >= config["warn_#{metric}".to_sym]
+          send_warning(check_name, "High CPU #{metric} time - Current: #{value}% (>= #{config["warn_#{metric}".to_sym]}%)" if value >= config["warn_#{metric}".to_sym])
+        else
+          send_ok(check_name, "CPU #{metric} time is normal - Current: #{value}% (<= #{config["warn_#{metric}".to_sym]}%)")
+        end
+      else
+        send_ok(check_name, "CPU #{metric} not monitored")
+      end
+    end
+
+    config[:ignore_metrics].each do |metric|
+      send_ok(check_name, "CPU #{metric} time not monitored")
+    end
+
+    # overall cpu usage
+    usage['overall'] = 100 * (total_diff - stats_diff['idle']) / total_diff
+
+    critical("CPU usage is too high - Current: #{usage['overall']}% (>= #{config[:crit]}%)") if usage['overall'] >= config[:crit]
+    warning("High CPU usage - Current: #{usage['overall']}% (>= #{config[:warn]}%)") if usage['overall'] >= config[:warn]
+    ok("CPU usage is normal - Current: #{usage['overall']}% (<= #{config[:warn]}%)")
+  end
+end

data/lib/sensu-plugins-cpu-usage/version.rb

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

data/lib/sensu-plugins-cpu-usage.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-cpu-usage/version'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-cpu-usage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-05 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
+description: This plugin provides facilities for monitoring the system cpu usage
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-cpu-usage.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-cpu-usage.rb
+- lib/sensu-plugins-cpu-usage.rb
+- lib/sensu-plugins-cpu-usage/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-cpu-usage
+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 the system cpu usage
+test_files: []