sensu-plugins-network-checks 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05befbbb40128bd754c4097cd39c23cc6dcfd3e6
-  data.tar.gz: eb80907f69c37929fa63574054cf4f75ba5428f6
+  metadata.gz: b91c2cab0f43f5200c2dc825c026040771355009
+  data.tar.gz: 48c3b6298d8d6b8771e9580e2cc120692cd236d3
 SHA512:
-  metadata.gz: 92c7f8a40be0a0d92eff802b9ee6e678e08ee34641beea8571d05f5c4873168d3e556bd20f9431d87fa1098888ec1b2029fc12466133e7d445b671d81b65542a
-  data.tar.gz: 9400d53919c528945403d2d99312687cecd78b3da19e07c8406b21b2f20540089ed76a15e121139267a90714567b4bdb57c9ed0ed6084829c2b4eefbf3ff8504
+  metadata.gz: 629b7ed21e7ee2f22f852ae5f6f0724fbf21e576238b9e53f8cb4aafbc40784eed7f9dfd6d42053af73d6e78cc40b8550ff56cb763e182ebb483dabb7db0da17
+  data.tar.gz: ba7c01d145a66fad0ed4aa3d9a7efc538a2a19974afd6e8d52a3009b9f460964047593050bc1aae8a5023f1462a5afb7a825627f0b04f3d7942449ec3026961e

data/CHANGELOG.md

@@ -5,6 +5,13 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased][unreleased]
 
+## [0.0.6] - 2015-10-01
+### Added
+- Added new port check
+
+### Changed
+- Changed name of check-ports to check-ports-nmap
+
 ## [0.0.5] - 2015-08-05
 ### Added
 - Added new metrics-ping.rb plugin
@@ -27,6 +34,10 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 - cleaned up Rakefile
 - updated documentation links
 
+### Refactored
+- renamed check-ports.rb to check-ports-nmap.rb
+- added check-ports.rb based in TCPSocket instead of nmap
+
 ## [0.0.2] - 2015-06-03
 
 ### Fixed

data/README.md

@@ -13,6 +13,7 @@
  * bin/check-multicast-groups.rb
  * bin/check-netstat-tcp.rb
  * bin/check-ping.rb
+ * bin/check-ports-nmap.rb
  * bin/check-ports.rb
  * bin/check-rbl.rb
  * bin/check-whois-domain-expiration-multi.rb
@@ -24,6 +25,25 @@
 
 ## Usage
 
+**check-ports**
+This check now uses a TCPSocket, not nmap (see next below)
+```
+check-ports.rb -h 0.0.0.0 -p 22,25,3030 -t 30
+
+Usage: bin/check-ports.rb (options)
+    -H, --hostnames HOSTNAME         Host to connect to
+    -p, --ports PORTS                Ports to check, comma separated
+    -t, --timeout SECS               Connection timeout
+```
+
+**check-ports-nmap**
+```
+Usage: bin/check-ports-nmap.rb (options)
+    -h, --host HOST                  Resolving name or IP address of target host
+    -l, --level crit|warn            Alert level crit(critical) or warn(warning)
+    -t, --ports PORT,PORT...         TCP port(s) you wish to get status for
+```
+
 **check-multicast-groups**
 ```
 {

data/bin/check-netstat-tcp.rb

@@ -83,7 +83,7 @@ class CheckNetstatTCP < Sensu::Plugin::Check::CLI
     TCP_STATES.each_pair { |_hex, name| state_counts[name] = 0 }
 
     protocols.select { |p| File.exist?('/proc/net/' + p) }.each do |protocol|
-      File.open('/proc/net/' + protocol).each do |line| # rubocop:disable Style/Next
+      File.open('/proc/net/' + protocol).each do |line|
         line.strip!
         if m = line.match(/^\s*\d+:\s+(.{8}|.{32}):(.{4})\s+(.{8}|.{32}):(.{4})\s+(.{2})/) # rubocop:disable AssignmentInCondition
           connection_state = m[5]

data/bin/check-ports-nmap.rb

@@ -0,0 +1,89 @@
+#! /usr/bin/env ruby
+#
+#   check-ports-nmap
+#
+# DESCRIPTION:
+#   Fetch port status using nmap. This check is good for catching bad network ACLs
+#   or service down events for network resources.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux, Windows, BSD, Solaris, etc
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   nmap package
+#
+# USAGE:
+#   $ ./check-ports-nmap.rb --host some_server --ports 5671,5672 --level crit
+#
+# NOTES:
+#   #YELLOW
+#   Look at rewriting this using the namp library to not depend on external tools
+#
+# LICENSE:
+#   Copyright 2013 GoDaddy.com, LLC <jjmanzer@godaddy.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'open3'
+require 'sensu-plugin/check/cli'
+require 'json'
+
+# CheckPorts
+class CheckPorts < Sensu::Plugin::Check::CLI
+  option :host,
+         description: 'Resolving name or IP address of target host',
+         short: '-h HOST',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :ports,
+         description: 'TCP port(s) you wish to get status for',
+         short: '-t PORT,PORT...',
+         long: '--ports PORT,PORT...'
+
+  option :level,
+         description: 'Alert level crit(critical) or warn(warning)',
+         short: '-l crit|warn',
+         long: '--level crit|warn',
+         default: 'WARN'
+
+  def run
+    stdout, stderr = Open3.capture3(
+      ENV,
+      "nmap -P0 -p #{config[:ports]} #{config[:host]}"
+    )
+
+    case stderr
+    when /Failed to resolve/
+      critical 'cannot resolve the target hostname'
+    end
+
+    port_checks = {}
+    check_pass  = true
+
+    stdout.split("\n").each do |line|
+      line.scan(/(\d+).tcp\s+(\w+)\s+(\w+)/).each do |status|
+        port_checks[status[1]] ||= []
+        port_checks[status[1]].push status[0]
+        check_pass = false unless status[1]['open']
+      end
+    end
+
+    result = port_checks.map { |state, ports| "#{state}:#{ports.join(',')}" }.join(' ')
+
+    if check_pass
+      ok result
+    elsif config[:level].upcase == 'WARN'
+      warning result
+    elsif config[:level].upcase == 'CRIT'
+      critical result
+    else
+      unknown "Unknown alert level #{config[:level]}"
+    end
+  end
+end

data/bin/check-ports.rb

@@ -1,89 +1,84 @@
 #! /usr/bin/env ruby
 #
-#   check-ports
+#  encoding: UTF-8
+#   check-ports-socket
 #
 # DESCRIPTION:
-#   Fetch port status using nmap. This check is good for catching bad network ACLs
-#   or service down events for network resources.
+# Connect to a TCP port on one or more ports, to see if open.   Don't use nmap since it's overkill.
 #
 # OUTPUT:
 #   plain text
 #
 # PLATFORMS:
-#   Linux, Windows, BSD, Solaris, etc
+#   Linux
 #
 # DEPENDENCIES:
 #   gem: sensu-plugin
-#   nmap package
 #
 # USAGE:
-#   $ ./check-ports.rb --host some_server --ports 5671,5672 --level crit
+#
+# To check there is only one zk leader
+# ./check-ports-socket.rb -h localhost -p 22,25,80
 #
 # NOTES:
-#   #YELLOW
-#   Look at rewriting this using the namp library to not depend on external tools
+# By default, checks for openssh on localhost port 22
+#
 #
 # LICENSE:
-#   Copyright 2013 GoDaddy.com, LLC <jjmanzer@godaddy.com>
 #   Released under the same terms as Sensu (the MIT license); see LICENSE
 #   for details.
-#
 
-require 'open3'
 require 'sensu-plugin/check/cli'
-require 'json'
+require 'socket'
+require 'timeout'
 
-# CheckPorts
-class CheckPorts < Sensu::Plugin::Check::CLI
+#
+# Check Banner
+#
+class CheckPort < Sensu::Plugin::Check::CLI
   option :host,
-         description: 'Resolving name or IP address of target host',
-         short: '-h HOST',
-         long: '--host HOST',
-         default: 'localhost'
+         short: '-H HOSTNAME',
+         long: '--hostname HOSTNAME',
+         description: 'Host to connect to',
+         default: '0.0.0.0'
 
   option :ports,
-         description: 'TCP port(s) you wish to get status for',
-         short: '-t PORT,PORT...',
-         long: '--ports PORT,PORT...'
-
-  option :level,
-         description: 'Alert level crit(critical) or warn(warning)',
-         short: '-l crit|warn',
-         long: '--level crit|warn',
-         default: 'WARN'
+         short: '-p PORTS',
+         long: '--ports PORTS',
+         description: 'Ports to check, comma separated (22,25,3030)',
+         default: '22'
 
-  def run
-    stdout, stderr = Open3.capture3(
-      ENV,
-      "nmap -P0 -p #{config[:ports]} #{config[:host]}"
-    )
+  option :timeout,
+         short: '-t SECS',
+         long: '--timeout SECS',
+         description: 'Connection timeout',
+         proc: proc(&:to_i),
+         default: 30
 
-    case stderr
-    when /Failed to resolve/
-      critical 'cannot resolve the target hostname'
+  def check_port(port)
+    timeout(config[:timeout]) do
+      TCPSocket.new(config[:host], port.to_i)
     end
+    rescue Errno::ECONNREFUSED
+      critical "Connection refused by #{config[:host]}:#{port}"
+    rescue Timeout::Error
+      critical "Connection or read timed out (#{config[:host]}:#{port})"
+    rescue Errno::EHOSTUNREACH
+      critical "Check failed to run: No route to host (#{config[:host]}:#{port})"
+    rescue EOFError
+      critical "Connection closed unexpectedly (#{config[:host]}:#{port})"
+  end
 
-    port_checks = {}
-    check_pass  = true
-
-    stdout.split("\n").each do |line|
-      line.scan(/(\d+).tcp\s+(\w+)\s+(\w+)/).each do |status|
-        port_checks[status[1]] ||= []
-        port_checks[status[1]].push status[0]
-        check_pass = false unless status[1]['open']
-      end
+  def run
+    ports = config[:ports].split(',')
+    okarray = []
+    ports.each do |port|
+      okarray << 'ok' if check_port port
     end
-
-    result = port_checks.map { |state, ports| "#{state}:#{ports.join(',')}" }.join(' ')
-
-    if check_pass
-      ok result
-    elsif config[:level].upcase == 'WARN'
-      warning result
-    elsif config[:level].upcase == 'CRIT'
-      critical result
+    if okarray.size == ports.size
+      ok "All ports (#{config[:ports]}) are accessible for host #{config[:host]}"
     else
-      unknown "Unknown alert level #{config[:level]}"
+      critical "port count or pattern #{config[:pattern]} does not match" unless config[:crit_message]
     end
   end
 end

data/bin/check-rbl.rb

@@ -77,7 +77,7 @@ class RblCheck < Sensu::Plugin::Check::CLI
     criticality = 0
 
     # #YELLOW
-    dnsbl_ret.each do |dnsbl_result| # rubocop:disable Style/Next
+    dnsbl_ret.each do |dnsbl_result|
       if dnsbl_result.meaning =~ /spam/i || dnsbl_result.meaning =~ /blacklist/i
         unless ignored_bls_set.member?(dnsbl_result.dnsbl)
           msg_string =  "#{msg_string} #{dnsbl_result.dnsbl}"

data/bin/metrics-netif.rb

@@ -38,7 +38,7 @@ class NetIFMetrics < Sensu::Plugin::Metric::CLI::Graphite
          default: "#{Socket.gethostname}"
 
   def run
-    `sar -n DEV 1 1 | grep Average | grep -v IFACE`.each_line do |line|  # rubocop:disable Style/Next
+    `sar -n DEV 1 1 | grep Average | grep -v IFACE`.each_line do |line|
       stats = line.split(/\s+/)
       unless stats.empty?
         stats.shift

data/bin/metrics-netstat-tcp.rb

@@ -80,7 +80,7 @@ class NetstatTCPMetrics < Sensu::Plugin::Metric::CLI::Graphite
     state_counts = Hash.new(0)
     TCP_STATES.each_pair { |_hex, name| state_counts[name] = 0 }
 
-    File.open('/proc/net/' + protocol).each do |line| # rubocop:disable Style/Next
+    File.open('/proc/net/' + protocol).each do |line|
       line.strip!
       if m = line.match(/^\s*\d+:\s+(.{8}):(.{4})\s+(.{8}):(.{4})\s+(.{2})/) # rubocop:disable AssignmentInCondition
         connection_state = m[5]
@@ -99,7 +99,7 @@ class NetstatTCPMetrics < Sensu::Plugin::Metric::CLI::Graphite
   def run
     timestamp = Time.now.to_i
     netstat('tcp').each do |state, count|
-      graphite_name = config[:port] ? "#{config[:scheme]}.#{config[:port]}.#{state}" : # rubocop:disable all
+      graphite_name = config[:port] ? "#{config[:scheme]}.#{config[:port]}.#{state}" :
         "#{config[:scheme]}.#{state}"
       output "#{graphite_name}", count, timestamp
     end

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

@@ -2,7 +2,7 @@ module SensuPluginsNetworkChecks
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 5
+    PATCH = 6
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-network-checks
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dnsbl-client
@@ -230,6 +230,7 @@ executables:
 - check-whois-domain-expiration-multi.rb
 - check-rbl.rb
 - check-ports.rb
+- check-ports-nmap.rb
 - check-ping.rb
 - check-netstat-tcp.rb
 - check-multicast-groups.rb
@@ -246,6 +247,7 @@ files:
 - bin/check-multicast-groups.rb
 - bin/check-netstat-tcp.rb
 - bin/check-ping.rb
+- bin/check-ports-nmap.rb
 - bin/check-ports.rb
 - bin/check-rbl.rb
 - bin/check-whois-domain-expiration-multi.rb