sensu-plugins-kafka2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5293e6f3f72c886f60357c7ec6678ef2a10d51c7
+  data.tar.gz: 2adbaccff255d582e717dd39a44880cd77f7f61d
+SHA512:
+  metadata.gz: 82bddbf508eb6a0c7951dac80b3516873bd382ce595cf70e012d19732af8e983191d0eb6e2338c218ee21ab912266360fefcb746548626eb076c75a263d47e75
+  data.tar.gz: cc2f2f22af7625905e0caba931602695ba5994c73129d797216a8041a062b61361fc3b1319a9a58b67f33f26bc5786e35d7036e2a8cd3fdd989a2734c4bbd64f

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format located [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
+
+## [Unreleased]
+
+### Breaking Changes
+- renamed to `sensu-plugins-kafka2` to avoid namespace conflict per [this](https://github.com/obazoud/sensu-plugins-kafka/issues/21) issue (@majormoses)
+
+### Added
+- check-kafka-ping.rb(@yuri-zubov sponsored by Actility, https://www.actility.com)
+- check-topic.rb(@yuri-zubov sponsored by Actility, https://www.actility.com)
+- check-topics-name.rb(@yuri-zubov sponsored by Actility, https://www.actility.com)
+- metrics-kafka-http.rb(@yuri-zubov sponsored by Actility, https://www.actility.com)
+
+- Basic Skel to be used to make new plugin repo setup easier.
+- PR template
+- Rubocop config
+- basic testing setup
+- removing EOL versions of ruby
+- patching for any known CVEs
+
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-kafka/compare/d4eebcfed091899571e21c0e433cceb3e386d2c7...HEAD

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sensu Community Plugins
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,20 @@
+## Sensu-Plugins-kafka2
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-skel.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-kafka2)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-skel.svg)](http://badge.fury.io/rb/sensu-plugins-kafka2)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-kafka2.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-skel)
+[![Community Slack](https://slack.sensu.io/badge.svg)](https://slack.sensu.io/badge)
+
+## Functionality
+
+## Files
+
+## Usage
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes
+
+Requires a c compiler to install see `test/bootstrap.sh` to see an example of installing it

data/bin/check-kafka-ping.rb

@@ -0,0 +1,52 @@
+#! /usr/bin/env ruby
+#
+# check-kafka-ping
+#
+# DESCRIPTION:
+#  check-kafka-ping get Kafka overall status
+#
+# OUTPUT:
+#   UP/DOWN
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: rest-clien
+#
+# USAGE:
+#
+# NOTES:
+#  Depends on https://github.com/arnobroekhof/kafka-http-metrics-reporter
+#
+# LICENSE:
+#   Zubov Yuri <yury.zubau@gmail.com> sponsored by Actility, https://www.actility.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+require 'sensu-plugins-kafka'
+
+class CheckKafkaPing < Sensu::Plugin::Check::CLI
+  include CommonKafka
+
+  option :endpoint,
+         short: '-p ENDPOINT',
+         long: '--endpoint ENDPOINT',
+         description: 'kafka.http.metrics Endpoint',
+         default: 'http://localhost:8897/api/ping'
+
+  def run
+    result = request
+    if result.to_s.strip == 'pong'
+      ok 'Kafka is UP'
+    elsif result == 'DOWN'
+      warning 'Kafka is DOWN'
+    end
+  rescue StandardError => e
+    critical e.message
+  end
+end

data/bin/check-topic.rb

@@ -0,0 +1,152 @@
+#! /usr/bin/env ruby
+#
+# check-topic
+#
+# DESCRIPTION:
+#   This plugin checks topic properties.
+#
+# OUTPUT:
+#   plain-text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: zookeeper
+#
+# USAGE:
+#   ./check-topic
+#
+# NOTES:
+#
+# LICENSE:
+#   Olivier Bazoud
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'json'
+require 'zookeeper'
+
+class TopicsCheck < Sensu::Plugin::Check::CLI
+  option :zookeeper,
+         description: 'ZooKeeper connect string (host:port,..)',
+         short: '-z ZOOKEEPER',
+         long: '--zookeeper ZOOKEEPER',
+         default: 'localhost:2181',
+         required: true
+
+  option :name,
+         description: 'Topic name',
+         short: '-n TOPIC_NAME',
+         long: '--name TOPIC_NAME',
+         required: true
+
+  option :partitions,
+         description: 'Partitions',
+         short: '-p PARTITIONS_COUNT',
+         long: '--partitions TOPIC_NAME',
+         proc: proc(&:to_i)
+
+  option :replication_factor,
+         description: 'Replication factor',
+         short: '-r REPLICATION_FACTOR',
+         long: '--replication-factor REPLICATION_FACTOR',
+         proc: proc(&:to_i)
+
+  option :configs,
+         description: 'Topic configurations',
+         short: '-c CONFIG',
+         long: '--configs CONFIG',
+         proc: proc { |a| JSON.parse(a) }
+
+  option :replicas,
+         description: 'Check replicats',
+         short: '-a',
+         long: '--replicas',
+         default: false,
+         boolean: false
+
+  option :leader,
+         description: 'Check leader',
+         short: '-l',
+         long: '--leader',
+         default: false,
+         boolean: false
+
+  def replicas_check(partitions, brokers)
+    partitions.each do |num, replica|
+      next if (replica - brokers).empty?
+      critical "Topic '#{config[:name]}', partition #{num}: unknown replica #{replica - brokers}"
+    end
+  end
+
+  def leader_check(partitions, brokers, zookeeper)
+    partitions.each do |num, replica|
+      state_json = zookeeper.get(path: "/brokers/topics/#{config[:name]}/partitions/#{num}/state")[:data]
+      state = JSON.parse(state_json)
+      unless brokers.include? state['leader']
+        critical "Topic '#{config[:name]}', partition #{num}: unknown leader #{state['leader']}"
+      end
+      unless replica[0] == state['leader']
+        critical "Topic '#{config[:name]}', partition #{num}: preferred replica is not #{replica[0]}"
+      end
+      unless (replica - state['isr']).empty? && (state['isr'] - replica).empty?
+        critical "Topic '#{config[:name]}', partition #{num}: isr is not consistent"
+      end
+      unless (state['isr'] - brokers).empty?
+        critical "Topic '#{config[:name]}', partition #{num}: unknown isr #{state['isr'] - brokers}"
+      end
+    end
+  end
+
+  def run
+    z = Zookeeper.new(config[:zookeeper])
+
+    topics = z.get_children(path: '/brokers/topics')[:children].sort
+
+    critical "Topic '#{config[:name]}' not found" unless topics.include? config[:name]
+
+    if config.key?(:partitions) || config.key?(:replication_factor)
+      brokers = z.get_children(path: '/brokers/ids')[:children].map(&:to_i)
+      partitions_data = z.get(path: "/brokers/topics/#{config[:name]}")[:data]
+      partitions = JSON.parse(partitions_data)['partitions']
+      if config.key?(:partitions) && partitions.size != config[:partitions]
+        critical "Topic '#{config[:name]}' has #{partitions.size} partitions, expecting #{config[:partitions]}"
+      end
+
+      if config.key?(:replication_factor)
+        min = partitions.min_by { |_, b| b.size }[1].length
+        max = partitions.max_by { |_, b| b.size }[1].length
+        if config[:replication_factor] != min || min != max
+          critical "Topic '#{config[:name]}' RF is between #{min} and #{max}, expecting #{config[:replication_factor]}"
+        end
+      end
+
+      if config[:replicas]
+        replicas_check(partitions, brokers)
+      end
+
+      if config[:leader]
+        leader_check(partitions, brokers, z)
+      end
+
+      if config.key?(:configs)
+        config_data = z.get(path: "/config/topics/#{config[:name]}")[:data]
+        configs = JSON.parse(config_data)['config']
+        config[:configs].each do |k, v|
+          if !configs.key?(k) || configs[k].to_s != v.to_s
+            critical "Topic '#{config[:name]}': config #{k} = #{v}, expecting #{configs[k]}"
+          end
+        end
+      end
+
+    end
+    ok
+  rescue => e
+    puts "Error: #{e.backtrace}"
+    critical "Error: #{e}"
+  end
+end

data/bin/check-topics-name.rb

@@ -0,0 +1,61 @@
+#! /usr/bin/env ruby
+#
+# check-topics-name
+#
+# DESCRIPTION:
+#   This plugin checks topic's name.
+#
+# OUTPUT:
+#   plain-text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: zookeeper
+#
+# USAGE:
+#   ./check-topics-name
+#
+# NOTES:
+#
+# LICENSE:
+#   Olivier Bazoud
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'json'
+require 'zookeeper'
+
+class TopicsCheck < Sensu::Plugin::Check::CLI
+  option :zookeeper,
+         description: 'ZooKeeper connect string (host:port,..)',
+         short: '-z ZOOKEEPER',
+         long: '--zookeeper ZOOKEEPER',
+         default: 'localhost:2181',
+         required: true
+
+  option :name,
+         description: 'Topic name',
+         short: '-n TOPIC_NAME',
+         long: '--name TOPIC_NAME',
+         proc: proc { |a| a.split(',') },
+         required: true
+
+  def run
+    z = Zookeeper.new(config[:zookeeper])
+
+    topics = z.get_children(path: '/brokers/topics')[:children].sort
+
+    critical "Topics '#{config[:name] - topics}' not found" unless (config[:name] - topics).empty?
+    warning "Topics '#{topics - config[:name]}' not checked" unless (topics - config[:name]).empty?
+
+    ok
+  rescue => e
+    puts "Error: #{e.backtrace}"
+    critical "Error: #{e}"
+  end
+end

data/bin/metrics-kafka-http.rb

@@ -0,0 +1,57 @@
+#! /usr/bin/env ruby
+#
+# metrics-kafka-http
+#
+# DESCRIPTION:
+#  metrics-kafka-http get metrics from Kafka
+#
+# OUTPUT:
+#   metric-data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: rest-clien
+#
+# USAGE:
+#
+#
+# NOTES:
+#  Depends on https://github.com/arnobroekhof/kafka-http-metrics-reporter
+#
+# LICENSE:
+#   Zubov Yuri <yury.zubau@gmail.com> sponsored by Actility, https://www.actility.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'rest-client'
+require 'json'
+require 'sensu-plugins-kafka'
+
+class MetricsKafkaHttp < Sensu::Plugin::Metric::CLI::Generic
+  include CommonKafka
+  option :endpoint,
+         short: '-p ENDPOINT',
+         long: '--endpoint ENDPOINT',
+         description: 'kafka.http.metrics Endpoint',
+         default: 'http://localhost:8897/api/metrics'
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-S SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.kafka"
+
+  def metrics
+    response = request
+    ::JSON.parse(response)
+  end
+
+  def run
+    print_hash(metrics)
+    ok
+  end
+end

data/lib/sensu-plugins-kafka2.rb

@@ -0,0 +1,2 @@
+require 'sensu-plugins-kafka2/common_kafka'
+require 'sensu-plugins-kafka2/version'

data/lib/sensu-plugins-kafka2/common_kafka.rb

@@ -0,0 +1,21 @@
+module CommonKafka2
+  def request
+    RestClient::Request.execute(
+      method: :get,
+      url: config[:endpoint]
+    )
+  end
+
+  def print_hash(hash, path = '')
+    hash.each do |key, value|
+      next if %w[unit event_type type].include?(key)
+      new_path = "#{path}.#{key}"
+      if value.is_a? Hash
+        print_hash(value, new_path)
+      else
+        output metric_name: "#{config[:scheme]}#{new_path}", value: value
+      end
+    end
+    false
+  end
+end

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

@@ -0,0 +1,9 @@
+module SensuPluginsKafka2
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,273 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-kafka2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: zookeeper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: kitchen-docker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: kitchen-localhost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.36.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.36.1
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: Sensu kafka plugins
+email: "<sensu-users@googlegroups.com>"
+executables:
+- check-kafka-ping.rb
+- check-topic.rb
+- check-topics-name.rb
+- metrics-kafka-http.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-kafka-ping.rb
+- bin/check-topic.rb
+- bin/check-topics-name.rb
+- bin/metrics-kafka-http.rb
+- lib/sensu-plugins-kafka2.rb
+- lib/sensu-plugins-kafka2/common_kafka.rb
+- lib/sensu-plugins-kafka2/version.rb
+homepage: https://github.com/sensu-plugins/sensu-plugins-kafka
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for kafka
+test_files: []