sensu-plugins-zookeeper 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 326e3e7e050ee97c7391843215f8222618cc3584
-  data.tar.gz: 3a8925749d5d0f87d6b14020b7ebca4608ef87c3
+  metadata.gz: 174dd29207e5b80cb3b2eec532665c8c4ac8611c
+  data.tar.gz: 859d3e6f1c0c2c33d7fe5e654fed03f573f53d58
 SHA512:
-  metadata.gz: f2db1a9a3a1315978de601fdffd92b2c4c52821a3a6be7795b9a02de02a5a08e76ee1bfcc3de5b119bf3f7789aa74a7e305fef99f9ccc069a7289f62a119421d
-  data.tar.gz: bfd3614b461395f46a35163c062394f0ea0926f1b6d544d02cc8a3753b9605f3b50886cd46532af1e189584488e8e4d592121f5064c5ad52cb2b319f38922a18
+  metadata.gz: 0ec579d7d4d31b10c00dbb1db9d2e82f3b1806ae6e6e0c190943c01a600993731feaab4c01cb1b6d9b333f6d5549409c4800e397d7734a03bf233a0c274ab05f
+  data.tar.gz: fd914498dfd52ef03f352ee7a119f6929e4fa776d5093ea97ae1d16ca369c26953f2e9145780d75c05c179c09c6f148115df340b769cccbeae7481a2a17989d1

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [1.2.0] - 2017-08-28
+### Added
+- check-zookeper-cluster
+- Ruby 2.4.1 testing
+
 ## [1.1.0] - 2017-03-23
 - add `check-zookeeper-mode` to check if zookeeper is in the expected mode (@karthik-altiscale)
 
@@ -44,6 +49,7 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 - initial release
 
 [Unreleased]: https://github.com/sensu-plugins/sensu-plugins-zookeeper/compare/1.1.0...HEAD
+[1.2.0]: https://github.com/sensu-plugins/sensu-plugins-zookeeper/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/sensu-plugins/sensu-plugins-zookeeper/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-zookeeper/compare/0.1.0...1.0.0
 [0.1.0]: https://github.com/sensu-plugins/sensu-plugins-zookeeper/compare/0.0.4...0.1.0

data/README.md

@@ -16,6 +16,7 @@
 * check-zookeeper-reqs.rb - Check if Zookeeper node has reliable number of outstanding requests
 * check-zookeeper-ruok.rb - Check if Zookeeper node responds to 'ruok' query succesfully
 * check-zookeeper-mode.rb - Check if Zookeeper node is in standalone or cluster(leader or follower) mode
+* check-zookeeper-cluster.rb - Check if a exhibitor managed Zookeeper cluster is OK.
 * metrics-zookeeper.rb - Gather metrics from Zookeeper
 
 ## Usage

data/bin/check-zookeeper-cluster.rb

