fluent-plugin-kafka 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7ea6df9ab262c3d1a76fd1bf8084dcacfed5e13
+  data.tar.gz: a4e75c5d1c30425d35a7cc57a802256dd28901fb
+SHA512:
+  metadata.gz: 12b5a1579ffd62f45279983cbbbc3c13c4659a0c736b29b6f8e40c765b839ed3a0e6424be27e12917b674f6f62bff076c5879de3cfe133dc9b8b269f8aebc489
+  data.tar.gz: 963e4236af8e79c47eecfdfd0b58f73c6a9e68f3161b1c984d48691ae025c64d3d5e57bb18f8a20ce91430d11ad4007ed6893c7e20aa31efded4ad7d9dd24192

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-kafka-poseidon.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 htgc
+
+MIT License
+
+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,60 @@
+# Fluent::Plugin::Kafka
+
+TODO: Write a gem description
+TODO: Also, I need to write tests
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-kafka'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-kafka
+
+## Usage
+
+### Input plugin
+
+    <source>
+      type   kafka
+      host   <broker host>
+      port   <broker port: default=9092>
+      topics <listening topics(separate with comma',')>
+      format <input text type (text|json)>
+      add_prefix <tag prefix (Optional)>
+      add_suffix <tag suffix (Optional)>
+    </source>
+
+### Output plugin (non-buffered)
+
+    <match *.**>
+      type             kafka
+      brokers          <broker1_host>:<broker1_ip>,<broker2_host>:<broker2_ip>,..
+      default_topic    <output topic>
+      output_data_type (json|ltsv|attr:<record name>)
+    </match>
+
+### Buffered output plugin
+
+    <match *.**>
+      type             kafka_buffered
+      brokers          <broker1_host>:<broker1_ip>,<broker2_host>:<broker2_ip>,..
+      default_topic    <output topic>
+      flush_interval   <flush interval (sec) :default => 60>
+      buffer_type      (file|memory)
+      output_data_type (json|ltsv|attr:<record name>)
+    </match>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-kafka.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Hidemasa Togashi"]
+  gem.email         = ["togachiro@gmail.com"]
+  gem.description   = %q{Fluentd plugin for Apache Kafka > 0.8}
+  gem.summary       = %q{Fluentd plugin for Apache Kafka > 0.8}
+  gem.homepage      = "https://github.com/htgc/fluent-plugin-kafka"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "fluent-plugin-kafka"
+  gem.require_paths = ["lib"]
+  gem.version = '0.0.5'
+  gem.add_dependency 'fluentd'
+  gem.add_dependency 'poseidon'
+  gem.add_dependency 'ltsv'
+  gem.add_dependency 'json'
+end

data/lib/fluent/plugin/in_kafka.rb

