logstash-filter-merge 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ac277dd1fae14429ee2078017721842640e059e
+  data.tar.gz: a2f5515f7e6110b8136a12a4b7a7838c2656296c
+SHA512:
+  metadata.gz: 49a58e441548318e47b60a836bdcdb421b68d12ffdbe202d8db7b047d46dbe7e36cd27e9bc4b8a01094f2745fb69ba4a1ff7bb96ce2014d85fb3e4eab4ec9f29
+  data.tar.gz: 6c24a8cfc3b373491a13c0f7776eb35f664ccd72511dc930b19d304a53404eeeeb76c44180194ab378b15e118e81f4304d1ac41217060a7f74adf8d046ab9726

data/BUILD.md

@@ -0,0 +1,96 @@
+# 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
+
+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/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+ - First release
+

data/CONTRIBUTORS

@@ -0,0 +1,12 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+* William Tisäter (tiwilliam)
+
+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–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,71 @@
+# Logstash Merge Filter Documentation
+
+[![Travis Build Status](https://travis-ci.org/tiwilliam/logstash-filter-merge.svg)](https://travis-ci.org/tiwilliam/logstash-filter-merge)
+[![Gem Version](https://badge.fury.io/rb/logstash-filter-merge.svg)](https://badge.fury.io/rb/logstash-filter-merge)
+
+This filter helps you to merge your fields.
+
+## Merge with root
+
+```
+merge {
+    field => "something"
+}
+```
+
+## Only merge new fields to root
+
+```
+merge {
+    field => "something"
+    overwrite => false
+}
+```
+
+## Merge with custom target
+
+```
+merge {
+    field => "something"
+    target => "something_else"
+}
+```
+
+## Merge only whitelisted keys
+
+```
+merge {
+	field => "something"
+	whitelist => ["user_agent", "browser_family"]
+}
+```
+
+## Filter options
+
+* **field**
+
+  The source field to read data from.
+
+* **target**
+
+  The field to merge source field with. Defaults to event root.
+
+* **overwrite**
+
+  Overwrite target fields with source field. Defaults to `true`.
+
+* **whitelist**
+
+  If source is a hash, only merge keys listed in this array. Disabled by default.
+
+## Changelog
+
+You can read about all changes in [CHANGELOG.md](CHANGELOG.md).
+
+## Need help?
+
+Need help? Try #logstash on freenode IRC or the [Logstash discussion forum](https://discuss.elastic.co/c/logstash).
+
+## Want to contribute?
+
+Get started by reading [BUILD.md](BUILD.md).

data/lib/logstash/filters/merge.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+class LogStash::Filters::Merge < LogStash::Filters::Base
+
+  config_name "merge"
+
+  # Field to read from.
+  config :field, :validate => :string, :required => true
+
+  # Field to merge with.
+  config :target, :validate => :string
+
+  # Overwrite target fields with source field.
+  config :overwrite, :validate => :boolean, :default => true
+
+  # Allows you to select which keys to merge from a hash.
+  config :whitelist, :validate => :array, :default => []
+
+  private
+  def hash_merge(target, source)
+    if source.is_a? Hash
+      if not target.is_a? Hash and @overwrite
+        target = {}
+      end
+
+      source.each do |source_key, source_value|
+        next if @whitelist.length > 0 and not @whitelist.include? source_key
+        next if target.include? source_key and not @overwrite
+
+        target[source_key] = source_value
+      end
+    else
+      if target.nil? or @overwrite
+        target = source
+      end
+    end
+
+    return target
+  end
+
+  public
+  def register
+  end
+
+  public
+  def filter(event)
+    value = event.get(@field)
+
+    if @target.nil?
+      hash_merge(event.to_hash, value)
+    else
+      event.set(@target, hash_merge(event.get(@target), value))
+    end
+
+    filter_matched(event)
+  end
+end

data/logstash-filter-merge.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-merge'
+  s.version = '1.0.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter helps you merge fields."
+  s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using `logstash-plugin install logstash-filter-base64`. This gem is not a stand-alone program"
+  s.authors = ["William Tisäter"]
+  s.email = 'william@defunct.cc'
+  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
+
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/merge_spec.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+require 'spec_helper'
+require "logstash/filters/merge"
+
+describe LogStash::Filters::Merge do
+  describe "minimal config with hash" do
+    let(:config) { '''
+      filter {
+        merge {
+          field => "data"
+        }
+      }
+    ''' }
+
+    sample("data" => {"one" => 1, "two" => 2}, "three" => 3) do
+      expect(subject.get("one")).to eq(1)
+      expect(subject.get("two")).to eq(2)
+      expect(subject.get("three")).to eq(3)
+    end
+
+    sample("data" => {"one" => 1}, "one" => 0) do
+      expect(subject.get("one")).to eq(1)
+    end
+  end
+
+  describe "minimal config with whitelist" do
+    let(:config) { '''
+      filter {
+        merge {
+          field => "data"
+          whitelist => ["one"]
+        }
+      }
+    ''' }
+
+    sample("data" => {"one" => 1, "two" => 2}, "three" => 3) do
+      expect(subject.get("one")).to eq(1)
+      expect(subject.get("two")).to eq(nil)
+      expect(subject.get("three")).to eq(3)
+    end
+  end
+
+  describe "overwrite set to false with hash" do
+    let(:config) { '''
+      filter {
+        merge {
+          field => "data"
+          overwrite => false
+        }
+      }
+    ''' }
+
+    sample("data" => {"one" => 1, "two" => 2}, "three" => 3) do
+      expect(subject.get("one")).to eq(1)
+      expect(subject.get("two")).to eq(2)
+      expect(subject.get("three")).to eq(3)
+    end
+
+    sample("data" => {"one" => 1, "two" => 2}, "one" => 0) do
+      expect(subject.get("one")).to eq(0)
+      expect(subject.get("two")).to eq(2)
+    end
+  end
+
+  describe "target set to field with hash" do
+    let(:config) { '''
+      filter {
+        merge {
+          field => "data"
+          target => "target"
+        }
+      }
+    ''' }
+
+    sample("data" => {"one" => 1, "two" => 2}, "target" => 3) do
+      expect(subject.get("target")).to eq({"one" => 1, "two" => 2})
+    end
+
+    sample("data" => {"one" => 1, "two" => 2}, "target" => "testing") do
+      expect(subject.get("target")).to eq({"one" => 1, "two" => 2})
+    end
+
+    sample("data" => {"one" => 1, "two" => 2}, "target" => {"one" => 0, "three" => 3}) do
+      expect(subject.get("target")).to eq({"one" => 1, "two" => 2, "three" => 3})
+    end
+  end
+
+  describe "minimal config with integer" do
+    let(:config) { '''
+      filter {
+        merge {
+          field => "data"
+          target => "output"
+        }
+      }
+    ''' }
+
+    sample("data" => 1) do
+      expect(subject.get("output")).to eq(1)
+    end
+
+    sample("data" => 1, "output" => 0) do
+      expect(subject.get("output")).to eq(1)
+    end
+  end
+
+  describe "overwrite set to false with integer" do
+    let(:config) { '''
+      filter {
+        merge {
+          field => "data"
+          target => "output"
+          overwrite => false
+        }
+      }
+    ''' }
+
+    sample("data" => 1) do
+      expect(subject.get("output")).to eq(1)
+    end
+
+    sample("data" => 1, "output" => 0) do
+      expect(subject.get("output")).to eq(0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-merge
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- William Tisäter
+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.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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 `logstash-plugin install logstash-filter-base64`. This gem is not a stand-alone program
+email: william@defunct.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- BUILD.md
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/merge.rb
+- logstash-filter-merge.gemspec
+- spec/filters/merge_spec.rb
+- spec/spec_helper.rb
+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.8
+signing_key:
+specification_version: 4
+summary: This filter helps you merge fields.
+test_files:
+- spec/filters/merge_spec.rb
+- spec/spec_helper.rb