logstash-output-kafka 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57ebec7023e23af3c9b3ce4f206548cf103ef678
-  data.tar.gz: b0dfbaec82a03889eca7340a56b9663fa27596c9
+  metadata.gz: f0219f2b0524405c4045d48117b5e583c5b9ca04
+  data.tar.gz: bda2fcf985eb617376f7189f2df22341681b3eef
 SHA512:
-  metadata.gz: b4bdfc05c7f2033b992eddf09d27b1440f4bd4ff0ac6a44f1146885fa442a39327ef46fd7b4db95625c30e04f27c5547781893fccc3fcabee37ee54cab001f42
-  data.tar.gz: 374c0a5f8e8ea8020bea284cbe0b85341d6c1a84e2854de50001e34bd7242bb6441bd3ba21b3eaca83a4f647e24ccaff8ac81ca220ae8ea6e40958e20600d8ce
+  metadata.gz: a94e343d2bf56452fb781b549481e8219a13cc12e3c08af0c41aa2bca3179023c65303e84fb7ed2528e4599b5f55434f4aa183e4adef2a8cb2a645567cb66739
+  data.tar.gz: 13afb751837c1cedafb92132de1374c0a8bcfbebbc0cffb34e35dcd831cdd5d0ccf6e181429ffd7959ec339dabae38e901a463a07df789e4b4c65b44ce6070d4

data/CONTRIBUTORS