@@ -0,0 +1,117 @@
+module Fluent
+
+class KafkaInput < Input
+  Plugin.register_input('kafka', self)
+
+  config_param :format, :string, :default => 'json' # (json|text)
+  config_param :host, :string, :default => 'localhost'
+  config_param :port, :integer, :default => 2181
+  config_param :interval, :integer, :default => 1 # seconds
+  config_param :topics, :string
+  config_param :client_id, :string, :default => 'kafka'
+  config_param :partition, :integer, :default => 0
+  config_param :offset, :integer, :default => -1
+  config_param :add_prefix, :string, :default => nil
+  config_param :add_suffix, :string, :default => nil
+
+  def initialize
+    super
+    require 'poseidon'
+  end
+
+  def configure(conf)
+    super
+    @topic_list = @topics.split(',').map {|topic| topic.strip }
+    if @topic_list.empty?
+      raise ConfigError, "kafka: 'topics' is a require parameter"
+    end
+
+    case @format
+    when 'json'
+      require 'json'
+    end
+  end
+
+  def start
+    @loop = Coolio::Loop.new
+    @topic_watchers = @topic_list.map {|topic|
+      TopicWatcher.new(topic, @host, @port, @client_id, @partition, @offset, interval, @format, @add_prefix, @add_suffix)
+    }
+    @topic_watchers.each {|tw|
+      tw.attach(@loop)
+    }
+    @thread = Thread.new(&method(:run))
+  end
+
+  def shutdown
+    @loop.stop
+  end
+
+  def run
+    @loop.run
+  rescue
+    $log.error "unexpected error", :error=>$!.to_s
+    $log.error_backtrace
+  end
+
+  class TopicWatcher < Coolio::TimerWatcher
+    def initialize(topic, host, port, client_id, partition, offset, interval, format, add_prefix, add_suffix)
+      @topic = topic
+      @callback = method(:consume)
+      @format = format
+      @add_prefix = add_prefix
+      @add_suffix = add_suffix
+      @consumer = Poseidon::PartitionConsumer.new(
+        client_id,            # client_id
+        host,                 # host
+        port,                 # port
+        topic,                # topic
+        partition,            # partition
+        offset                # offset
+      )
+        
+      super(interval, true)
+    end
+
+    def on_timer
+      @callback.call
+    rescue
+        # TODO log?
+        $log.error $!.to_s
+        $log.error_backtrace
+    end
+
+    def consume
+      es = MultiEventStream.new
+      tag = @topic
+      tag = @add_prefix + "." + tag if @add_prefix
+      tag = tag + "." + @add_suffix if @add_suffix
+      @consumer.fetch.each { |msg|
+        begin
+          msg_record = parse_line(msg.value)
+          es.add(Time.now.to_i, msg_record)
+        rescue
+          $log.warn msg_record.to_s, :error=>$!.to_s
+          $log.debug_backtrace
+        end
+      }
+
+      unless es.empty?
+        Engine.emit_stream(tag, es)
+      end
+    end
+
+    def parse_line(record)
+      parsed_record = {}
+      case @format
+      when 'json'
+        parsed_record = JSON.parse(record)
+      when 'text'
+        parsed_record = record
+      end
+      parsed_record
+    end
+  end
+end
+
+end

data/lib/fluent/plugin/out_kafka.rb

@@ -0,0 +1,83 @@
+class Fluent::KafkaOutput < Fluent::Output
+  Fluent::Plugin.register_output('kafka', self)
+
+  def initialize
+    super
+    require 'poseidon'
+  end
+
+  config_param :brokers, :string, :default => 'localhost:9092'
+  config_param :default_topic, :string, :default => nil
+  config_param :default_partition, :integer, :default => 0
+  config_param :client_id, :string, :default => 'kafka'
+  config_param :output_data_type, :string, :default => 'json'
+  attr_accessor :output_data_type
+  attr_accessor :field_separator
+
+  def configure(conf)
+    super
+    @seed_brokers = @brokers.match(",").nil? ? [@brokers] : @brokers.split(",")
+    @producers = {} # keyed by topic:partition
+    case @output_data_type
+    when 'json'
+      require 'json'
+    when 'ltsv'
+      require 'ltsv'
+    end
+
+    @f_separator = case @field_separator
+                   when /SPACE/i then ' '
+                   when /COMMA/i then ','
+                   when /SOH/i then "\x01"
+                   else "\t"
+                   end
+
+    @custom_attributes = if @output_data_type == 'json'
+                           nil
+                         elsif @output_data_type == 'ltsv'
+                           nil
+                         elsif @output_data_type =~ /^attr:(.*)$/
+                           $1.split(',').map(&:strip).reject(&:empty?)
+                         else
+                           nil
+                         end
+
+  end
+
+  def start
+    super
+  end
+
+  def shutdown
+    super
+  end
+
+  def parse_record(record)
+    if @custom_attributes.nil?
+      case @output_data_type
+      when 'json'
+        JSON.dump(record)
+      when 'ltsv'
+        LTSV.dump(record)
+      else
+        record.to_s
+      end
+    else
+      @custom_attributes.map { |attr|
+        record[attr].nil? ? '' : record[attr].to_s
+      }.join(@f_separator)
+    end
+  end
+
+  def emit(tag, es, chain)
+    chain.next
+    es.each do |time,record|
+      topic = record['topic'] || self.default_topic || tag
+      partition = record['partition'] || self.default_partition
+      message = Poseidon::MessageToSend.new(topic, parse_record(record))
+      @producers[topic] ||= Poseidon::Producer.new(@seed_brokers, self.client_id)
+      @producers[topic].send_messages([message])
+    end
+  end
+
+end

