logstash-filter-transducer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae6fb0aab57338731b4a38e05360beb90768eb16
+  data.tar.gz: b17c7c07d27f53ca5db49401bd79f57efd044d23
+SHA512:
+  metadata.gz: 4b6c828b16175d301a941331d570692dc307481944e38c88b160ba40a82aafe6e916f91a56962264ced9929719cd00bfa1ee504fd8eb82647fde607e63edd0d2
+  data.tar.gz: 1abb807fd43da28261670412a9e860deb6eea2fba54c1319a85612beffd8778052d08d4656ad5e38c149ca2e083bda5dfe2d600422367a4a31f5513296b09901

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+.bundle
+vendor

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:
+* Alden Jole (aldenatjanrain)
+* Jordan Sissel (jordansissel)
+* Nick Ethier (nickethier)
+* Philippe Weber (wiibaa)
+* Pier-Hugues Pellerin (ph)
+* R. Toma (rtoma)
+* Richard Pijnenburg (electrical)
+* darrensony
+
+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 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.
+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/README.md

@@ -0,0 +1,95 @@
+# 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/Rakefile

@@ -0,0 +1,7 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+
+require "logstash/devutils/rake"

data/lib/logstash/filters/transducer.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# It splits a given event properties into several new ones where basically
+# a set of attributes are used as a single value. This filter is useful when 
+# you have a data format
+class LogStash::Filters::Transducer < LogStash::Filters::Base
+
+  config_name "transducer"
+
+  # Field name used to store the emited attribute
+  config :field, :validate => :string, :default => "target"
+
+  # Collection of attributes used to create the new events
+  config :attributes, :validate => :array, :required => true
+
+  def register; end;
+
+  def filter(event)
+    return unless filter?(event)
+    @attributes.each do |attr|
+      clone = event.clone
+      clone[@field]  = attr
+      clone["value"] = clone[attr]
+      @attributes.each do |field|
+        clone.remove(field)
+      end
+      filter_matched(clone)
+      @logger.debug("Generated event", :clone => clone, :event => event)
+      yield clone
+    end
+    event.cancel
+  end
+end

data/logstash-filter-transducer.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-transducer'
+  s.version         = '0.0.1'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "The transducer filter, creates a set of new events from a collection of properties of one event."
+  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         = ["Pere Urbon-Bayes"]
+  s.email           = 'pere.urbon@elastic.co'
+  s.homepage        = "https://github.com/purbon/logstash-filter-transducer"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+
+  # 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", "< 3.0.0"
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/filters/transducer_spec.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/transducer"
+
+
+describe LogStash::Filters::Transducer do
+
+  let(:config) do
+    { "attributes" => ["a", "b", "c"] }
+  end
+
+  it "should register" do
+    plugin = LogStash::Plugin.lookup("filter", "transducer").new(config)
+    expect {plugin.register}.to_not raise_error
+  end
+
+  describe "#event creation" do
+
+    let(:attrs) { { "year" => 2015, "type" => "rain", "gen" => 1, "feb" => 2, "marz" => 3 } }
+    let(:_event) { LogStash::Event.new(attrs) }
+
+    let(:config) do
+      {  "attributes" => ["gen", "feb", "marz"] }
+    end
+
+    subject(:plugin) { LogStash::Filters::Transducer.new(config) }
+
+    let(:events) do
+      events = []
+      plugin.filter(_event) do |generated|
+        events << generated
+      end
+      events
+    end
+
+    it "generate a new event per attribute" do
+      expect(events.count).to eq(3)
+    end
+
+    context "#format events" do
+
+      let(:event) { events.first.to_hash }
+
+      it "have a proper target" do
+        expect(event["target"]).to eq("gen")
+      end
+
+      it "have a proper value" do
+        expect(event["value"]).to eq(1)
+      end
+
+      it "have the proper attributes" do
+        expect(event.keys).not_to include("feb")
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-transducer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pere Urbon-Bayes
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-11-02 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
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !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: pere.urbon@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/filters/transducer.rb
+- logstash-filter-transducer.gemspec
+- spec/filters/transducer_spec.rb
+homepage: https://github.com/purbon/logstash-filter-transducer
+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.6
+signing_key:
+specification_version: 4
+summary: The transducer filter, creates a set of new events from a collection of properties of one event.
+test_files:
+- spec/filters/transducer_spec.rb