logstash-filter-list2fields 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9832818142f818906d8759e43dbc910d12f5e37f
+  data.tar.gz: 63aa2f896df825be60ffe05a4e2a6ed04c95c66d
+SHA512:
+  metadata.gz: 7d4417e96eec33160430d59e4eb4b54dc7b9aaa3cef9ef6aa59983410538ba59814ca54760c9a26d144898753fc1ceb7b9f29c4d61c34519fe408a4b66eee4ce
+  data.tar.gz: 17171e3a3477456cde677cc483979983b074ebfd8bdeab622d7889f310b0b7e175a8c131e9f0f34842dc521e59265054a78b45b3caed0ef2740ed8c85d863442

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Inga Feick (ingafeick)
+
+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/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 trivago <http://www.trivago.com>
+
+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 @@
+trivago GmbH
+Copyright 2012-2015 trivago 
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,37 @@
+# Logstash Plugin
+
+
+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
+
+This filter rearranges key-value-pairs from the following structure
+  
+	"awesome_list" => [ { "key" => "animal", "value" => "horse"} , {"key" => "food", "value" => "bacon"} ]
+
+into separate logstash event fields:
+
+	"animal" => "horse"
+	"food" => "bacon"
+
+## Configuration
+
+* source 	: name of the field which contains the list of key value pairs (required). In the example above, this would be "awesome_list".
+* key 		: name of the key for the key field in the list of key value pairs. Headache? Example: If this is your incoming data:
+	"awesome_list" => [ { "name" => "animal", "content" => "horse"} , {"name" => "food", "content" => "bacon"} ]
+then the key would be "name". Optional, defaults to "key".
+* value 	: name of the key for the value field in the list of key value pairs. In the above example, this would be "content". Optional, defaults to "value".
+* prefix	: string to prepend to the new fields that will be added to the logstash event. Optional, defaults to empty.
+
+
+## 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/filters/list2fields.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# TODO docu
+class LogStash::Filters::List2fields < LogStash::Filters::Base
+  
+  config_name "list2fields"
+
+  # The name of the field which contains the list of key value pairs
+  config :source, :validate => :string
+
+  # The name of the field which contains the key inside a list element
+  config :key, :validate => :string, :default => "key"
+
+  # The name of the field which contains the value inside a list element
+  config :value, :validate => :string, :default => "value"
+ 
+  # Prefix for the elements that will be added.
+  config :prefix, :validate => :string, :default => ""
+
+  public
+  def register
+    
+  end # def register
+
+  public
+  def filter(event)
+    input = event[@source]
+    if !input.nil?  && (input.is_a? Enumerable)
+      input.each do |entry|
+        begin
+          if entry.is_a?(::Hash)
+            new_key = @prefix.to_s + entry[@key].to_s
+            event[new_key] = entry[@value]
+          else
+            new_key = @prefix.to_s + entry.instance_variable_get("@" + @key)
+            event[new_key] = entry.instance_variable_get("@" + @value)
+          end # if is hash
+        rescue 
+          @logger.debug("Could not find key " + @key + " in incoming data, please check your config. ")
+        end
+      end # do     
+    end # if input.nil? 
+  end # def filter  
+end # class LogStash::Filters::List2fields
+
+

data/logstash-filter-list2fields.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-list2fields'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "$summary"
+  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         = ["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" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0.beta2", "< 3.0.0"
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/filters/list2filters_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/list2fields"
+
+describe LogStash::Filters::List2fields do
+
+  let(:plugin) { LogStash::Filters::List2fields.new("source" => "message") }
+  
+  before do
+    plugin.register
+  end
+  
+  context "when a prefix is set" do
+
+    let(:plugin_prefix) { LogStash::Filters::List2fields.new("source" => "message", "prefix" => "l2f_") } # TODO there's got to be a more beautiful way to do this 
+    let(:event) { LogStash::Event.new("cheese" => "chili", "message" => [{"key"=>"foo","value"=>"bar"},{"key"=>"cheese","value"=>"bacon"}]) } 
+    before do
+      plugin_prefix.filter(event)
+    end
+
+    it "should have new fields with the prefix in the key" do
+      expect(event["l2f_foo"]).to eq("bar")
+      expect(event["l2f_cheese"]).to eq("bacon")
+    end # it
+
+    it "should not overwrite existing fields" do
+      expect(event["cheese"]).to eq("chili")
+    end # it
+  end # context
+
+
+  context "when the source field is empty" do
+
+    let(:event) { LogStash::Event.new() }
+    it "should not throw an exception" do
+      expect {
+        plugin.filter(event)
+      }.not_to raise_error
+    end # it
+  end # context
+
+  context "when the source field is not iterable" do
+
+    let(:event) { LogStash::Event.new("message" => "i_am_not_iterable" ) }
+    it "should not throw an exception" do
+      expect {
+        plugin.filter(event)
+      }.not_to raise_error
+    end # it
+  end # context
+
+
+  context "when there is a nested list" do
+
+    let(:event) { LogStash::Event.new("message" => [{"key"=>"foo","value"=>"bar"},{"key"=>"cheese","value"=>"bacon"}]) } 
+    before do
+      plugin.filter(event)
+    end
+
+    it "should have new fields" do       
+      expect(event["foo"]).to eq("bar")
+      expect(event["cheese"]).to eq("bacon")
+    end # it
+
+  end # context  
+end # describe
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-list2fields
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-01-25 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: 2.0.0.beta2
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.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: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/list2fields.rb
+- logstash-filter-list2fields.gemspec
+- spec/filters/list2filters_spec.rb
+- vendor/GeoIPASNum-2014-02-12.dat
+- vendor/GeoLiteCity-2013-01-18.dat
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+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: $summary
+test_files:
+- spec/filters/list2filters_spec.rb