data/lib/fluent/plugin/out_kafka_buffered.rb

@@ -0,0 +1,97 @@
+class Fluent::KafkaOutputBuffered < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('kafka_buffered', self)
+
+  def initialize
+    super
+    require 'poseidon'
+  end
+
+  config_param :brokers, :string, :default => 'localhost:9092'
+  config_param :default_topic, :string, :default => nil
+  config_param :default_partition, :integer, :default => 0
+  config_param :client_id, :string, :default => 'kafka'
+  config_param :output_data_type, :string, :default => 'json'
+  attr_accessor :output_data_type
+  attr_accessor :field_separator
+
+  def configure(conf)
+    super
+    @seed_brokers = @brokers.match(",").nil? ? [@brokers] : @brokers.split(",")
+    @producers = {} # keyed by topic:partition
+    case @output_data_type
+    when 'json'
+      require 'json'
+    when 'ltsv'
+      require 'ltsv'
+    end
+
+    @f_separator = case @field_separator
+                   when /SPACE/i then ' '
+                   when /COMMA/i then ','
+                   when /SOH/i then "\x01"
+                   else "\t"
+                   end
+
+    @custom_attributes = if @output_data_type == 'json'
+                           nil
+                         elsif @output_data_type == 'ltsv'
+                           nil
+                         elsif @output_data_type =~ /^attr:(.*)$/
+                           $1.split(',').map(&:strip).reject(&:empty?)
+                         else
+                           nil
+                         end
+  end
+
+  def start
+    super
+  end
+
+  def shutdown
+    super
+  end
+
+  def format(tag, time, record)
+    [tag, time, record].to_msgpack
+  end
+
+  def parse_record(record)
+    if @custom_attributes.nil?
+      case @output_data_type
+      when 'json'
+        JSON.dump(record)
+      when 'ltsv'
+        LTSV.dump(record)
+      else
+        record.to_s
+      end
+    else
+      @custom_attributes.map { |attr|
+        record[attr].nil? ? '' : record[attr].to_s
+      }.join(@f_separator)
+    end
+  end
+
+  def write(chunk)
+    records_by_topic = {}
+    chunk.msgpack_each { |tag, time, record|
+      topic = record['topic'] || self.default_topic || tag
+      partition = record['partition'] || self.default_partition
+      message = Poseidon::MessageToSend.new(topic, parse_record(record))
+      records_by_topic[topic] ||= []
+      records_by_topic[topic][partition] ||= []
+      records_by_topic[topic][partition] << message
+    }
+    publish(records_by_topic)
+  end
+
+  def publish(records_by_topic)
+    records_by_topic.each { |topic, partitions|
+      partitions.each_with_index { |messages, partition|
+        next if not messages
+        @producers[topic] ||= Poseidon::Producer.new(@seed_brokers, self.client_id)
+        @producers[topic].send_messages(messages)
+      }
+    }
+  end
+end

data/test/helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_kafka'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_kafka.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class KafkaOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    default_topic kitagawakeiko
+    brokers localhost:9092
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::KafkaOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal 'kitagawakeiko', d.instance.default_topic
+    assert_equal 'localhost:9092', d.instance.brokers
+  end
+
+  def test_format
+    d = create_driver
+  end
+
+  def test_write
+    d = create_driver
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    d.emit({"a"=>1}, time)
+    d.emit({"a"=>2}, time)
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kafka
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Hidemasa Togashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: poseidon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ltsv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd plugin for Apache Kafka > 0.8
+email:
+- togachiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-kafka.gemspec
+- lib/fluent/plugin/in_kafka.rb
+- lib/fluent/plugin/out_kafka.rb
+- lib/fluent/plugin/out_kafka_buffered.rb
+- test/helper.rb
+- test/plugin/test_out_kafka.rb
+homepage: https://github.com/htgc/fluent-plugin-kafka
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin for Apache Kafka > 0.8
+test_files:
+- test/helper.rb
+- test/plugin/test_out_kafka.rb