logstash-codec-avro 3.0.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82c13044b81979f3dcc59afc6e0b12c84bc399a8
+  data.tar.gz: a63d24090bac54031cd9b4190ffb6eae7c3d951d
+SHA512:
+  metadata.gz: 6f48ad5d631470cad389df4f431c841ba6ddf7f54692b19db13257ee2fe76d6e903875f31dc6d11b127b1571f06d2f2a14011396d9245b10c3b17f8820886851
+  data.tar.gz: fb08fb0bd4c7996840871e4d9b4592d7dc42e2fb65c229a768b67fe87a99e3ac39c041f58bcecc0fb682c8e72161421cf24725fda99e3492bd619c4f995128eb

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 3.0.0
+ - breaking: Update to new Event API
+
+## 2.0.4
+ - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+
+## 2.0.3
+ - New dependency requirements for logstash-core for the 5.0 release
+
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Pier-Hugues Pellerin (ph)
+* 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,66 @@
+Logstash Avro Codec
+===================
+
+How to Install
+--------------
+
+```
+bin/plugin install logstash-avro-codec
+```
+
+How to Use
+----------
+You can use this codec to decode avro messages
+in a Kafka topic input.
+
+Here is an example schema for tweets.
+
+### tweet.avsc
+```
+{
+  "type" : "record",
+  "name" : "twitter_schema",
+  "namespace" : "com.miguno.avro",
+  "fields" : [ {
+    "name" : "username",
+    "type" : "string",
+    "doc" : "Name of the user account on Twitter.com"
+  }, {
+    "name" : "tweet",
+    "type" : "string",
+    "doc" : "The content of the user's Twitter message"
+  }, {
+    "name" : "timestamp",
+    "type" : "long",
+    "doc" : "Unix epoch time in seconds"
+  } ],
+  "doc:" : "A basic schema for storing Twitter messages"
+}
+```
+
+Along with the logstash config for reading in messages of this 
+type using the avro codec with the logstash-input-kafka plugin.
+
+### logstash.conf
+
+```
+input {
+  kafka {
+    topic_id => 'test_topic'
+      codec => avro {
+        schema_uri => 'tweet.avsc'
+      }
+  }
+}
+
+output {
+  stdout {
+    codec => rubydebug
+  }
+}
+```
+
+### Running the setup
+```
+bin/logstash -f logstash.conf
+```

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
+
+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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,98 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-codec-avro.svg)](https://travis-ci.org/logstash-plugins/logstash-codec-avro)
+
+This is a plugin for [Logstash](https://github.com/elastic/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.elastic.co/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/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## 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. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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 the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/codecs/avro.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require "open-uri"
+require "avro"
+require "logstash/codecs/base"
+require "logstash/event"
+require "logstash/timestamp"
+require "logstash/util"
+
+# Read serialized Avro records as Logstash events
+#
+# This plugin is used to serialize Logstash events as 
+# Avro datums, as well as deserializing Avro datums into 
+# Logstash events.
+#
+# ==== Encoding
+# 
+# This codec is for serializing individual Logstash events 
+# as Avro datums that are Avro binary blobs. It does not encode 
+# Logstash events into an Avro file.
+#
+#
+# ==== Decoding
+#
+# This codec is for deserializing individual Avro records. It is not for reading
+# Avro files. Avro files have a unique format that must be handled upon input.
+#
+#
+# ==== Usage
+# Example usage with Kafka input.
+#
+# [source,ruby]
+# ----------------------------------
+# input {
+#   kafka {
+#     codec => avro {
+#         schema_uri => "/tmp/schema.avsc"
+#     }
+#   }
+# }
+# filter {
+#   ...
+# }
+# output {
+#   ...
+# }
+# ----------------------------------
+class LogStash::Codecs::Avro < LogStash::Codecs::Base
+  config_name "avro"
+
+
+  # schema path to fetch the schema from.
+  # This can be a 'http' or 'file' scheme URI
+  # example:
+  #
+  # * http - `http://example.com/schema.avsc`
+  # * file - `/path/to/schema.avsc`
+  config :schema_uri, :validate => :string, :required => true
+
+  def open_and_read(uri_string)
+    open(uri_string).read
+  end
+
+  public
+  def register
+    @schema = Avro::Schema.parse(open_and_read(schema_uri))
+  end
+
+  public
+  def decode(data)
+    datum = StringIO.new(data)
+    decoder = Avro::IO::BinaryDecoder.new(datum)
+    datum_reader = Avro::IO::DatumReader.new(@schema)
+    yield LogStash::Event.new(datum_reader.read(decoder))
+  end
+
+  public
+  def encode(event)
+    dw = Avro::IO::DatumWriter.new(@schema)
+    buffer = StringIO.new
+    encoder = Avro::IO::BinaryEncoder.new(buffer)
+    dw.write(event.to_hash, encoder)
+    @on_event.call(event, buffer.string)
+  end
+end

data/logstash-codec-avro.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-codec-avro'
+  s.version         = '3.0.0'
+  s.platform        = 'java'
+  s.licenses        = ['Apache-2.0']
+  s.summary         = "Encode and decode avro formatted data"
+  s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
+  s.authors         = ["Elastic"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths   = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "codec" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+
+  s.add_runtime_dependency "avro"  #(Apache 2.0 license)
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/codecs/avro_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require 'avro'
+require 'logstash/codecs/avro'
+require 'logstash/event'
+
+describe LogStash::Codecs::Avro do
+  let (:avro_config) {{'schema_uri' => '
+                        {"type": "record", "name": "Test",
+                        "fields": [{"name": "foo", "type": ["null", "string"]},
+                                   {"name": "bar", "type": "int"}]}'}}
+  let (:test_event) { LogStash::Event.new({"foo" => "hello", "bar" => 10}) }
+
+  subject do
+    allow_any_instance_of(LogStash::Codecs::Avro).to \
+      receive(:open_and_read).and_return(avro_config['schema_uri'])
+    next LogStash::Codecs::Avro.new(avro_config)
+  end
+
+  context "#decode" do
+    it "should return an LogStash::Event from avro data" do
+      schema = Avro::Schema.parse(avro_config['schema_uri'])
+      dw = Avro::IO::DatumWriter.new(schema)
+      buffer = StringIO.new
+      encoder = Avro::IO::BinaryEncoder.new(buffer)
+      dw.write(test_event.to_hash, encoder)
+
+      subject.decode(buffer.string) do |event|
+        insist { event.is_a? LogStash::Event }
+        insist { event.get("foo") } == test_event.get("foo")
+        insist { event.get("bar") } == test_event.get("bar")
+      end
+    end
+  end
+
+  context "#encode" do
+    it "should return avro data from a LogStash::Event" do
+      got_event = false
+      subject.on_event do |event, data|
+        schema = Avro::Schema.parse(avro_config['schema_uri'])
+        datum = StringIO.new(data)
+        decoder = Avro::IO::BinaryDecoder.new(datum)
+        datum_reader = Avro::IO::DatumReader.new(schema)
+        record = datum_reader.read(decoder)
+
+        insist { record["foo"] } == test_event.get("foo")
+        insist { record["bar"] } == test_event.get("bar")
+        insist { event.is_a? LogStash::Event }
+        got_event = true
+      end
+      subject.encode(test_event)
+      insist { got_event }
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-avro
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: java
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: avro
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/codecs/avro.rb
+- logstash-codec-avro.gemspec
+- spec/codecs/avro_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: codec
+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.4.8
+signing_key:
+specification_version: 4
+summary: Encode and decode avro formatted data
+test_files:
+- spec/codecs/avro_spec.rb