sensu-plugins-zookeeper 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 174dd29207e5b80cb3b2eec532665c8c4ac8611c
-  data.tar.gz: 859d3e6f1c0c2c33d7fe5e654fed03f573f53d58
+  metadata.gz: 72c0c089bdf151003b5f21a405e2fa917840ef76
+  data.tar.gz: d3a5f610c72fb9d9ef6c331eacd18b2e584d4898
 SHA512:
-  metadata.gz: 0ec579d7d4d31b10c00dbb1db9d2e82f3b1806ae6e6e0c190943c01a600993731feaab4c01cb1b6d9b333f6d5549409c4800e397d7734a03bf233a0c274ab05f
-  data.tar.gz: fd914498dfd52ef03f352ee7a119f6929e4fa776d5093ea97ae1d16ca369c26953f2e9145780d75c05c179c09c6f148115df340b769cccbeae7481a2a17989d1
+  metadata.gz: 7ef6c1fdb309c82f192b9299f07f4423e5f5efa518411ca14e3ac4ab02868a6523f46c06ce1a3f233696f9c282a84a5519e7a0be6e357b77564e6202e1f07715
+  data.tar.gz: 5816a75806675c37e4e155eb3dafbe80c3ea694769bd2b42460dd64cc09901f5fcf866d554e0b1808cd62175b15b2056b30a050208e110608aa99545c861a6cd

data/CHANGELOG.md

@@ -1,10 +1,22 @@
 # 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 [Our CHANGELOG Guidelines ](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md).
+Which is based on [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [1.3.0] - 2017-09-09
+### Added
+- metrics-zookeeper-cluster.rb: new script to gather metrics from a zookeeper cluster (@fsniper)
+
+### Changed
+- metrics-zookeeper-cluster.rb: use the plugin name + version as the default user agent over some arbitrary version of curl (@majormoses)
+- updated PR template and CHANGELOG with new CHANGELOG guideline location (@majormoses)
+
+### Fixed
+- spelling in PR template (@majormoses)
+
 ## [1.2.0] - 2017-08-28
 ### Added
 - check-zookeper-cluster
@@ -48,7 +60,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-zookeeper/compare/1.1.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-zookeeper/compare/1.3.0...HEAD
+[1.3.0]: https://github.com/sensu-plugins/sensu-plugins-zookeeper/compare/1.2.0...1.3.0
 [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

data/README.md

@@ -18,6 +18,7 @@
 * 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
+* metrics-zookeeper-cluster.rb - Gather metrics from An Exhibitor run Zookeeper cluster
 
 ## Usage
 

data/bin/metrics-zookeeper-cluster.rb

@@ -0,0 +1,201 @@
+#!/usr/bin/env ruby
+#
+# metrics-zookeeper.rb
+#
+# Collect ZooKeeper metrics
+# ===
+#
+# DESCRIPTION:
+# This plugin gathers metrics from an Exhibitor run ZooKeeper cluster,
+# based on the collectd plugin:
+#
+#   https://github.com/Nextdoor/collectd_plugins/blob/master/zookeeper/zookeeper.sh
+#
+#
+# PLATFORMS:
+#   Linux, BSD, Solaris
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# LICENSE:
+# Sean Clemmer sczizzo@gmail.com
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+#  for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'socket'
+require 'net/http'
+require 'json'
+
+class ZookeeperMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  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 :scheme,
+         description: 'Metric naming scheme, text to prepend to metrics',
+         long: '--scheme SCHEME',
+         default: 'zookeeper'
+
+  def follow_url(uri_str, agent = "sensu-plugins-zookeeper/#{SensuPluginsZookeeper::Version::VER_STRING}", max_attempts = 10, timeout = 10)
+    attempts = 0
+    cookie = nil
+
+    until attempts >= max_attempts
+      attempts += 1
+
+      url = URI.parse(uri_str)
+      http = Net::HTTP.new(url.host, url.port)
+      http.open_timeout = timeout
+      http.read_timeout = timeout
+      path = url.path
+      path = '/' if path == ''
+      path += '?' + url.query unless url.query.nil?
+
+      params = { 'User-Agent' => agent, 'Accept' => '*/*' }
+      params['Cookie'] = cookie unless cookie.nil?
+      request = Net::HTTP::Get.new(path, params)
+
+      if url.instance_of?(URI::HTTPS)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      response = http.request(request)
+
+      case response
+      when Net::HTTPSuccess then
+        break
+      when Net::HTTPRedirection then
+        location = response['Location']
+        cookie = response['Set-Cookie']
+        new_uri = URI.parse(location)
+        uri_str = if new_uri.relative?
+                    url + location
+                  else
+                    new_uri.to_s
+                  end
+      else
+        raise 'Unexpected response: ' + response.inspect
+      end
+
+    end
+    raise 'Too many http redirects' if attempts == max_attempts
+
+    response
+  end
+
+  def dotted(*args)
+    args.join('.')
+  end
+
+  def zk_command(four_letter_word, host, port)
+    Socket.tcp(host, port) do |sock|
+      sock.print "#{four_letter_word}\r\n"
+      sock.close_write
+      sock.read
+    end
+  end
+
+  def exhibitor_status
+    response = follow_url(config[:exhibitor])
+    JSON.parse(response.body)
+  rescue StandardError => e
+    [false, json, ['exhibitor status is not http 200 ' + e.message]]
+  end
+
+  def run
+    timestamp = Time.now.to_i
+
+    json = exhibitor_status
+    json.each do |zk|
+      hostname = zk['hostname']
+      response  = zk_command(:mntr, hostname, 2181)
+      metrics   = {}
+
+      if response =~ /^zk_avg_latency\s*(\d+)$/
+        metrics[:zk_avg_latency] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_max_latency\s*(\d+)$/
+        metrics[:zk_max_latency] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_min_latency\s*(\d+)$/
+        metrics[:zk_min_latency] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_packets_received\s*(\d+)$/
+        metrics[:zk_packets_received] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_packets_sent\s*(\d+)$/
+        metrics[:zk_packets_sent] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_num_alive_connections\s*(\d+)$/
+        metrics[:zk_num_alive_connections] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_outstanding_requests\s*(\d+)$/
+        metrics[:zk_outstanding_requests] = Regexp.last_match(1).to_i
+      end
+
+      metrics[:zk_is_leader] = if response =~ /^zk_server_state\s*leader$/
+                                 1
+                               else
+                                 0
+                               end
+
+      if response =~ /^zk_znode_count\s*(\d+)$/
+        metrics[:zk_znode_count] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_watch_count\s*(\d+)$/
+        metrics[:zk_watch_count] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_ephemerals_count\s*(\d+)$/
+        metrics[:zk_ephemerals_count] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_approximate_data_size\s*(\d+)$/
+        metrics[:zk_approximate_data_size] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_open_file_descriptor_count\s*(\d+)$/
+        metrics[:zk_open_file_descriptor_count] = Regexp.last_match(1).to_i
+      end
+
+      if response =~ /^zk_max_file_descriptor_count\s*(\d+)$/
+        metrics[:zk_max_file_descriptor_count] = Regexp.last_match(1).to_i
+      end
+
+      metrics[:zk_followers] = if response =~ /^zk_followers\s*(\d+)$/
+                                 Regexp.last_match(1).to_i
+                               else
+                                 0
+                               end
+
+      metrics[:zk_synced_followers] = if response =~ /^zk_synced_followers\s*(\d+)$/
+                                        Regexp.last_match(1).to_i
+                                      else
+                                        0
+                                      end
+
+      metrics[:zk_pending_syncs] = if response =~ /^zk_pending_syncs\s*(\d+)$/
+                                     Regexp.last_match(1).to_i
+                                   else
+                                     0
+                                   end
+
+      metrics.each do |metric, value|
+        output dotted(config[:scheme], hostname, metric), value, timestamp
+      end
+    end
+    ok
+  end
+end

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

@@ -1,7 +1,7 @@
 module SensuPluginsZookeeper
   module Version
     MAJOR = 1
-    MINOR = 2
+    MINOR = 3
     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.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -174,6 +174,7 @@ executables:
 - check-zookeeper-mode.rb
 - check-zookeeper-reqs.rb
 - check-zookeeper-ruok.rb
+- metrics-zookeeper-cluster.rb
 - metrics-zookeeper.rb
 extensions: []
 extra_rdoc_files: []
@@ -188,6 +189,7 @@ files:
 - bin/check-zookeeper-mode.rb
 - bin/check-zookeeper-reqs.rb
 - bin/check-zookeeper-ruok.rb
+- bin/metrics-zookeeper-cluster.rb
 - bin/metrics-zookeeper.rb
 - lib/sensu-plugins-zookeeper.rb
 - lib/sensu-plugins-zookeeper/version.rb
@@ -215,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for zookeeper