@@ -0,0 +1,16 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Joseph Lawson (joekiller)
+* João Duarte (jsvd)
+* Kurt Hurtado (kurtado)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Suyog Rao (suyograo)
+* Tal Levy (talevy)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,56 @@
+logstash-output-kafka
+====================
+
+Apache Kafka output for Logstash. This output will produce messages to a Kafka topic using the producer API exposed by Kafka. 
+
+For more information about Kafka, refer to this [documentation](http://kafka.apache.org/documentation.html) 
+
+Information about producer API can be found [here](http://kafka.apache.org/documentation.html#apidesign)
+
+Logstash Configuration
+====================
+
+See http://kafka.apache.org/documentation.html#producerconfigs for details about the Kafka producer options.
+
+    output {
+        kafka {
+            topic_id => ... # string (required), The topic to produce the messages to
+            broker_list => ... # string (optional), default: "localhost:9092", This is for bootstrapping and the producer will only use it for getting metadata
+            compression_codec => ... # string (optional), one of ["none", "gzip", "snappy"], default: "none"
+            compressed_topics => ... # string (optional), default: "", This parameter allows you to set whether compression should be turned on for particular
+            request_required_acks => ... # number (optional), one of [-1, 0, 1], default: 0, This value controls when a produce request is considered completed
+            serializer_class => ... # string, (optional) default: "kafka.serializer.StringEncoder", The serializer class for messages. The default encoder takes a byte[] and returns the same byte[]
+            partitioner_class => ... # string (optional) default: "kafka.producer.DefaultPartitioner"
+            request_timeout_ms => ... # number (optional) default: 10000
+            producer_type => ... # string (optional), one of ["sync", "async"] default => 'sync'
+            key_serializer_class => ... # string (optional) default: nil
+            message_send_max_retries => ... # number (optional) default: 3
+            retry_backoff_ms => ... # number (optional) default: 100
+            topic_metadata_refresh_interval_ms => ... # number (optional) default: 600 * 1000
+            queue_buffering_max_ms => ... # number (optional) default: 5000
+            queue_buffering_max_messages => ... # number (optional) default: 10000
+            queue_enqueue_timeout_ms => ... # number (optional) default: -1
+            batch_num_messages => ... # number (optional) default: 200
+            send_buffer_bytes => ... # number (optional) default: 100 * 1024
+            client_id => ... # string (optional) default: ""
+        }
+    }
+
+The default codec is json for outputs.  If you select a codec of plain, logstash will encode your messages with not only the message
+but also with a timestamp and hostname.  If you do not want anything but your message passing through, you should make
+the output configuration something like:
+
+    output {
+        kafka {
+            codec => plain {
+                format => "%{message}"
+            }
+        }
+    }
+    
+
+Dependencies
+====================
+
+* Apache Kafka version 0.8.1.1
+* jruby-kafka library

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,56 +1,95 @@
-logstash-output-kafka
-====================
-
-Apache Kafka output for Logstash. This output will produce messages to a Kafka topic using the producer API exposed by Kafka. 
-
-For more information about Kafka, refer to this [documentation](http://kafka.apache.org/documentation.html) 
-
-Information about producer API can be found [here](http://kafka.apache.org/documentation.html#apidesign)
-
-Logstash Configuration
-====================
-
-See http://kafka.apache.org/documentation.html#producerconfigs for details about the Kafka producer options.
-
-    output {
-        kafka {
-            topic_id => ... # string (required), The topic to produce the messages to
-            broker_list => ... # string (optional), default: "localhost:9092", This is for bootstrapping and the producer will only use it for getting metadata
-            compression_codec => ... # string (optional), one of ["none", "gzip", "snappy"], default: "none"
-            compressed_topics => ... # string (optional), default: "", This parameter allows you to set whether compression should be turned on for particular
-            request_required_acks => ... # number (optional), one of [-1, 0, 1], default: 0, This value controls when a produce request is considered completed
-            serializer_class => ... # string, (optional) default: "kafka.serializer.StringEncoder", The serializer class for messages. The default encoder takes a byte[] and returns the same byte[]
-            partitioner_class => ... # string (optional) default: "kafka.producer.DefaultPartitioner"
-            request_timeout_ms => ... # number (optional) default: 10000
-            producer_type => ... # string (optional), one of ["sync", "async"] default => 'sync'
-            key_serializer_class => ... # string (optional) default: nil
-            message_send_max_retries => ... # number (optional) default: 3
-            retry_backoff_ms => ... # number (optional) default: 100
-            topic_metadata_refresh_interval_ms => ... # number (optional) default: 600 * 1000
-            queue_buffering_max_ms => ... # number (optional) default: 5000
-            queue_buffering_max_messages => ... # number (optional) default: 10000
-            queue_enqueue_timeout_ms => ... # number (optional) default: -1
-            batch_num_messages => ... # number (optional) default: 200
-            send_buffer_bytes => ... # number (optional) default: 100 * 1024
-            client_id => ... # string (optional) default: ""
-        }
-    }
-
-The default codec is json for outputs.  If you select a codec of plain, logstash will encode your messages with not only the message
-but also with a timestamp and hostname.  If you do not want anything but your message passing through, you should make
-the output configuration something like:
-
-    output {
-        kafka {
-            codec => plain {
-                format => "%{message}"
-            }
-        }
-    }
-    
-
-Dependencies
-====================
-
-* Apache Kafka version 0.8.1.1
-* jruby-kafka library
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/kafka.rb

@@ -23,7 +23,6 @@ require 'logstash-output-kafka_jars'
 # Kafka producer configuration: http://kafka.apache.org/documentation.html#producerconfigs
 class LogStash::Outputs::Kafka < LogStash::Outputs::Base
   config_name 'kafka'
-  milestone 1
 
   default :codec, 'json'
   # This is for bootstrapping and the producer will only use it for getting metadata (topics,
@@ -106,7 +105,9 @@ class LogStash::Outputs::Kafka < LogStash::Outputs::Base
 
   public
   def register
+    LogStash::Logger.setup_log4j(@logger)
     require 'jruby-kafka'
+
     options = {
         :broker_list => @broker_list,
         :compression_codec => @compression_codec,
@@ -134,7 +135,7 @@ class LogStash::Outputs::Kafka < LogStash::Outputs::Base
 
     @codec.on_event do |event, data|
       begin
-        @producer.send_msg(@topic_id,nil,data)
+        @producer.send_msg(event.sprintf(@topic_id),nil,data)
       rescue LogStash::ShutdownSignal
         @logger.info('Kafka producer got shutdown signal')
       rescue => e

data/logstash-output-kafka.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-kafka'
-  s.version         = '0.1.3'
+  s.version         = '0.1.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = 'Output events to a Kafka topic. This uses the Kafka Producer API to write messages to a topic on the broker'
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   # Jar dependencies
   s.requirements << "jar 'org.apache.kafka:kafka_2.9.2', '0.8.1.1'"
-  s.requirements << "jar 'log4j:log4j', '1.2.14'"
+  s.requirements << "jar 'org.slf4j:slf4j-log4j12', '1.7.10'"
 
   # Gem dependencies
   s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'

data/spec/outputs/kafka_spec.rb

@@ -3,34 +3,46 @@ require "logstash/devutils/rspec/spec_helper"
 require 'logstash/outputs/kafka'
 require 'logstash-output-kafka_jars'
 require 'jruby-kafka'
+require 'json'
 
 describe "outputs/kafka" do
-  let (:kafka_config) {{'topic_id' => 'test'}}
+  let (:simple_kafka_config) {{'topic_id' => 'test'}}
+  let (:event) { LogStash::Event.new({'message' => 'hello', 'topic_name' => 'my_topic',
+                                      '@timestamp' => LogStash::Timestamp.now}) }
 
-  it "should register" do
-    output = LogStash::Plugin.lookup("output", "kafka").new(kafka_config)
-    expect {output.register}.to_not raise_error
-  end
+  context 'when initializing' do
+    it "should register" do
+      output = LogStash::Plugin.lookup("output", "kafka").new(simple_kafka_config)
+      expect {output.register}.to_not raise_error
+    end
 
-  it 'should populate kafka config with default values' do
-    kafka = LogStash::Outputs::Kafka.new(kafka_config)
-    insist {kafka.broker_list} == 'localhost:9092'
-    insist {kafka.topic_id} == 'test'
-    insist {kafka.compression_codec} == 'none'
-    insist {kafka.serializer_class} == 'kafka.serializer.StringEncoder'
-    insist {kafka.partitioner_class} == 'kafka.producer.DefaultPartitioner'
-    insist {kafka.producer_type} == 'sync'
+    it 'should populate kafka config with default values' do
+      kafka = LogStash::Outputs::Kafka.new(simple_kafka_config)
+      insist {kafka.broker_list} == 'localhost:9092'
+      insist {kafka.topic_id} == 'test'
+      insist {kafka.compression_codec} == 'none'
+      insist {kafka.serializer_class} == 'kafka.serializer.StringEncoder'
+      insist {kafka.partitioner_class} == 'kafka.producer.DefaultPartitioner'
+      insist {kafka.producer_type} == 'sync'
+    end
   end
 
-  it 'should send logstash event to kafka broker' do
-    timestamp = LogStash::Timestamp.now
-    expect_any_instance_of(Kafka::Producer)
-    .to receive(:send_msg)
-        .with('test', nil, "{\"message\":\"hello world\",\"host\":\"test\",\"@timestamp\":\"#{timestamp}\",\"@version\":\"1\"}")
-    e = LogStash::Event.new({:message => 'hello world', :host => 'test', '@timestamp' => timestamp})
-    kafka = LogStash::Outputs::Kafka.new(kafka_config)
-    kafka.register
-    kafka.receive(e)
-  end
+  context 'when outputting messages' do
+    it 'should send logstash event to kafka broker' do
+      expect_any_instance_of(Kafka::Producer).to receive(:send_msg)
+        .with(simple_kafka_config['topic_id'], nil, event.to_hash.to_json)
+      kafka = LogStash::Outputs::Kafka.new(simple_kafka_config)
+      kafka.register
+      kafka.receive(event)
+    end
 
+    it 'should support Event#sprintf placeholders in topic_id' do
+      topic_field = 'topic_name'
+      expect_any_instance_of(Kafka::Producer).to receive(:send_msg)
+        .with(event[topic_field], nil, event.to_hash.to_json)
+      kafka = LogStash::Outputs::Kafka.new({'topic_id' => "%{#{topic_field}}"})
+      kafka.register
+      kafka.receive(event)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-kafka
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTORS
+- DEVELOPER.md
 - Gemfile
 - LICENSE
 - README.md
@@ -136,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - jar 'org.apache.kafka:kafka_2.9.2', '0.8.1.1'
-- jar 'log4j:log4j', '1.2.14'
+- jar 'org.slf4j:slf4j-log4j12', '1.7.10'
 rubyforge_project:
 rubygems_version: 2.1.9
 signing_key: