sensu-plugins-memory-checks 1.0.2 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDVjYTBmZGMwMDMzMDZiNDQwNTM5NTMyYzcwZDQxMjk4MmI1N2RkNg==
-  data.tar.gz: !binary |-
-    MjVkNjVjMTQ0M2YyNzQwYjcyYTZhYjkyNjEzZWU2NmQxMDkwNmNjNw==
+SHA1:
+  metadata.gz: ae11ba95c542661b22a46cd0065c83ba9703c091
+  data.tar.gz: 0ff145a2c2bca6383ce10f9fefd27f84fb4321b4
 SHA512:
-  metadata.gz: !binary |-
-    MjFmMjU1OGQxYjI0OGYxZDg4NjM3NjgwYWQ0ODQ1MGRlNjU0OGNlMWRlMzVm
-    Y2M1MmY3MTk2NjNhY2RlNDQzN2U1M2ZlNGM1ZjFmZDE2ZDIyZTFkNjdjYTJk
-    NDRmNGI2MzczYzhhOGEzZjkxMGExYjA5ZmFhNDA2YWNlYjI4YWM=
-  data.tar.gz: !binary |-
-    MDljNjVhMmNlNTZjMGY2MGVhZDVhZTdjMDc5ZTc5YWRmMjIzNTlkM2ZhNTQ0
-    ZGMzNzFkNzAzNTEyZWM0NjhkYzdiMGMxYjkwM2U3ZWE5YjRjNWViMTBmYzBh
-    NTJhNWY4YmZjNTk4ZGIzNjUzZjZjMGIxN2IzNzcxYmNlYzVkNTI=
+  metadata.gz: 604a6521102ba15ff88aec2ca8e77d1657d5aadf5ec9390b113dac2dcb053a58fa77411824935935bd64fbf9f325cb5c5cd010fbcafe4bf5e9d5c5ca067e7b4e
+  data.tar.gz: 1c987c2a801cd22a038a9b48250a8b84ad873fe56b7564847215568b4f0a662d2f4932f4f29405d5c0aaaea978f754c42f949c8ca2890635b8b33a67bc40dd33

data/CHANGELOG.md

@@ -5,6 +5,30 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [2.0.0] - 2017-01-17
+### Breaking Changes
+- The hardcoded default thresholds of 90% warn 95% critical in `check-ram.rb` when using the `--used` option 
+  have been removed so custom thresholds can be passed. To obtain identical behavior configure the check
+  like `check-ram.rb --used -w 90 -c 95`.
+- Ruby < 2.1 is no longer supported
+
+### Added
+- `check-swap-percent.rb`: Add option `--required` to alert if swap is missing (@losisin)
+- Support for Ruby 2.3.0 (@eheydrick)
+
+### Fixed
+- `check-memory-percent.sh`: Corrected units (from MB to %) in performance data output (@ttarczynski)
+- `check-ram.rb`: fixed overwriting of cli args for warning and critical when using `--used` (@majormoses)
+- `check-ram.rb`: Only require vmstat on `#run` (@PChambino)
+
+### Changed
+- `check-swap-percent.rb`: Rewrite the check for swap percentage in pure ruby while maintaining backwards compatibility. (@losisin)
+- set environment varable LANG=C for reliable output parsing (@corro)
+
+### Removed
+- Support for Ruby < 2.1 (@eheydrick)
+- `check-swap-percent.sh`: Remove obsolete shell script. (@losisin)
+
 ## [1.0.2] - 2016-04-12
 ### Fixed
 - `check-memory.sh`: Update for Ubuntu 16.04 `free` output
@@ -68,7 +92,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[unreleased]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/1.0.2...HEAD
+[unreleased]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/2.0.0...HEAD
+[2.0.0]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/1.0.2...2.0.0
 [1.0.2]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/1.0.1...1.0.2
 [1.0.1]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/1.0.0...1.0.1
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/0.0.9...1.0.0

data/README.md

@@ -15,13 +15,18 @@
  * bin/check-memory-percent.sh
  * bin/check-ram.rb
  * bin/check-swap-percent.rb
- * bin/check-swap-percent.sh
  * bin/check-swap.sh
  * bin/check-swap.rb
  * bin/metrics-memory-percent.rb
  * bin/metrics-memory.rb
 
 ## Usage
+Use `-h` flag on any command to see available usages, `-w` to set warning threshold `-c` to set critical threshold and `-p` to print out performance data. 
+ * `/opt/sensu/embedded/bin/check-memory.rb -w 2500 -c 3000`  - Values in Megabytes
+ * `/opt/sensu/embedded/bin/check-memory-percent.rb -w 70 -c 80` - Values in Percentages
+ * `/opt/sensu/embedded/bin/check-swap.rb -w 2500 -c 3000` - Values in Megabytes
+ * `/opt/sensu/embedded/bin/check-swap-percent.rb -w 70 -c 80` - Values in Percentages
+ * `/opt/sensu/embedded/bin/metrics-memory.rb -s FooBar` - So metrics are now prepended with foobar, default is machine hostname. 
 
 ## Installation
 
