sensu-plugins-network-checks 0.0.1.alpha.2 → 0.0.1.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 313887c517630cb3ea1af2696f2177fd1d1dacc8
-  data.tar.gz: 711ccebf4a7a2487d5387a7f1d3e1e11728f678e
+  metadata.gz: c31954aa9beb56d49f07b256b97ecbaa26492ea9
+  data.tar.gz: 7ec124eb4454ec3e819bd0c6db035a581742c2a9
 SHA512:
-  metadata.gz: a1320cfabd4bc8ffb4ce71bcffe7bd709a017dda7e56809577024c8e02a4dbf3350874c38015b9ed8a4bef84c2effaca6ee14c7b5188bc793a0ef21cd95a0bf3
-  data.tar.gz: d05ed8213e49614af6e433a70436b4b895aedaff86cc6e8a873c60a024bc6658d0440444881575874133298cb924a128d6a3e81a56feb755f224969d27b123c5
+  metadata.gz: ef3375f158d9e621a5c2e6e5c612de524f1f312e6d93d4d8d92fe087a4fed61a252190f9fbd942d80ad0450f87b15321bf8d05687a936324f063eb6475851071
+  data.tar.gz: 058a106f3dbe594ba1ecce3e7870b54baa06ed6ad1c8e31a09250c143dea901e86d17e8cdaeeb48c9ab1cd6268edb7ad69273f5e93aad9050828e70516fcba9b

data/CHANGELOG.md

@@ -1,8 +1,12 @@
-#### 0.1.0-alpha.1
+#### 0.0.1.alpha.1
 
 * initial release, same as community repo
 
-#### 0.1.0-alpha.2
+#### 0.0.1.alpha.2
 
 * all tests pass
 * initial gem release
+
+#### 0.0.1.alpha.3
+
+* additional functionality to check-banner #6

data/bin/check-banner.rb

@@ -1,11 +1,14 @@
 #! /usr/bin/env ruby
 #
+#  encoding: UTF-8
 #   check-banner
 #
 # DESCRIPTION:
-#   Connect to a TCP port, read one line, test it against a pattern.
-#   Useful for SSH, ZooKeeper, etc.
-
+# Connect to a TCP port on one or more hosts, read till a char (EOF, EOL, etc)
+# and test output against a pattern.
+#
+# Useful for SSH, ZooKeeper, etc.
+#
 # OUTPUT:
 #   plain text
 #
@@ -18,14 +21,21 @@
 #
 # USAGE:
 #
+# To check there is only one zk leader
+# ./check-banner.rb -h 'zk01,z02,zk03' -p 2181 -q leader -c 1 -w mntr -r EOF -O "ZK has one leader"
+# -C "ZK has zero or more than one leader"
+#
 # NOTES:
+# By default, checks for openssh on localhost port 22 and reads till EOL
+#
 #
 # LICENSE:
 #   Copyright 2012 Sonian, Inc <chefs@sonian.net>
+#   Modified by Raghu Udiyar <raghu@helpshift.com>
 #   Released under the same terms as Sensu (the MIT license); see LICENSE
 #   for details.
-#
 
+require 'rubygems' if RUBY_VERSION < '1.9.0'
 require 'sensu-plugin/check/cli'
 require 'socket'
 require 'timeout'
@@ -34,10 +44,10 @@ require 'timeout'
 # Check Banner
 #
 class CheckBanner < Sensu::Plugin::Check::CLI
-  option :host,
-         short: '-H HOSTNAME',
-         long: '--hostname HOSTNAME',
-         description: 'Host to connect to',
+  option :hosts,
+         short: '-H HOSTNAME(S)',
+         long: '--hostnames HOSTNAME(S)',
+         description: 'Host(s) to connect to, comma seperated',
          default: 'localhost'
 
   option :port,
@@ -64,14 +74,42 @@ class CheckBanner < Sensu::Plugin::Check::CLI
          proc: proc(&:to_i),
          default: 30
 
-  def acquire_banner # rubocop:disable all
+  option :count_match,
+         short: '-c NUMBER',
+         long: '--count NUMBER',
+         description: 'Number of successful matches, default(1)',
+         proc: proc(&:to_i),
+         default: 1
+
+  option :read_till,
+         short: '-r CHAR',
+         long: '--readtill CHAR',
+         description: 'Read till CHAR is reached',
+         default: "\n"
+
+  option :ok_message,
+         short: '-O MESSAGE',
+         long: '--okmessage MESSAGE',
+         description: 'Custom ok message to send'
+
+  option :crit_message,
+         short: '-C MESSAGE',
+         long: '--critmessage MESSAGE',
+         description: 'Custom critical message to send'
+
+  def acquire_banner(host) # rubocop:disable all
     timeout(config[:timeout]) do
-      sock = TCPSocket.new(config[:host], config[:port])
+      sock = TCPSocket.new(host, config[:port])
       sock.puts config[:write] if config[:write]
-      sock.readline
+      if config[:read_till] == 'EOF'
+        banner = sock.gets(nil)
+      else
+        banner = sock.gets(config[:read_till])
+      end
+      return banner
     end
   rescue Errno::ECONNREFUSED
-    critical "Connection refused by #{config[:host]}:#{config[:port]}"
+    critical "Connection refused by #{host}:#{config[:port]}"
   rescue Timeout::Error
     critical 'Connection or read timed out'
   rescue Errno::EHOSTUNREACH
@@ -81,8 +119,18 @@ class CheckBanner < Sensu::Plugin::Check::CLI
   end
 
   def run
-    banner = acquire_banner
-    message banner
-    banner =~ /#{config[:pattern]}/ ? ok : warning
+    hosts = config[:hosts].split(',')
+    okarray = []
+    hosts.each do |host|
+      banner = acquire_banner host
+      okarray << 'ok' if banner =~ /#{config[:pattern]}/
+    end
+    if okarray.size == config[:count_match]
+      ok "pattern #{config[:pattern]} matched" unless config[:ok_message]
+      ok config[:ok_message]
+    else
+      critical "pattern #{config[:pattern]} does not match" unless config[:crit_message]
+      critical config[:crit_message]
+    end
   end
 end

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

@@ -3,5 +3,5 @@
 #
 module SensuPluginsNetworkChecks
   # Gem version
-  VERSION = '0.0.1.alpha.2'
+  VERSION = '0.0.1.alpha.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-network-checks
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha.2
+  version: 0.0.1.alpha.3
 platform: ruby
 authors:
 - Yieldbot, Inc. and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin