logstash-filter-fieldmap 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a252ea6441660da9c5c79041a1fead2ebd1e6759
+  data.tar.gz: de4ad626f2124376d50210aa910242d1d9eed5a5
+SHA512:
+  metadata.gz: 472d273fb4c4a2939a897103cdb11e07f91d07b5805b81587806fb67d976dd1817198f16624422f8f79bde302615832921bd75fb0407bcc1a58cd501550d7155
+  data.tar.gz: b8dd07aa4910e4d9bfab2c5c0a60db7f506b86f0153660fc3940be42c968bd3eeacb8418d8d7dda1eeb10b68562308241c4170508e1d57a4a61a56da817da2c1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.0.2
+ - rescue if the field val has a { but isn't json.  its kind of a crappy test
+
+## 0.0.1
+ - initial create
+

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 this logstash plugin along its way.
+
+Contributors:
+* Patrick Christopher (coffeepac)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+this Logstash plugin, 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,4 @@
+# logstash-filter-fieldmap
+Takes a constant list of fields and a target field in the event.  Splits 
+the event by a specified sperator and then creates a dictionary field
+where the constant list are the keys and the split string is the values.

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,86 @@
+# 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
+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
+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 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/fieldmap.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# This filter will split the src_field on delimiter and then
+# create a map in the dst_field by pairing the elements of
+# the keys config item with the values from the split src 
+# field.
+#
+# If the number of elements in the split src_field and the 
+# supplied keys is not the same the event will receive a tag
+# and be sent along
+#
+class LogStash::Filters::FieldMap < LogStash::Filters::Base
+
+  # Setting the config_name here is required. This is how you
+  # configure this filter from your Logstash config.
+  #
+  # filter {
+  #   fieldmap {
+  #     src_field => 'message'
+  #     dst_field => 'mapped_message'
+  #     delimiter => ' '
+  #     keys => ['KeyA', 'KeyB']
+  #   }
+  # }
+  #
+  config_name "fieldmap"
+  
+  # Field to use as source for map values
+  config :src_field, :validate => :string, :default => "message"
+
+  # Field to store processed values into.
+  # this filter will overwrite any data already in dst_field
+  config :dst_field, :validate => :string, :default => "mapped_message"
+
+  # Regex to split src_field by
+  config :regex, :validate => :string, :default => '[[:space:]]'
+
+  # List of keys to use in the dst map
+  config :keys, :validate => :array, :required => true
+  
+  # Append value to the tag field when the mapping failed
+  config :map_failure, :validate => :string, :default => "_fieldmapfailed"
+  public
+  def register
+    # Add instance variables 
+  end # def register
+
+  public
+  def filter(event)
+  @logger.debug? and @logger.debug("Running fieldmap filter", :event => event)
+
+    if event[@src_field]
+      #  split the src field on delimiter then check if that length matches
+      #  the key lenght, if not, explode
+      split_src = event[@src_field].split(/#{@regex}/)
+      @logger.debug? and @logger.debug("split_src is: ", :split_src => split_src)
+      if split_src.length == @keys.length
+        event[@dst_field] = {}  #  don't need to save off the source data, already split into split_src
+        idx = 0
+        split_src.map do |val| 
+          val = val.strip
+          if val.include?('{')
+            begin
+              val = LogStash::Json.load(val.gsub("\\", ""))
+            rescue LogStash::Json::ParserError  # if its not valid json leave it alone
+            end
+          end
+          event[@dst_field][@keys[idx]] = val 
+          idx=idx+1
+        end
+        filter_matched(event)
+      else
+        event["tags"] ||= []
+        event["tags"] << @map_failure unless event["tags"].include?(@map_failure)
+        @logger.info? and @logger.info("Event failed field map")
+      end
+    end
+
+  @logger.debug? and @logger.debug("Event now: ", :event => event)
+
+  end # def filter
+end # class LogStash::Filters::Example

data/logstash-filter-fieldmap.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-fieldmap'
+  s.version         = '0.0.2'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter will split the src_field on delimiter and then create a map in the dst_field by pairing the elements of the keys config item with the values from the split src field"
+  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 = ["Patrick Christopher"]
+  s.email = 'coffeepac@gmail.com'
+  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", "< 3.0.0"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/fieldmap_spec.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'spec_helper'
+require "logstash/filters/fieldmap"
+
+describe LogStash::Filters::FieldMap do
+  describe "Hello World Demo" do
+    let(:config) do <<-CONFIG
+      filter {
+        fieldmap {
+          src_field => 'message'
+          dst_field => 'mapped_message'
+          regex => '[[:blank:]]'
+          keys => ['Greeting', 'Target']
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "Hello World") do
+      expect(subject).to include("message")
+      expect(subject['mapped_message']).to eq({'Greeting' => 'Hello', 'Target' => 'World'})
+    end
+
+    sample("message" => "MazelTof {\"Hello\":\"World\"}") do
+      expect(subject['mapped_message']).to eq({'Greeting' => 'MazelTof', 'Target' => {'Hello' => 'World'}})
+    end
+  end
+
+  describe "Hello World Hate" do
+    let(:config) do <<-CONFIG
+      filter {
+        fieldmap {
+          src_field => 'message'
+          dst_field => 'mapped_message'
+          keys => ['Greeting', 'Target']
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "Hello Haters") do
+      expect(subject).to include("message")
+      expect(subject['mapped_message']).to eq({'Greeting' => 'Hello', 'Target' => 'Haters'})
+    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,92 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-fieldmap
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Patrick Christopher
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.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/plugin install gemname. This gem is not a stand-alone program
+email: coffeepac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/fieldmap.rb
+- logstash-filter-fieldmap.gemspec
+- spec/filters/fieldmap_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 will split the src_field on delimiter and then create a map in the dst_field by pairing the elements of the keys config item with the values from the split src field
+test_files:
+- spec/filters/fieldmap_spec.rb
+- spec/spec_helper.rb