@@ -30,7 +35,8 @@
 ### `bin/check-ram.rb`
 
 Ruby does not have a good native way without the use of C extensions to grab information on memory usage (outside of running shell commands and parsing out). Because of this `check-ram.rb` uses a gem called `vmstat` which has a somewhat annoying dependency on a gcc to compile the C extensions. In order to not force people to install gcc if they are not using `check-ram.rb` we do not install it by default, and is up to the user to make sure that they install it. This requires two steps and can vary based on your distribution and ruby set up:
-- Install `gcc`. If you are on a debian based system it is located in the `build-essential` package.
-- Install `vmstat` gem into the path that sensu gems are expected to run from: this is typically.
+  * Install `gcc`. If you are on a debian based system it is located in the `build-essential` package.
+  * Install `vmstat` gem into the path that sensu gems are expected to run from:
+    * `sudo /opt/sensu/embedded/bin/gem install vmstat --no-rdoc --no-ri` or the equivalent for installing sensu gems in your configuration management system
 
 ## Notes

data/bin/check-memory-percent.sh

@@ -14,6 +14,9 @@
 # Date: 2016-02-15
 # Modified: J. Brandt Buckley <brandt.buckley@sendgrid.com>
 
+# set lang
+LANG=C
+
 # get arguments
 
 # #RED
@@ -42,8 +45,8 @@ if [ "$hlp" = "yes" ]; then
   exit 0
 fi
 
-WARN=${WARN:=0}
-CRIT=${CRIT:=0}
+WARN=${WARN:=80}
+CRIT=${CRIT:=90}
 
 #Get total memory available on machine
 TotalMem=$(free -m | grep Mem | awk '{ print $2 }')
@@ -66,7 +69,7 @@ if [ "$UsedPer" = "" ]; then
 fi
 
 if [ "$perform" = "yes" ]; then
-  output="system memory usage: $UsedPer% | free memory="$UsedPer"MB;$WARN;$CRIT;0"
+  output="system memory usage: $UsedPer% | free memory="$UsedPer"%;$WARN;$CRIT;0"
 else
   output="system memory usage: $UsedPer%"
 fi

data/bin/check-memory.sh

@@ -10,6 +10,9 @@
 # The memory check is done with following command line:
 # free -m | grep buffers/cache | awk '{ print $4 }'
 
+# set lang
+LANG=C
+
 # get arguments
 
 # #RED

data/bin/check-ram.rb

@@ -21,7 +21,8 @@
 #
 # EXTRA INSTALL INSTRUCTIONS:
 #   You must install gcc. This is needed to compile the vmstat gem
-#   which you must put in a path that sensu can reach.
+#   which you must put in a path that sensu can reach. See the README for
+#   more details.
 # NOTES:
 #   The default behavior is to check % of RAM free. This can easily
 #   be overwritten via args please see `check-ram.rb --help` for details
@@ -33,7 +34,6 @@
 #   for details.
 #
 require 'sensu-plugin/check/cli'
-require 'vmstat'
 
 class CheckRAM < Sensu::Plugin::Check::CLI
   option :megabytes,
@@ -84,8 +84,6 @@ class CheckRAM < Sensu::Plugin::Check::CLI
     # only free or used should be defined, change defaults to mirror free
     if config[:used]
       config[:free] = false
-      config[:warn] = 90
-      config[:crit] = 95
     end
 
     if config[:megabytes]

data/bin/check-swap-percent.rb

@@ -1,6 +1,79 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
+#  encoding: UTF-8
+#
+# Checks SWAP usage as a % of the total swap
+#
+# Date: 2016-11-21
+# Author: Aleksandar Stojanov <aleksandar.stojanov@polarcape.com>
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   commands: free, grep
+#
+# USAGE:
+#   check-swap-percent.rb -w warn_percent -c critical_percent
+#
+# LICENSE:
+#   Copyright 2016 Aleksandar Stojanov <aleksandar.stojanov@polarcape.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
 
-bin_dir = File.expand_path(File.dirname(__FILE__))
-shell_script_path = File.join(bin_dir, File.basename($PROGRAM_NAME, '.rb') + '.sh')
+require 'sensu-plugin/check/cli'
 
