logstash-filter-de_dot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40cd7fa6cd2b0e8d4bdc3c40dfda787d1f2cdf9e
+  data.tar.gz: 267194e821436b230dbb9d9e15be5aabd7a9e4bd
+SHA512:
+  metadata.gz: 750bf7f0bd52fcf52652afb34603115906b2a5ec7f333991400fe7b8145014f18e5073ce092a10c0442076818db3cecc2dcababf109529419dd1ae95b9b026da
+  data.tar.gz: ab574e0eafe500541678d6e5d4c2f9e7286c741193b8742e748d6d84e9e4bd2402f5a3db6255a07462a2172815fb96a81e4b44a170fad1cc3c60a5ecc6eded4c

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+ - Initial release

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:
+* Aaron Mildenstein (untergeek)
+
+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-filter-de_dot
+If any developer-centric advice will appear here, as needed.

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,89 @@
+# Logstash Plugin
+
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-example-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-example-unit/)
+
+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/de_dot.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# This filter _appears_ to rename fields by replacing `.` characters with a different
+# separator.  In reality, it's a somewhat expensive filter that has to copy the
+# source field contents to a new destination field (whose name no longer contains
+# dots), and then remove the corresponding source field.
+#
+# It should only be used if no other options are available.
+class LogStash::Filters::De_dot < LogStash::Filters::Base
+
+  config_name "de_dot"
+
+  # Replace dots with this value.
+  config :separator, :validate => :string, :default => "_"
+
+  # If `nested` is _true_, then create sub-fields instead of replacing dots with
+  # a different separator.
+  config :nested, :validate => :boolean, :default => false
+
+  # The `fields` array should contain a list of known fields to act on.
+  # If undefined, all top-level fields will be checked.  Sub-fields must be
+  # manually specified in the array.  For example: `["field.suffix","[foo][bar.suffix]"]`
+  # will result in "field_suffix" and nested or sub field ["foo"]["bar_suffix"]
+  #
+  # WARNING: This is an expensive operation.
+  #
+  config :fields, :validate => :array
+
+
+  public
+  def register
+    raise ArgumentError, "de_dot: separator cannot be or contain '.'" unless (@separator =~ /\./).nil?
+    # Add instance variables here, if any
+  end # def register
+
+  private
+  def rename_field(event, fieldref)
+    @logger.debug? && @logger.debug("de_dot: preprocess", :event => event.to_hash.to_s)
+    if @separator == ']['
+      @logger.debug? && @logger.debug("de_dot: fieldref pre-process", :fieldref => fieldref)
+      fieldref = '[' + fieldref if fieldref[0] != '['
+      fieldref = fieldref + ']' if fieldref[-1] != ']'
+      @logger.debug? && @logger.debug("de_dot: fieldref bounding square brackets should exist now", :fieldref => fieldref)
+    end
+    @logger.debug? && @logger.debug("de_dot: source field reference", :fieldref => fieldref)
+    newref = fieldref.gsub('.', @separator)
+    @logger.debug? && @logger.debug("de_dot: replacement field reference", :newref => newref)
+    event[newref] = event[fieldref]
+    @logger.debug? && @logger.debug("de_dot: event with both new and old field references", :event => event.to_hash.to_s)
+    event.remove(fieldref)
+    @logger.debug? && @logger.debug("de_dot: postprocess", :event => event.to_hash.to_s)
+  end
+
+  public
+  def filter(event)
+    @separator = '][' if @nested
+    @logger.debug? && @logger.debug("de_dot: Replace dots with separator", :separator => @separator)
+    @fields = event.to_hash.keys if @fields.nil?
+    @logger.debug? && @logger.debug("de_dot: Act on these fields", :fields => @fields)
+    @fields.each { |ref| rename_field(event, ref) if !(ref =~ /\./).nil? }
+    filter_matched(event)
+  end # def filter
+end # class LogStash::Filters::De_dot

data/logstash-filter-de_dot.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-de_dot'
+  s.version         = '0.1.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter removes dots from field names and replaces them with a different separator."
+  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", "< 3.0.0"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/de_dot_spec.rb

@@ -0,0 +1,189 @@
+# encoding: utf-8
+require 'spec_helper'
+require "logstash/filters/de_dot"
+
+describe LogStash::Filters::De_dot do
+  let(:config) { { } }
+  subject      { LogStash::Filters::De_dot.new(config) }
+
+  let(:attrs) { { } }
+  let(:event) { LogStash::Event.new(attrs) }
+
+  before(:each) do
+    subject.register
+  end
+
+  describe "Incorrect separator" do
+    let(:special) { LogStash::Filters::De_dot.new({ "separator" => "." }) }
+    it "should raise an exception if separator has a '.' in it" do
+      expect { special.register }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "Single field" do
+    let(:attrs) { { "foo.bar" => "pass" } }
+
+    it "should replace a dot with an underscore" do
+      subject.filter(event)
+      expect(event.to_hash.keys).not_to include('foo.bar')
+      expect(event['foo_bar']).to eq('pass')
+    end
+  end
+
+  describe "Single field with alternate separator" do
+    let(:config) { { "separator" => "___" } }
+    let(:attrs) { { "foo.bar" => "pass" } }
+
+    it "should replace a dot with an underscore" do
+      subject.filter(event)
+      expect(event.to_hash.keys).not_to include('foo.bar')
+      expect(event['foo___bar']).to eq('pass')
+    end
+  end
+
+  describe "Multiple fields" do
+    let(:attrs) { { "acme.roller.skates" => "coyote", "nodot" => "nochange" } }
+
+    it "should replace all dots with underscores" do
+      subject.filter(event)
+      expect(event.to_hash.keys).not_to include('acme.roller.skates')
+      expect(event['acme_roller_skates']).to eq('coyote')
+    end
+
+    it "should not change a field without dots" do
+      subject.filter(event)
+      expect(event.to_hash.keys).to include('nodot')
+      expect(event['nodot']).to eq('nochange')
+    end
+  end
+
+  describe "Multiple fields with underscores already" do
+    let(:attrs) { { "acme_roller.skates" => "coyote", "no_dot" => "nochange" } }
+
+    it "should replace all dots with underscores" do
+      subject.filter(event)
+      expect(event.to_hash.keys).not_to include('acme_roller.skates')
+      expect(event['acme_roller_skates']).to eq('coyote')
+    end
+
+    it "should not change a field without dots" do
+      subject.filter(event)
+      expect(event.to_hash.keys).to include('no_dot')
+      expect(event['no_dot']).to eq('nochange')
+    end
+  end
+
+  describe "Nested fields" do
+    let(:config) { { "nested" => true } }
+    let(:attrs) { { "acme.roller.skates" => "coyote", "nodot" => "nochange" } }
+
+    it "should convert dotted fields to sub-fields" do
+      subject.filter(event)
+      expect(event.to_hash.keys).not_to include('acme.roller.skates')
+      expect(event['[acme][roller][skates]']).to eq('coyote')
+    end
+
+    it "should not change a field without dots" do
+      subject.filter(event)
+      expect(event.to_hash.keys).to include('nodot')
+      expect(event['nodot']).to eq('nochange')
+    end
+  end
+
+  describe "Specific nested field" do
+    let(:config) { { "fields" => [ "[acme][roller.skates]" ] } }
+    let(:attrs) { { "acme" => { "roller.skates" => "coyote" }, "foo.bar" => "nochange" } }
+
+    it "should replace all dots with underscores within specified fields" do
+      subject.filter(event)
+      expect(event['acme']).not_to include('roller.skates')
+      expect(event['[acme][roller_skates]']).to eq('coyote')
+    end
+
+    it "should not change a field not listed, even with dots" do
+      subject.filter(event)
+      expect(event.to_hash.keys).to include('foo.bar')
+      expect(event['foo.bar']).to eq('nochange')
+    end
+  end
+
+  describe "Multiple specific nested fields" do
+    let(:config) {
+      {
+        "nested" => true,
+        "fields" => [ "[acme][roller.skates]", "foo.bar", "[a.b][c.d][e.f]" ]
+      }
+    }
+    let(:attrs) {
+      {
+        "acme" => { "roller.skates" => "coyote" },
+        "foo.bar" => "nochange",
+        "a.b" => { "c.d" => { "e.f" => "finally"} }
+      }
+    }
+
+    it "should replace all dots with underscores within specified fields" do
+      subject.filter(event)
+      expect(event['acme']).not_to include('roller.skates')
+      expect(event['[acme][roller][skates]']).to eq('coyote')
+      expect(event.to_hash.keys).not_to include('foo.bar')
+      expect(event['[foo][bar]']).to eq('nochange')
+      expect(event.to_hash.keys).not_to include('a.a')
+      expect(event['[a][b][c][d][e][f]']).to eq('finally')
+    end
+  end
+
+  describe "Specific nested fields with underscores already" do
+    let(:config) {
+      {
+        "fields" => [ "[acme][super.roller_skates]", "[field_with][no_dot]" ]
+      }
+    }
+    let(:attrs) {
+      {
+        "acme" => { "super.roller_skates" => "coyote" },
+        "field_with" => { "no_dot" => "nochange" }
+      }
+    }
+
+    it "should replace all dots with underscores" do
+      subject.filter(event)
+      expect(event["acme"]).not_to include('super.roller_skates')
+      expect(event['[acme][super_roller_skates']).to eq('coyote')
+    end
+
+    it "should not change a field without dots" do
+      subject.filter(event)
+      expect(event.to_hash.keys).to include('field_with')
+      expect(event['[field_with][no_dot]']).to eq('nochange')
+    end
+  end
+
+  describe "Further nesting specific nested fields with underscores already" do
+    let(:config) {
+      {
+        "nested" => true,
+        "fields" => [ "[acme][super.roller_skates]", "[field_with][no_dot]" ]
+      }
+    }
+    let(:attrs) {
+      {
+        "acme" => { "super.roller_skates" => "coyote" },
+        "field_with" => { "no_dot" => "nochange" }
+      }
+    }
+
+    it "should replace all dots with underscores" do
+      subject.filter(event)
+      expect(event["acme"]).not_to include('super.roller_skates')
+      expect(event['[acme][super][roller_skates']).to eq('coyote')
+    end
+
+    it "should not change a field without dots" do
+      subject.filter(event)
+      expect(event.to_hash.keys).to include('field_with')
+      expect(event['[field_with][no_dot]']).to eq('nochange')
+    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-de_dot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-11-09 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: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/de_dot.rb
+- logstash-filter-de_dot.gemspec
+- spec/filters/de_dot_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 removes dots from field names and replaces them with a different separator.
+test_files:
+- spec/filters/de_dot_spec.rb
+- spec/spec_helper.rb