sensu-plugins-windows 0.0.10 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzZmMDcxYWVhZTY5Y2Q4ZjA4YjEzYTQ1MWE0YjFkOTg1MzA1YzA1NA==
-  data.tar.gz: !binary |-
-    MWYyMWViYTVmYTUyOWNmMjEzNjM4OTZhMDI0MzEyNDgzYmI0ZWYyMA==
+SHA1:
+  metadata.gz: f1585766cf7f2f5649ae6958bd4f98ea53e06563
+  data.tar.gz: 79190644e127daba3a7fb66a6a883db18a1fc58f
 SHA512:
-  metadata.gz: !binary |-
-    ZTExNWY5MGM5YjFmODEzYTA5MTQ2ODczNzM3ZGVhMGM3NTZiYjY3NTQwNTI2
-    MDIzNmZkODI4NjE5OTU2Yjg4MWQzMGQ4YmEyNDBmOGZmMDA0MDc3MWE2N2Nh
-    MzNhYjAyMGJiMGEzMzJiMzJiYjllMWUxM2VjN2U0OTM2MWYxMmI=
-  data.tar.gz: !binary |-
-    OTYwNGNhYzQ5MjJiOTliMzU3YTMyNTc4YzM5ZjQwYTMxZDljZWUyZGQyNTVh
-    ODU2MGEzOTA1NDBjMTRlYjEyNzAyM2EyYjU1OGUyMmNkMzgwNGVkNDU3YzBk
-    ZmEyMjk4MDA0ODA1M2E4NzcxMWI4ZTQ5ZTgwNWI5YWMyY2M2MDQ=
+  metadata.gz: 8d07bbf44b5f855202cdfb3e52933e3ebe73565c136edc0bc8afba71290f0a1ac50b66ee03ff5d9481352b1765c9a6f4e9e82659321881eb5f7baf44a7c8dc65
+  data.tar.gz: 94d379608f2cc63046098a8f6d7b5934b5069c6e3164d1cbe4a542637197a1a9c4b4c7b8233f1106dc37cd06cc030b5371fc3e019b293fd3ee2ed6bfd00b69be

data/CHANGELOG.md

@@ -1,68 +1,98 @@
 #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 [Keep A Changelog](http://keepachangelog.com/).
 
 ## [Unreleased]
+## [0.1.0] 2017-06-2017
+### Fixed
+- Check-Windows-disk.rb added CSV formatting for WMIC.
+
+### Added
+- Windows CPU Load Check written using only Powershell under bin/powershell. (@ajeba99)
+- Windows Disk Usage Check written using only Powershell under bin/powershell.
+- Windows Disk Writeable written using only Powershell under bin/powershell (@shoekstra)
+- Windows Process Check written using only Powershell under bin/powershell.
+- Windows RAM Check written using only Powershell under bin/powershell.
+- Windows Service Check written using only Powershell under bin/powershell.
+- Windows CPU Load Metric written using only Powershell under bin/powershell.
+- Windows Disk Usage Metric written using only Powershell under bin/powershell.
+- Windows RAM Metric written using only Powershell under bin/powershell.
+- Windows Network Metric written using only Powershell under bin/powershell.
+- Windows Uptime Metric written using only Powershell under bin/powershell.
+- Add support for ignoring disk checks by disk label (via a regular expression) (@manul7)
+- Add check-windows-processor-queue-length (@andyroyle)
+- Add testing on Ruby 2.3 and 2.4.1 (@eheydrick)
+
+### Changed
+- Corrected grammer issues and clarified comments in all existing Ruby-based Windows Check and Metric files.
+- Moved existing Ruby-based Windows Check and Metric files to bin/ruby.
+- Changed file naming to the singular instead of the difference in plurality between 'check' and 'metrics'.
+- Updated README.md.
+
+### Fixed
+- Fixed numerous grammar issues in CHANGELOG.md file.
+
+### Removed
+- Support for Ruby < 2 (@eheydrick)
 
 ## [0.0.10] - 2016-02-16
 ### Fixed
-- check-windows-disk.rb removed system volumes from list
+- Check-Windows-disk.rb removed system volumes from list
 
 ## [0.0.9] - 2016-02-05
 ### Added
-- new certs
+- New certs
 
 ## [0.0.8] - 2015-12-10
 ### Fixed
-- metrics-windows-disk-usage.rb incorrect variable
+- Metric-Windows-disk-usage.rb incorrect variable
 
 ## [0.0.7] - 2015-11-19
 ### Fixed