@@ -0,0 +1,169 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#
+#  check-zookeeper-cluster
+#
+# DESCRIPTION:
+#   Check if a exhibitor managed Zookeeper cluster is OK.
+#
+#   This check will get exhibitor status information,
+#   and check each seperate node for ruok.
+#   This check also will compare cluster node count with a spesific value,
+#   avg latency from mntr for a threshold value, and If the cluster
+#   has a leader.
+#
+# PLATFORMS:
+#   All
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#  Check if a node has Zookeeper running and responds with imok.
+#
+#  Cluster should have 3 nodes, exhibitor status endpoint is not default, and average latency threshold should be 10
+#  ./check-zookeeeper-cluster.rb -c 3 -e http://localhost:8181/exhibitor/v1/cluster/status -l 10
+#
+
+require 'sensu-plugin/check/cli'
+require 'socket'
+require 'net/http'
+require 'json'
+
+class CheckZookeeperCluster < Sensu::Plugin::Check::CLI
+  option :count,
+         description: 'Zookeeper cluster node count',
+         short: '-c count',
+         long: '--count count',
+         default: 3,
+         proc: proc(&:to_i)
+
+  option :zk_port,
+         description: 'Zookeeper nodes\' listen port',
+         short: '-p port',
+         long: '--port port',
+         default: 2181,
+         proc: proc(&:to_i)
+
+  option :count,
+         description: 'Zookeeper cluster node count',
+         short: '-c count',
+         long: '--count count',
+         default: 3,
+         proc: proc(&:to_i)
+
+  option :exhibitor,
+         description: 'exhibitor end node for status checks',
+         short: '-e Exhibitor status end point',
+         long: '--exhibitor status end point',
+         default: 'http://localhost/exhibitor/v1/cluster/status'
+
+  option :latency,
+         description: 'Critical threshold for Zookeeper average latency',
+         short: '-l TICKS',
+         long: '--latency TICKS',
+         proc: proc(&:to_i),
+         default: 10
+
+  option :timeout,
+         description: 'How long to wait for a reply in seconds.',
+         short: '-t SECS',
+         long: '--timeout SECS',
+         proc: proc(&:to_i),
+         default: 5
+
+  def zookeeper_latency(server, port)
+    l = 0
+    TCPSocket.open(server, port) do |socket|
+      socket.write 'mntr'
+      ready = IO.select([socket], nil, nil, config[:timeout])
+      if ready.nil?
+        critical %(Zookeeper did not respond to 'mntr' within #{config[:timeout]} seconds)
+      end
+      l = ready.first.first.read.chomp.split("\n")[1].split("\t")[1].to_i
+    end
+  end
+
+  def check_ruok(server, port)
+    result = false
+    TCPSocket.open(server, port) do |socket|
+      socket.write 'ruok'
+      ready = IO.select([socket], nil, nil, config[:timeout])
+
+      if ready.nil?
+        critical %(Zookeeper did not respond to 'ruok' within #{config[:timeout]} seconds)
+      end
+
+      result = ready.first.first.read.chomp
+    end
+    result == 'imok'
+  end
+
+  def _leader_count(json)
+    l_count = max_latency = 0
+    json.each do |zk|
+      l_count += 1 if zk['isLeader']
+      l = zookeeper_latency(zk['hostname'], config[:zk_port])
+      max_latency = [max_latency, l].max
+    end
+    [l_count, max_latency]
+  end
+
+  def _check_leader(json)
+    e = []
+    l_count, max_latency = _leader_count(json)
+    unless l_count == 1
+      e.push("cluster should have a leader (#{l_count})")
+    end
+    if max_latency > config[:latency]
+      e.push("cluster should have a lower latecy #{max_latency}")
+    end
+    return [true, e] if l_count == 1 && max_latency < config[:latency]
+    [false, e]
+  end
+
+  def check_exhibitor_endpoint(response)
+    json = JSON.parse(response.body)
+    e = []
+    r = false
+    if json.length == config[:count]
+      r, e = _check_leader(json)
+    else
+      e = ["cluster size mismatch (#{json.length}!=#{config[:count]})"]
+    end
+    [r, json, e]
+  end
+
+  def check_exhibitor
+    response = ''
+    json = ''
+    url = URI.parse(config[:exhibitor])
+    req = Net::HTTP::Get.new(url.path)
+    Net::HTTP.new(url.host, url.port).start do |http|
+      response = http.request(req)
+    end
+    return [false, json, ['exhibitor status is not http 200']] unless
+      response.is_a? Net::HTTPSuccess
+    r, json, e = check_exhibitor_endpoint(response)
+    [r, json, e]
+  end
+
+  def check_each_zk(json)
+    r = true
+    hosts = []
+    json.each do |zk|
+      r = check_ruok(zk['hostname'], config[:zk_port])
+      hosts.push(zk['hostname'])
+      return [false, ["#{zk['hostname']} is not ok"]] unless r
+    end
+    [true, hosts]
+  end
+
+  def run
+    result, json, errors = check_exhibitor
+    result, errors = check_each_zk(json) if result
+    message errors.join(', ')
+    ok if result
+    critical
+  end
+end

data/lib/sensu-plugins-zookeeper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-zookeeper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -168,6 +168,7 @@ description: Zookeeper plugins for checks and metrics
 email: "<sensu-users@googlegroups.com>"
 executables:
 - check-znode.rb
+- check-zookeeper-cluster.rb
 - check-zookeeper-file-descriptors.rb
 - check-zookeeper-latency.rb
 - check-zookeeper-mode.rb
@@ -181,6 +182,7 @@ files:
 - LICENSE
 - README.md
 - bin/check-znode.rb
+- bin/check-zookeeper-cluster.rb
 - bin/check-zookeeper-file-descriptors.rb
 - bin/check-zookeeper-latency.rb
 - bin/check-zookeeper-mode.rb