kafka_replicator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5a3c9b1df23b6f577496c6bf1bfd19f7bac70b6
+  data.tar.gz: f06b89307df2da71928a16566ed14ac9ab771a7c
+SHA512:
+  metadata.gz: f9f5763bacfe9d08578cd2bcda00c6631cd78b64a827ae5a06c468ba36739867fdb8cc35ee883da18e0a5ca475950c67bee96590d0b8abc3fc82e25c26f0479c
+  data.tar.gz: 4c4fdec9594496b2b7a757013c9037c2686c517d97911964ea7388524d4fef7b2d5fbc16f730d615a814a01efa2f1eea6ef0e545da8e65f30ad8b4e895d3d83c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kafka_replicator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    kafka_replicator (0.1.0)
+      json
+      ruby-kafka (~> 0.7.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    digest-crc (0.4.1)
+    json (2.2.0)
+    rake (10.5.0)
+    ruby-kafka (0.7.6)
+      digest-crc
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  kafka_replicator!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Vachagan Gevorgyan
+
+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,39 @@
+# KafkaReplicator
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kafka_replicator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kafka_replicator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kafka_replicator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kafka_replicator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kafka_replicator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kafka_replicator.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kafka_replicator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kafka_replicator"
+  spec.version       = KafkaReplicator::VERSION
+  spec.authors       = ["Vachagan Gevorgyan"]
+  spec.email         = ["v.gevorgyan@catawiki.nl"]
+
+  spec.summary       = %q{Replicate topics from one kafka cluster to another}
+  spec.description   = %q{Simple solution for organizing 2 way syncing between kafka clusters}
+  spec.homepage      = "https://github.com/Vachman/kafka-replicator"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'ruby-kafka', '~> 0.6.0'
+  spec.add_dependency 'multi_json', '~> 1.0'
+end

data/lib/kafka_replicator.rb

@@ -0,0 +1,11 @@
+require "kafka"
+require "kafka_replicator/offsets_sync"
+require 'kafka_replicator/railtie' if defined?(Rails)
+require "kafka_replicator/topics_replicator"
+require "kafka_replicator/version"
+require "logger"
+require "multi_json"
+
+module KafkaReplicator
+  class Error < StandardError; end
+end

data/lib/kafka_replicator/offsets_sync.rb

@@ -0,0 +1,119 @@
+module KafkaReplicator
+  class OffsetsSync
+    attr_reader :source_kafka,
+                :destination_kafka,
+                :destination_consumer,
+                :consumer_group,
+                :logger,
+                :topics
+
+    def initialize(source_brokers:, destination_brokers:, consumer_group:)
+      @source_brokers = source_brokers
+      @destination_brokers = destination_brokers
+      @consumer_group = consumer_group
+      @topics = Hash.new { |h, k| h[k] = {} }
+      @logger = Logger.new(STDOUT)
+    end
+
+    def source_kafka
+      @source_kafka ||= Kafka.new(
+        @source_brokers,
+        client_id: "replicator_source"
+      )
+    end
+
+    def destination_kafka
+      @destination_kafka ||= Kafka.new(
+        @destination_brokers,
+        client_id: "replicator_destination"
+      )
+    end
+
+    def destination_consumer
+      @destination_consumer ||= destination_kafka.consumer(
+        group_id: consumer_group
+      )
+    end
+
+    def source_group_cordinator
+      source_kafka.instance_variable_get('@cluster').send(
+        :get_group_coordinator,
+        group_id: consumer_group
+      )
+    end
+
+    def source_consumer_offsets
+      Kafka::Protocol::OffsetFetchRequest.send(:define_method, "api_version") { 2 }
+      source_group_cordinator.fetch_offsets(group_id: consumer_group, topics: nil)
+    end
+
+    def load_source_consumer_offsets
+      logger.info "load_source_consumer_offsets"
+
+      source_consumer_offsets.topics.each do |topic, partitions|
+        partitions.map do |partition, info|
+          @topics[topic][partition] = { source_consumer_offset: info.offset }
+        end
+      end
+    end
+
+    def load_source_producer_offsets
+      logger.info "load_destination_producer_offsets"
+
+      source_kafka.last_offsets_for(*@topics.keys).each do |topic, partitions|
+        partitions.each do |partition, offset|
+          @topics[topic][partition][:source_producer_offset] = offset
+        end
+      end
+    end
+
+    def load_destination_producer_offsets
+      logger.info "load_source_producer_offsets"
+
+      destination_kafka.last_offsets_for(*@topics.keys).each do |topic, partitions|
+        partitions.each do |partition, offset|
+          @topics[topic][partition][:destination_producer_offset] = offset
+        end
+      end
+    end
+
+    def calculate_destination_consumer_offsets
+      logger.info "calculate_destination_consumer_offsets"
+
+      @topics.each do |topic, partitions|
+        partitions.each do |partition, info|
+          delta = info[:source_producer_offset] - info[:destination_producer_offset]
+          info[:destination_consumer_offsets] = info[:source_consumer_offset] - delta
+        end
+      end
+    end
+
+    def set_destination_consumer_offsets
+      logger.info "set_destination_consumer_offsets"
+
+      @topics.each do |topic, partitions|
+        destination_consumer.subscribe(topic)
+        partitions.each do |partition, info|
+          offset = info[:destination_consumer_offsets]
+          logger.info "Seeking consumer offset for: #{m.topic}/#{m.partition} to #{offset}"
+          destination_consumer.seek(topic, partition, offset)
+        end
+      end
+
+      opts = { automatically_mark_as_processed: false }
+      destination_consumer.each_message(opts) do |m|
+        logger.info "Setting consumer offset for: #{m.topic}/#{m.partition}"
+        break
+      end
+    end
+
+    def sync
+      load_source_consumer_offsets
+      load_destination_producer_offsets
+      load_source_producer_offsets
+
+      calculate_destination_consumer_offsets
+      set_destination_consumer_offsets
+    end
+  end
+end

data/lib/kafka_replicator/railtie.rb

@@ -0,0 +1,8 @@
+module KafkaReplicator
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/kafka_replicator.rake'
+    end
+  end
+end
+

data/lib/kafka_replicator/topics_replicator.rb

@@ -0,0 +1,154 @@
+module KafkaReplicator
+  class TopicsReplicator
+    SKIP_TOPICS = ['__consumer_offse', '__consumer_offsets', '_schemas']
+
+    attr_reader :source_kafka,
+                :destination_kafka,
+                :source_consumer,
+                :destination_producer,
+                :replicated_topics,
+                :skip_topics,
+                :logger,
+                :stopped
+
+    def initialize(source_brokers:, destination_brokers:, skip_topics: [])
+      @source_brokers = source_brokers
+      @destination_brokers = destination_brokers
+      @skip_topics = SKIP_TOPICS | skip_topics
+      @logger = Logger.new(STDOUT)
+    end
+
+    def setup
+      @stopped = false
+      @replicated_topics = Set[]
+      @source_consumer = nil
+      @destination_producer = nil
+    end
+
+    def source_kafka
+      @source_kafka ||= Kafka.new(
+        @source_brokers,
+        client_id: "replicator_source"
+      )
+    end
+
+    def destination_kafka
+      @destination_kafka ||= Kafka.new(
+        @destination_brokers,
+        client_id: "replicator_destination"
+      )
+    end
+
+    def source_consumer
+      @source_consumer ||= source_kafka.consumer(group_id: "replicator")
+    end
+
+    def destination_producer
+      @destination_producer ||= destination_kafka.producer
+    end
+
+    def start
+      loop do
+        break if stopped
+
+        logger.info 'Setting up configuration...'
+        setup
+
+        logger.info 'Adding topics for replication...'
+        subscribe_to_source_topics
+
+        logger.info 'Starting replication...'
+        replicate
+      end
+    end
+
+    def replicate
+      replicate
+    rescue => e
+      logger.error "Exception: #{e}"
+      logger.error "Exception.cause: #{e.cause.inspect}"
+    end
+
+    def stop
+      logger.info 'Stopping replication...'
+      source_consumer.stop
+      @stopped = true
+    end
+
+    private
+
+    def replicate
+      source_consumer.each_batch(automatically_mark_as_processed: false) do |batch|
+        logger.info 'New topics added, restarting...' && break unless unreplicated_topics.empty?
+
+        batch.messages.each_slice(100).each do |messages|
+          messages.each do |message|
+            value = parse_message(message.value)
+
+            # Currently we support only JSON messages so if for some reson there is a message
+            # which is not a json we just skip it in order to continue replication
+            next if value.kind_of?(Exception)
+
+            # skip already replicated messages
+            # prevents loops in two way replication scenario
+            if value.has_key?(:replica)
+              source_consumer.mark_message_as_processed(message)
+              print('-')
+              next
+            end
+
+            # mark message as a replica
+            value[:replica] = true
+
+            destination_producer.produce(
+              MultiJson.dump(value),
+              topic: message.topic,
+              partition: message.partition
+            )
+
+            source_consumer.mark_message_as_processed(message)
+            print '.'
+          end
+
+          destination_producer.deliver_messages
+          source_consumer.commit_offsets
+        end
+      end
+    end
+
+    def parse_message(value)
+      MultiJson.load(value, symbolize_keys: true)
+    rescue MultiJson::ParseError => exception
+      logger.error exception.cause
+
+      exception
+    end
+
+    def source_topics
+      source_kafka.topics.reject { |topic_name| skip_topics.include?(topic_name) }.to_set
+    end
+
+    def unreplicated_topics
+      source_topics - replicated_topics
+    end
+
+    def subscribe_to_source_topics
+      destination_topics = destination_kafka.topics
+
+      unreplicated_topics.each do |topic|
+        source_consumer.subscribe(topic, start_from_beginning: true)
+        replicated_topics << topic
+
+        unless destination_topics.include?(topic)
+          destination_kafka.create_topic(
+            topic,
+            num_partitions: source_kafka.partitions_for(topic),
+            replication_factor: 3 # Need to be specified because otherwise ruby-kafa driver will make it equal to 1
+          )
+        end
+
+        logger.info "Topic added: #{topic}"
+      end
+    end
+  end
+end

data/lib/kafka_replicator/version.rb

@@ -0,0 +1,3 @@
+module KafkaReplicator
+  VERSION = "0.1.0"
+end

data/lib/tasks/kafka_replicator.rake

@@ -0,0 +1,28 @@
+require 'multi_json'
+
+namespace :kafka_replicator do
+  desc 'Start topics replicator'
+  task replicate_topics: :environment do |task, _|
+    source_brokers = ENV['KAFKA_REPLICATOR_SOURCE_BROKERS'] && MultiJson.load(ENV['KAFKA_REPLICATOR_SOURCE_BROKERS'])
+    raise "KAFKA_REPLICATOR_SOURCE_BROKERS environment variable is not set" unless source_brokers
+
+    destination_brokers = ENV['KAFKA_REPLICATOR_DESTINATION_BROKERS'] && MultiJson.load(ENV['KAFKA_REPLICATOR_DESTINATION_BROKERS'])
+    raise "KAFKA_REPLICATOR_DESTINATION_BROKERS environment variable is not set" unless destination_brokers
+
+    skip_topics = (ENV['KAFKA_REPLICATOR_SKIP_TOPICS'] && MultiJson.load(ENV['KAFKA_REPLICATOR_SKIP_TOPICS'])) || []
+
+    puts "Replicating from #{source_brokers} to #{destination_brokers}"
+    puts "Skipping topics: #{(KafkaReplicator::TopicsReplicator::SKIP_TOPICS | skip_topics).sort}"
+
+    replicator = KafkaReplicator::TopicsReplicator.new(
+      source_brokers: source_brokers, 
+      destination_brokers: destination_brokers,
+      skip_topics: skip_topics
+    )
+
+    trap("TERM") { replicator.stop }
+    trap("INT") { replicator.stop }
+    
+    replicator.start
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: kafka_replicator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vachagan Gevorgyan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Simple solution for organizing 2 way syncing between kafka clusters
+email:
+- v.gevorgyan@catawiki.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kafka_replicator.gemspec
+- lib/kafka_replicator.rb
+- lib/kafka_replicator/offsets_sync.rb
+- lib/kafka_replicator/railtie.rb
+- lib/kafka_replicator/topics_replicator.rb
+- lib/kafka_replicator/version.rb
+- lib/tasks/kafka_replicator.rake
+homepage: https://github.com/Vachman/kafka-replicator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Replicate topics from one kafka cluster to another
+test_files: []