kafkat 0.0.9

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjAwMzc4N2FlYjVhYmYzZTRkOGRlYWIxZWRkZWY1ZjM4NjlkMWE0Mw==
+  data.tar.gz: !binary |-
+    Mzk4ZjIxNzhmZWZjN2QzZjZiODk4ODA3NmZmYWY5N2Y0Yzg2MmNiNQ==
+SHA512:
+  metadata.gz: !binary |-
+    YTMwNzhiNTliZTU1ZmY0OWYxYTY2NGIzZWEwZGI4ZDQ3ODQyNDU4Njg1ZTgw
+    ZmM4NGZiYjNlMWFkYjIxMDIwNjFhZWIwN2ZjYWRhNGE0MWE1NmU1NDI2Njhl
+    NWIwNjE0YTQ5YWRhNTNmZjFlM2ZjMDk5N2FhNDM2MWY4Nzc3YTE=
+  data.tar.gz: !binary |-
+    NzZiZmZjNjlmNmRjMzBhYjRhZDVmOTdmZDU5MTE1YWFlOTZmODNmZDY5YmU2
+    ZTFkNmM2YjVhMGNkM2FjMWI4ZmY4MTNlYjZiMDlkY2UyNzU2ZWQwMTY4MmVk
+    ZGNhNGM2OGQxMWVmNGQ5YzMwOWU3MGYyMzc1MmE4ZDdjYWRiNzc=

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+*.iws
+*.iml
+*.ipr
+

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    kafkat (0.0.7)
+      colored (~> 1.2)
+      highline (~> 1.6.21)
+      retryable (~> 1.3.5)
+      trollop (~> 2.0)
+      zk (~> 1.9.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colored (1.2)
+    highline (1.6.21)
+    little-plugger (1.1.3)
+    logging (1.8.2)
+      little-plugger (>= 1.1.3)
+      multi_json (>= 1.8.4)
+    multi_json (1.10.1)
+    retryable (1.3.5)
+    trollop (2.0)
+    zk (1.9.4)
+      logging (~> 1.8.2)
+      zookeeper (~> 1.4.0)
+    zookeeper (1.4.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kafkat!

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,59 @@
+kafkat
+======
+
+Simplified command-line administration for Kafka brokers.
+
+## Contact 
+**Let us know!** If you fork this, or if you use it, or if it helps in anyway, we'd love to hear from you! opensource@airbnb.com
+
+## License & Attributions
+This project is released under the Apache License Version 2.0 (APLv2).
+
+
+## Usage
+
+* Install the gem.
+
+```
+gem install kafkat
+```
+
+* Create a new configuration file to match your deployment.
+
+```
+{
+  "kafka_path": "/srv/kafka/kafka_2.10-0.8.1.1",
+  "log_path": "/mnt/kafka-logs",
+  "zk_path": "zk0.foo.ca:2181,zk1.foo.ca:2181,zk2.foo.ca:2181/kafka"
+}
+```
+
+Kafkat searches for this file in two places, `~/.kafkatcfg` and `/etc/kafkatcfg`.
+
+* At any time, you can run `kafkat` to get a list of available commands and their arguments.
+
+```
+$ kafkat
+kafkat 0.0.1: Simplified command-line administration for Kafka brokers
+usage: kafkat [command] [options]
+
+Here's a list of supported commands:
+
+  brokers                                             Print available brokers from Zookeeper.
+  clean-indexes                                       Delete untruncated Kafka log indexes from the filesystem.
+  controller                                          Print the current controller.
+  elect-leaders [topic]                               Begin election of the preferred leaders.
+  partitions [topic]                                  Print partitions by topic.
+  partitions [topic] --under-replicated               Print partitions by topic (only under-replicated).
+  partitions [topic] --unavailable                    Print partitions by topic (only unavailable).
+  reassign [topic] [--brokers <ids>] [--replicas <n>] Begin reassignment of partitions.
+  resign-rewrite <broker id>                          Forcibly rewrite leaderships to exclude a broker.
+  resign-rewrite <broker id> --force                  Same as above but proceed if there are no available ISRs.
+  shutdown <broker id>                                Gracefully remove leaderships from a broker (requires JMX).
+  topics                                              Print all topics.
+  
+```
+
+## Important Note
+
+The gem needs read/write access to the Kafka log directory for some operations (clean indexes).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['-cfs --backtrace']
+end

data/bin/kafkat

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path('../../lib', __FILE__)
+require 'kafkat'
+Kafkat::CLI.run!

data/kafkat.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'kafkat/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'kafkat'
+  s.version      = Kafkat::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Nelson Gauthier"]
+  s.email        = ['nelson@airbnb.com']
+  s.homepage     = 'https://github.com/airbnb/kafkat'
+  s.summary      = "Simplified command-line administration for Kafka brokers"
+  s.description  = s.summary
+  s.license      = 'Apache-v2'
+
+  s.files        = `git ls-files`.split($/)
+  s.executables  = s.files.grep(%r{^bin/}) { |f| File.basename f }
+  s.test_files   = s.files.grep(%r{^(test|spec|features)/})
+  s.require_path = 'lib'
+
+  s.add_runtime_dependency 'zk', '~> 1.9.4'
+  s.add_runtime_dependency 'trollop', '~> 2.0'
+  s.add_runtime_dependency 'highline', '~> 1.6.21'
+  s.add_runtime_dependency 'retryable', '~> 1.3.5'
+  s.add_runtime_dependency 'colored', '~> 1.2'
+end

data/lib/kafkat/cli.rb

@@ -0,0 +1,71 @@
+module Kafkat
+  class CLI
+    attr_reader :config
+
+    def self.run!
+      new.run
+    end
+
+    def run
+      load_config
+      run_command
+    end
+
+    def load_config
+      @config = Config.load!
+    rescue Config::NotFoundError
+      no_config_error
+    rescue Config::ParseError
+      bad_config_error
+    end
+
+    def run_command
+      name = ARGV.shift
+      if name
+        command_klass = Command.get(name)
+        command = command_klass.new(config)
+        command.run
+      else
+        print_banner
+        print_commands
+        exit 0
+      end
+    rescue Command::NotFoundError
+      no_command_error
+    end
+
+    def print_banner
+      print "kafkat #{VERSION}: Simplified command-line administration for Kafka brokers\n"
+      print "usage: kafkat [command] [options]\n"
+    end
+
+    def print_commands
+      print "\nHere's a list of supported commands:\n\n"
+      Command.all.values.sort_by(&:command_name).each do |klass|
+        klass.usages.each do |usage|
+          format, description = usage[0], usage[1]
+          padding_length = 52 - format.length
+          padding = " " * padding_length
+          print "  #{format}#{padding}#{description}\n"
+        end
+      end
+      print "\n"
+    end
+
+    def no_config_error
+      print "Configuration file not found (~/.kafkatcfg). See documentation.\n"
+      exit 1
+    end
+
+    def bad_config_error
+      print "Configuration file failed to parse (~/.kafkatcfg).\n"
+      exit 1
+    end
+
+    def no_command_error
+      print "This command isn't recognized.\n"
+      print_commands
+      exit 1
+    end
+  end
+end

data/lib/kafkat/cluster/assignment.rb

@@ -0,0 +1,4 @@
+module Kafkat
+  class Assignment < Struct.new(:topic_name, :partition_id, :replicas)
+  end
+end

data/lib/kafkat/cluster/broker.rb

@@ -0,0 +1,4 @@
+module Kafkat
+  class Broker < Struct.new(:id, :host, :port)
+  end
+end

data/lib/kafkat/cluster/partition.rb

@@ -0,0 +1,11 @@
+module Kafkat
+  class Partition < Struct.new(:topic_name, :id, :replicas, :leader, :isr)
+    def has_leader?(brokers)
+      leader && leader != -1 && brokers.include?(leader)
+    end
+
+    def under_replicated?
+      isr.size < replicas.size
+    end
+  end
+end

data/lib/kafkat/cluster/topic.rb

@@ -0,0 +1,4 @@
+module Kafkat
+  class Topic < Struct.new(:name, :partitions)
+  end
+end

data/lib/kafkat/cluster.rb

@@ -0,0 +1,4 @@
+require 'kafkat/cluster/broker'
+require 'kafkat/cluster/topic'
+require 'kafkat/cluster/partition'
+require 'kafkat/cluster/assignment'

data/lib/kafkat/command/brokers.rb

@@ -0,0 +1,16 @@
+module Kafkat
+  module Command
+    class Brokers < Base
+      register_as 'brokers'
+
+      usage 'brokers',
+            'Print available brokers from Zookeeper.'
+
+      def run
+        bs = zookeeper.get_brokers
+        print_broker_header
+        bs.each { |id, b| print_broker(b) }
+      end
+    end
+  end
+end

data/lib/kafkat/command/clean-indexes.rb

@@ -0,0 +1,30 @@
+module Kafkat
+  module Command
+    class CleanIndexes < Base
+      register_as 'clean-indexes'
+
+      usage 'clean-indexes',
+            'Delete untruncated Kafka log indexes from the filesystem.'
+
+      def run
+        print "This operation will remove any untruncated index files.\n"
+        return unless ask("Proceed (y/n)?")
+
+        begin
+          print "\nStarted.\n"
+          count = kafka_logs.clean_indexes!
+          print "\nDone (#{count} index file(s) removed).\n"
+        rescue Interface::KafkaLogs::NoLogsError => e
+          print "ERROR: Kakfa log directory doesn't exist.\n"
+          exit 1
+        rescue Interface::KafkaLogs::KafkaRunningError => e
+          print "ERROR: Kafka is still running.\n"
+          exit 1
+        rescue => e
+          print "ERROR: #{e}\n"
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/kafkat/command/controller.rb

@@ -0,0 +1,18 @@
+module Kafkat
+  module Command
+    class Controller < Base
+      register_as 'controller'
+
+      usage 'controller',
+            'Print the current controller.'
+
+      def run
+        c = zookeeper.get_controller
+        print "The current controller is '#{c.id}' (#{c.host}:#{c.port}).\n"
+      rescue Interface::Zookeeper::NotFoundError
+        print "ERROR: Couldn't determine the current controller.\n"
+        exit 1
+      end
+    end
+  end
+end

data/lib/kafkat/command/elect-leaders.rb

@@ -0,0 +1,31 @@
+module Kafkat
+  module Command
+    class ElectLeaders < Base
+      register_as 'elect-leaders'
+
+      usage 'elect-leaders [topic]',
+            'Begin election of the preferred leaders.'
+
+      def run
+        topic_name = ARGV[0] && ARGV.shift
+        topic_names = topic_name && [topic_name]
+
+        topics = zookeeper.get_topics(topic_names)
+        partitions = topics.values.map(&:partitions).flatten
+
+        topics_s = topic_name ? "'#{topic_name}'" : "all topics"
+        print "This operation elects the preferred replicas for #{topics_s}.\n"
+        return unless agree("Proceed (y/n)?")
+
+        result = nil
+        begin
+          print "\nBeginning.\n"
+          result = admin.elect_leaders!(partitions)
+          print "Started.\n"
+        rescue Admin::ExecutionFailedError
+          print result
+        end
+      end
+    end
+  end
+end

data/lib/kafkat/command/partitions.rb

@@ -0,0 +1,50 @@
+module Kafkat
+  module Command
+    class Describe < Base
+      register_as 'partitions'
+
+      usage 'partitions [topic]',
+            'Print partitions by topic.'
+      usage 'partitions [topic] --under-replicated',
+            'Print partitions by topic (only under-replicated).'
+      usage 'partitions [topic] --unavailable',
+            'Print partitions by topic (only unavailable).'
+
+      def run
+        topic_name = ARGV.shift unless ARGV[0] && ARGV[0].start_with?('--')
+        topic_names = topic_name && [topic_name]
+
+        @options = Trollop.options do
+          opt :under_replicated, "only under-replicated"
+          opt :unavailable, "only unavailable"
+        end
+
+        brokers = zookeeper.get_brokers
+        topics = zookeeper.get_topics(topic_names)
+
+        print_partition_header
+        topics.each do |name, t|
+          t.partitions.each do |p|
+            print_partition(p) if selected?(p, brokers)
+          end
+        end
+      end
+
+      private
+
+      def selected?(partition, brokers)
+        return partition.under_replicated? if only_under_replicated?
+        return !partition.has_leader?(brokers) if only_unavailable?
+        true
+      end
+
+      def only_under_replicated?
+        !!@options[:under_replicated]
+      end
+
+      def only_unavailable?
+        !!@options[:unavailable]
+      end
+    end
+  end
+end