-exec shell_script_path, *ARGV
+class CheckSWAP < Sensu::Plugin::Check::CLI
+  option :warn,
+         short: '-w WARNING',
+         long: '--warning',
+         proc: proc(&:to_i),
+         default: 70
+
+  option :critical,
+         short: '-c CRITICAL',
+         long: '--critical',
+         proc: proc(&:to_i),
+         default: 80
+
+  option :required,
+         short: '-r',
+         long: '--required',
+         description: 'checks if swap is missing from the machine',
+         boolean: true,
+         default: false
+
+  def run
+    # Get output from free command
+    output_swap = `free -m | grep "Swap"`
+
+    # Prepare total and used swap
+    total_swap = output_swap.split(' ')[1].to_i
+    used_swap = output_swap.split(' ')[2].to_i
+
+    # Check if swap exists
+    if total_swap.zero?
+      if config[:required]
+        critical 'ERROR: SWAP is missing on this machine'
+      else
+        print 'There is no SWAP configured'
+        exit
+      end
+    end
+
+    # Prepare output message
+    output = "#{used_swap}/#{total_swap}"
+
+    # Calculate round percent from used and total
+    swapp = (100.0 * (used_swap.nonzero? || 1) / total_swap).round(0)
+
+    # Check conditions from config
+    if swapp >= config[:critical]
+      critical "#{swapp}% ; #{output}\n"
+    elsif swapp >= config[:warn]
+      warning "#{swapp}% ; #{output}\n"
+    else
+      ok "#{swapp}% ; #{output}\n"
+    end
+  end
+end

data/bin/check-swap.sh

@@ -12,6 +12,9 @@
 # The swap check is done with following command line:
 # vmstat | tail -n1 | awk '{ print $3 }'
 
+# set lang
+LANG=C
+
 # get arguments
 
 # #RED 

data/bin/metrics-memory-percent.rb

@@ -67,7 +67,7 @@ class MemoryGraphite < Sensu::Plugin::Metric::CLI::Graphite
     mem['freeWOBuffersCaches'] = mem['free'] + (mem['buffers'] + mem['cached'])
 
     # to prevent division by zero
-    swptot = if mem['swapTotal'] == 0
+    swptot = if mem['swapTotal'].zero?
                1
              else
                mem['swapTotal']

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

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

metadata

@@ -1,174 +1,175 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-memory-checks
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2017-01-18 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.5'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.37'
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.37'
+        version: 0.40.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
   name: vmstat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: ! "This plugin provides native memory instrumentation\n                              for
-  monitoring and metrics collection, including:\n                              memory
-  usage via `free` and `vmstat`, including metrics.\n                              Note
-  that this plugin may have cross-platform issues."
-email: <sensu-users@googlegroups.com>
+description: |-
+  This plugin provides native memory instrumentation
+                                for monitoring and metrics collection, including:
+                                memory usage via `free` and `vmstat`, including metrics.
+                                Note that this plugin may have cross-platform issues.
+email: "<sensu-users@googlegroups.com>"
 executables:
 - check-memory-percent.rb
 - check-memory.rb
@@ -189,7 +190,6 @@ files:
 - bin/check-memory.sh
 - bin/check-ram.rb
 - bin/check-swap-percent.rb
-- bin/check-swap-percent.sh
 - bin/check-swap.rb
 - bin/check-swap.sh
 - bin/metrics-memory-percent.rb
@@ -200,7 +200,7 @@ homepage: https://github.com/sensu-plugins/sensu-plugins-memory-checks
 licenses:
 - MIT
 metadata:
-  maintainer: ! '@mattyjones'
+  maintainer: sensu-plugin
   development_status: active
   production_status: unstable - testing recommended
   release_draft: 'false'
@@ -212,12 +212,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/bin/check-swap-percent.sh

@@ -1,47 +0,0 @@
-#!/bin/bash
-#
-# Checks SWAP usage as a % of the total swap
-#
-# Date: 05/12/13
-# Author: Nick Barrett - EDITD
-# License: MIT
-#
-# Usage: check-swap-percentage.sh -w warn_percent -c critical_percent
-# Uses free (Linux-only) & bc
-
-# #RED
-# input options
-while getopts ':w:c:' OPT; do
-  case $OPT in
-    w)  WARN=$OPTARG;;
-    c)  CRIT=$OPTARG;;
-  esac
-done
-
-WARN=${WARN:=100}
-CRIT=${CRIT:=100}
-
-
-# get swap details
-USED=`free -m | grep 'Swap:' | awk '{ print $3 }'`
-TOTAL=`free -m | grep 'Swap:' | awk '{ print $2 }'`
-
-if [[ $TOTAL -eq 0 ]] ; then
-  echo "There is no SWAP on this machine"
-  exit 0
-else
-  PERCENT=`echo "scale=3;$USED/$TOTAL*100" | bc -l | awk '{printf "%f", $0}'`
-
-  OUTPUT="Swap usage: $PERCENT%, $USED/$TOTAL"
-
-  if [ "$(echo "$PERCENT >= $CRIT" | bc)" -eq 1 ] ; then
-    echo "SWAP CRITICAL - $OUTPUT"
-    exit 2
-  elif [ "$(echo "$PERCENT >= $WARN" | bc)" -eq 1 ] ; then
-    echo "SWAP WARNING - $OUTPUT"
-    exit 1
-  else
-    echo "SWAP OK - $OUTPUT"
-    exit 0
-  fi
-fi