logstash-codec-protobuf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae5fff64bbdc72cfc6f1dbbeecd0857481bd1a93
+  data.tar.gz: 5ff0987575c066dd83443a3a4fe1eefc9149f9ea
+SHA512:
+  metadata.gz: 8875e1c022bc8a7155469838c312a0076a296c99d506bb37f18cbe4ea77b080e034b46a76ec6e0084f07f60e5aad88feafe3157b72408c3213746d1a39dac79c
+  data.tar.gz: e3eb525c75ed899a003767855ed03201dcab2338f1fd33d8a6328045be4b8dad776acd422375155ddc7455ef6a3ab8cb710bc3211b1c483def8126bb25545040

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+* 1.1.0
+  - Handle scalar types (string/number) and be more defensive about crashable errors
+* 1.0.1
+  - Handle JSON arrays at source root by emitting multiple events

data/CONTRIBUTORS

@@ -0,0 +1,17 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Colin Surprenant (colinsurprenant)
+* Jordan Sissel (jordansissel)
+* João Duarte (jsvd)
+* Kurt Hurtado (kurtado)
+* Nick Ethier (nickethier)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* 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,2 @@
+# logstash-codec-example
+Example codec plugin. This should help bootstrap your effort to write your own codec plugin!

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 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,65 @@
+# Logstash protobuf codec
+
+This is a codec plugin for [Logstash](https://github.com/elastic/logstash) to parse protobuf messages.
+
+# Prerequisites
+ 
+* prepare your ruby versions of the protobuf definitions, for example using the ruby-protoc compiler from https://github.com/codekitchen/ruby-protocol-buffers
+* download the logstash-codec-protobuf-$VERSION.gem to your computer.
+* Install the plugin. From within your logstash directory, do
+	bin/plugin install /path/to/logstash-codec-protobuf-$VERSION.gem
+* use the codec in your logstash config file. See details below.
+
+# Usage
+
+Use this as a codec in any logstash input. Just provide the name of the class that your incoming objects will be encoded in, and specify the path to the compiled definition.
+Here's an example for a kafka input:
+
+	kafka 
+  	{
+      zk_connect => "127.0.0.1"
+      topic_id => "unicorns_protobuffed"
+      codec => protobuf 
+      {
+        class_name => "Unicorn"
+        include_path => ['/my/path/to/compiled/protobuf/definitions/UnicornProtobuf.pb.rb']
+      }
+  	}   
+
+### Example with referenced definitions
+
+Imagine you have the following protobuf relationship: class Cheese lives in namespace Foods::Dairy and uses another class Milk. 
+
+	module Foods
+  		module Dairy
+    		class Cheese
+    			set_fully_qualified_name "Foods.Dairy.Cheese"
+			    optional ::Foods::Cheese::Milk, :milk, 1
+			    optional :int64, :unique_id, 2
+			    # here be more field definitions
+
+Make sure to put the referenced Milk class first in the include_path:
+
+	include_path => ['/path/to/protobuf/definitions/Milk.pb.rb','/path/to/protobuf/definitions/Cheese.pb.rb']
+
+Set the class name to the parent class:
+	
+	class_name => "Foods::Dairy::Cheese"
+
+# Configuration
+
+include_path	(required): an array of strings with filenames or directory names where logstash can find your protobuf definitions. Please provide absolute paths. For directories it will only try to import files ending on .rb
+
+class_name		(required): the name of the protobuf class that is to be decoded.
+
+
+# Troubleshooting
+
+## "uninitialized constant SOME_CLASS_NAME"
+
+If you include more than one definition class, consider the order of inclusion. This is especially relevant if you include whole directories. A definition might refer to another definition that is not loaded yet. In this case, please specify the files in the include_path variable in reverse order of reference. See 'Example with referenced definitions' above.
+
+
+# Roapmap
+
+Currently the plugin supports the decode functionality only. Maybe we'll add the encoding part also.

data/lib/logstash/codecs/protobuf.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+require "logstash/codecs/base"
+require "logstash/util/charset"
+require 'protocol_buffers' # https://github.com/codekitchen/ruby-protocol-buffers
+
+class LogStash::Codecs::Protobuf < LogStash::Codecs::Base
+  config_name "protobuf"
+
+  # Required: list of strings containing directories or files with protobuf definitions
+  config :include_path, :validate => :array, :required => true
+
+  # Name of the class to decode
+  config :class_name, :validate => :string, :required => true
+
+  # remove 'set_fields' field
+  config :remove_set_fields, :validate => :boolean, :default => true # TODO add documentation
+
+  
+  public
+  def register
+    @include_path.each{|path| require_pb_path(path) }
+    @obj = create_object_from_name(@class_name)
+    
+  end
+
+
+  private
+  def create_object_from_name(name)
+    begin
+      c = name.split("::").inject(Object) { |n,c| n.const_get c }
+      return c
+    end
+  end
+
+  private 
+  def debug(message)
+    begin
+      if @debug 
+        @logger.debug(message)
+      end
+    end
+  end
+
+  private 
+  def require_pb_path(dir_or_file)
+    f = dir_or_file.end_with? (".rb")
+    begin
+      if f
+        require dir_or_file
+      else 
+        Dir[ dir_or_file + "/*.rb"].each { |file| 
+          require file 
+        }
+      end
+    end
+  end
+
+  private
+  def extract_variables(decoded_object)
+    begin
+      result_hash = {}
+      if decoded_object.nil?
+        return result_hash
+      end
+      decoded_object.instance_variables.map do |ivar|
+        varname = ivar.to_s
+        key = varname.gsub("@","")
+        value = decoded_object.instance_variable_get("#{ivar}")
+        recurse = value.is_a? (::ProtocolBuffers::Message)  # object is not a primitive scalar
+        is_iterable |= value.is_a? Enumerable # value.respond_to? :each # object is an array
+        if recurse
+          result_hash[key] = extract_variables(value)
+        elsif is_iterable
+          tmp = []
+          value.each do | nested |
+            tmp.push(nested)
+          end
+          result_hash[key] = tmp
+        else
+          result_hash[key] = value
+        end
+      end
+      if remove_set_fields
+        return result_hash.except("set_fields") # todo try to do this before the object is handed to this method
+      else
+        return result_hash
+      end      
+    end
+  end
+
+
+
+
+
+  public
+  def decode(data)
+    decoded = @obj.parse(data.to_s)
+    results = extract_variables(decoded)
+    event = LogStash::Event.new(results)  
+    yield event
+    
+  end # def decode
+
+  public
+  def encode(event)
+    raise "Encoder function not implemented yet for protobuf codec. Sorry!"
+    # @on_event.call(event, event.to_s)
+    # TODO integrate
+  end # def encode
+
+end # class LogStash::Codecs::Protobuf

data/logstash-codec-protobuf.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-codec-protobuf'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This codec may be used to decode (via inputs) and encode (via outputs) protobuf messages"
+  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"
+  s.authors         = ["trivago"]
+  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', '>= 1.4.0', '< 3.0.0'
+  s.add_runtime_dependency 'ruby-protocol-buffers' # used by the compiled version of our protobuf definition. 
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/codecs/protobuf_spec.rb

@@ -0,0 +1,30 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/protobuf"
+require "logstash/event"
+require 'protocol_buffers' # https://github.com/codekitchen/ruby-protocol-buffers
+require "insist"
+
+describe LogStash::Codecs::Protobuf do
+
+  context "#decode" do
+
+    let(:plugin) { LogStash::Codecs::Protobuf.new("class_name" => "Animal::Unicorn", "include_path" => ['spec/helpers/unicorn.pb.rb'])  }
+    before do
+        plugin.register
+    end
+
+    it "should return an event from protobuf encoded data" do
+    
+      data = {:colour => 'rainbow', :horn_length => 18, :last_seen => 1420081471}
+      unicorn = Animal::Unicorn.new(data)
+          
+      plugin.decode(unicorn.serialize_to_string) do |event|
+        insist { event.is_a? LogStash::Event }
+        insist { event["colour"] } == data[:colour]
+        insist { event["horn_length"] } == data[:horn_length]
+        insist { event["last_seen"] } == data[:last_seen]
+      end
+    end
+  end
+
+end

data/spec/helpers/unicorn.pb.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# Generated by the protocol buffer compiler. DO NOT EDIT!
+
+require 'protocol_buffers'
+
+module Animal
+  # forward declarations
+  class Unicorn < ::ProtocolBuffers::Message; end
+
+  class Unicorn < ::ProtocolBuffers::Message
+    set_fully_qualified_name "animal.Unicorn"
+
+    optional :string, :colour, 1
+    optional :int32, :horn_length, 2
+    optional :int32, :last_seen, 3
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-protobuf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- trivago
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: ruby-protocol-buffers
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+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
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/codecs/protobuf.rb
+- logstash-codec-protobuf.gemspec
+- spec/codecs/protobuf_spec.rb
+- spec/helpers/unicorn.pb.rb
+homepage:
+licenses:
+- Apache License (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.5
+signing_key:
+specification_version: 4
+summary: This codec may be used to decode (via inputs) and encode (via outputs) protobuf messages
+test_files:
+- spec/codecs/protobuf_spec.rb
+- spec/helpers/unicorn.pb.rb