-- metrics-windows-network.rb: remove characters that break graphite metrics
+- Metric-Windows-network.rb: remove characters that break graphite metrics
 
 ## [0.0.6] - 2015-08-04
 ### Changed
-- updated check-windows-process to use native WMI hooks
-- bump rubocop
-- change binstubs to only be created for ruby files
+- Updated check-Windows-process to use native WMI hooks
+- Bump rubocop
+- Change binstubs to only be created for ruby files
 
 ## [0.0.5] - 2015-07-14
 ### Changed
-- updated sensu-plugin gem to 1.2.0
+- Updated Sensu-plugin gem to 1.2.0
 
 ## [0.0.4] - 2015-07-05
 ### Added
-- windows uptime metrics
-- windows RAM metrics
-- windows network metrics
+- Windows Uptime Metrics
+- Windows RAM Metrics
+- Windows Network Metrics
 
 ### Removed
-- removed IIS check / metrics plugins and moved them to their own sensu iis plugin repository
+- Removed IIS check / metrics plugins and moved them to their own sensu iis plugin repository
 
 ## [0.0.3]
 - Pulled
 
 ## [0.0.2] - 2015-06-03
-
 ### Fixed
-- added binstubs
+- Added binstubs
 
 ### Changed
-- removed cruft from /lib
+- Removed cruft from /lib
 
 ## 0.0.1 - 2015-05-21
-
 ### Added
-- initial release
-
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.9...HEAD
-[0.0.10]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.9...0.0.10
-[0.0.9]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.8...0.0.9
-[0.0.8]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.7...0.0.8
-[0.0.7]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.6...0.0.7
-[0.0.6]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.5...0.0.6
-[0.0.5]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.4...0.0.5
-[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.3...0.0.4
-[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.2...0.0.3
-[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-windows/compare/0.0.1...0.0.2
+- Initial release
+
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/v0.0.10...0.1.0
+[0.0.10]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/v0.0.9...v0.0.10
+[0.0.9]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.0.8..v0.0.9
+[0.0.8]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.0.7...0.0.8
+[0.0.7]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.0.6...0.0.7
+[0.0.6]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.0.5...0.0.6
+[0.0.5]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.0.4...0.0.5
+[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.0.3...0.0.4
+[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-Windows/compare/0.0.1...0.0.2

data/README.md

@@ -1,4 +1,4 @@
-## Sensu-Plugins-windows
+## Sensu-Plugins-Windows
 
 [![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-windows.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-windows)
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-windows.svg)](http://badge.fury.io/rb/sensu-plugins-windows)
@@ -8,22 +8,61 @@
 
 ## Functionality
 
+These files provide basic Checks and Metrics for a Windows system.
+
 ## Files
- * bin/metrics-windows-cpu-load.rb
- * bin/metrics-windows-disk-usage.rb
- * bin/metrics-windows-network.rb
- * bin/metrics-windows-ram-usage.rb
- * bin/metrics-windows-uptime.rb
+
+### Ruby
+
  * bin/check-windows-cpu-load.rb
  * bin/check-windows-disk.rb
  * bin/check-windows-process.rb
+ * bin/check-windows-processor-queue-length.rb
  * bin/check-windows-ram.rb
  * bin/check-windows-service.rb
+ * bin/metric-windows-cpu-load.rb
+ * bin/metric-windows-disk-usage.rb
+ * bin/metric-windows-network.rb
+ * bin/metric-windows-processor-queue-length.rb
+ * bin/metric-windows-ram-usage.rb
+ * bin/metric-windows-uptime.rb
+
+### Powershell
+
+ * bin/powershell/check-windows-cpu-load.ps1
+ * bin/powershell/check-windows-disk.ps1
+ * bin/powershell/check-windows-disk-writeable.ps1
+ * bin/powershell/check-windows-process.ps1
+ * bin/powershell/check-windows-processor-queue-length.ps1
+ * bin/powershell/check-windows-ram.ps1
+ * bin/powershell/check-windows-service.ps1
+ * bin/powershell/metric-windows-cpu-load.ps1
+ * bin/powershell/metric-windows-disk-usage.ps1
+ * bin/powershell/metric-windows-network.ps1
+ * bin/powershell/metric-windows-processor-queue-length.ps1
+ * bin/powershell/metric-windows-ram-usage.ps1
+ * bin/powershell/metric-windows-uptime.ps1
 
 ## Usage
 
+Put either the Ruby or Powershell files on a Sensu Client, typically under `C:\etc\sensu\plugins`.
+
+You should also include the full escaped path to the ruby interpreter in the check's command configuration, see example below:
+
+```json
+{
+  "checks": {
+    "cpu_percent": {
+      "command": "c:\\opt\\sensu\\embedded\\bin\\ruby C:\\opt\\sensu\\etc\\plugins\\metric-windows-cpu-load.rb",
+      "interval": 30,
+      "type": "metric",
+      "handler": "win_metrics",
+      "subscribers": ["win_metrics"]
+    }
+  }
+}
+```
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
-
-## Notes

data/bin/check-windows-cpu-load.rb

@@ -3,6 +3,8 @@
 #   check-windows-cpu-load.rb
 #
 # DESCRIPTION:
+#   This plugin collects and outputs the CPU load in a Graphite acceptable format.
+#   It uses Typeperf to get the processor usage.
 #
 # OUTPUT:
 #   plain text
@@ -20,15 +22,10 @@
 #
 # LICENSE:
 #   Jean-Francois Theroux <me@failshell.io>
-#   Released under the same terms as Sensu (the MIT license); see LICENSE
-#   for details.
+#   Released under the same terms as Sensu (the MIT license); see LICENSE for details.
 #
-
 require 'sensu-plugin/check/cli'
 
-#
-# Check Windows CPU Load
-#
 class CheckWindowsCpuLoad < Sensu::Plugin::Check::CLI
   option :warning,
          short: '-w WARNING',

data/bin/check-windows-disk.rb

@@ -5,9 +5,6 @@
 # DESCRIPTION:
 #   This is mostly copied from the original check-disk.rb plugin and modified
 #   to use WMIC.  This is our first attempt at writing a plugin for Windows.
-#
-#   Uses Windows WMIC facility. Warning/critical levels are percentages only.
-
 #
 # OUTPUT:
 #   plain text
@@ -22,18 +19,14 @@
 # USAGE:
 #
 # NOTES:
+#   Uses Windows WMIC facility. Warning/critical levels are percentages only.
 #
 # LICENSE:
-#   Copyright 2013 <bp-parks@wiu.edu> <mr-mencel@wiu.edu>
-#   Released under the same terms as Sensu (the MIT license); see LICENSE
-#   for details.
+#   Copyright 2013 <bp-parks@wiu.edu> and <mr-mencel@wiu.edu>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE for details.
 #
-
 require 'sensu-plugin/check/cli'
 
-#
-# Check Disk
-#
 class CheckDisk < Sensu::Plugin::Check::CLI
   option :fstype,
          short: '-t TYPE',
@@ -47,6 +40,10 @@ class CheckDisk < Sensu::Plugin::Check::CLI
          short: '-i MNT',
          proc: proc { |a| a.split(',') }
 
+  option :ignorelabel,
+         short: '-I LABEL_REGEXP',
+         proc: proc { |a| Regexp.new(a) }
+
   option :warn,
          short: '-w PERCENT',
          proc: proc(&:to_i),
@@ -64,10 +61,10 @@ class CheckDisk < Sensu::Plugin::Check::CLI
   end
 
   def read_wmic
-    `wmic volume where DriveType=3 list brief`.split("\n").drop(1).each do |line|
+    `wmic volume where DriveType=3 list brief /format:csv`.split("\n").drop(1).each do |line|
       begin
         # #YELLOW
-        capacity, type, _fs, _avail, label, mnt = line.split # rubocop:disable Lint/UnderscorePrefixedVariableName
+        _hostname, capacity, type, _fs, _avail, label, mnt = line.split(',') # rubocop:disable Lint/UnderscorePrefixedVariableName
         next if /\S/ !~ line
         next if _avail.nil?
         next if line.include?('System Reserved')
@@ -75,6 +72,7 @@ class CheckDisk < Sensu::Plugin::Check::CLI
         next if config[:fstype] && !config[:fstype].include?(type)
         next if config[:ignoretype] && config[:ignoretype].include?(type)
         next if config[:ignoremnt] && config[:ignoremnt].include?(mnt)
+        next if config[:ignorelabel] && config[:ignorelabel].match(label)
       rescue
         unknown "malformed line from df: #{line}"
       end

data/bin/check-windows-process.rb

@@ -3,7 +3,7 @@
 #   check-windows-process.rb
 #
 # DESCRIPTION:
-#   This plugin checks whether a User-inputted process is running or not
+#   This plugin checks whether a User-inputted process is running or not.
 #   This checks users tasklist tool to find any process is running or not.
 #
 # OUTPUT:
@@ -16,14 +16,13 @@
 #   gem: sensu-plugin
 #
 # USAGE:
-# check-windows-process -p <process substr to match> [ -w <warn age> ]
+#   check-windows-process -p <process substr to match> [ -w <warn age> ]
 #
 # NOTES:
 #
 # LICENSE:
 #   Copyright 2015 <onetinov@lxrb.com>
-#   Released under the same terms as Sensu (the MIT license); see LICENSE
-#   for details.
+#   Released under the same terms as Sensu (the MIT license); see LICENSE for details.
 #
 require 'optparse'
 require 'time'

data/bin/check-windows-processor-queue-length.rb

@@ -0,0 +1,47 @@
+#! /usr/bin/env ruby
+#
+#   check-windows-processor-queue-length.rb
+#
+# DESCRIPTION:
+#   This plugin checks the Processor Queue Length
+#   It uses Typeperf to get the processor usage.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Windows
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#
+# NOTES:
+#  Tested on Windows 2012R2.
+#
+# LICENSE:
+#   Andy Royle <ajroyle@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE for details.
+#
+require 'sensu-plugin/check/cli'
+
+class CheckWindowsProcessorQueueLength < Sensu::Plugin::Check::CLI
+  option :warning,
+         short: '-w WARNING',
+         default: 5,
+         proc: proc(&:to_i)
+
+  option :critical,
+         short: '-c CRITICAL',
+         default: 10,
+         proc: proc(&:to_i)
+
+  def run
+    io = IO.popen('typeperf -sc 1 "system\\processor queue length"')
+    cpu_queue = io.readlines[2].split(',')[1].delete('"').to_i
+    critical "Processor Queue at at #{cpu_queue}%" if cpu_queue > config[:critical]
+    warning "Processor Queue at #{cpu_queue}%" if cpu_queue > config[:warning]
+    ok "Processor Queue at #{cpu_queue}%"
+  end
+end

data/bin/check-windows-ram.rb

@@ -3,6 +3,8 @@
 #   check-windows-ram.rb
 #
 # DESCRIPTION:
+#   This plugin collects and outputs the RAM usage in a Graphite acceptable format.
+#   It uses Typeperf to get available memory and WMIC to get the usable memory size.
 #
 # OUTPUT:
 #   plain text
@@ -16,19 +18,14 @@
 # USAGE:
 #
 # NOTES:
-#  Tested on Windows 2008RC2.
+#   Tested on Windows 2008RC2.
 #
 # LICENSE:
 #   Jean-Francois Theroux <me@failshell.io>
-#   Released under the same terms as Sensu (the MIT license); see LICENSE
-#   for details.
+#   Released under the same terms as Sensu (the MIT license); see LICENSE for details.
 #
-
 require 'sensu-plugin/check/cli'
 
-#
-# Check Windows RAM Load
-#
 class CheckWindowsRAMLoad < Sensu::Plugin::Check::CLI
   option :warning,
          short: '-w WARNING',

data/bin/check-windows-service.rb

@@ -1,15 +1,13 @@
 #! /usr/bin/env ruby
 #
-#   check-service-windows.rb
+#   check-windows-service.rb
 #
 # DESCRIPTION:
-#   Check Named Windows Service Plugin
-#   This plugin checks whether a User-inputted service on Windows is running or not
+#   This plugin checks whether a User-supplied service on Windows is running or not
 #   This checks users tasklist tool to find any service on Windows is running or not.
-
 #
 # OUTPUT:
-#   plain text, metric data, etc
+#   plain text
 #
 # PLATFORMS:
 #   Windows
@@ -22,17 +20,12 @@
 # NOTES:
 #
 # LICENSE:
-#   Edited from  <jashishtech@gmail.com>
+#   Edited from <jashishtech@gmail.com>
 #   Copyright 2014 <jj.asghar@peopleadmin.com>
-#   Released under the same terms as Sensu (the MIT license); see LICENSE
-#   for details.
+#   Released under the same terms as Sensu (the MIT license); see LICENSE for details.
 #
-
 require 'sensu-plugin/check/cli'
 
-#
-# Check Win Services
-#
 class CheckWinService < Sensu::Plugin::Check::CLI
   option :service,
          description: 'Check for a specific service',