logstash-filter-remove_key_pattern 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdea4c729036149c31577a3da38c119fcbd32412
+  data.tar.gz: 53598fbdb3513c2f009bd1b5ff6311d1e9daf5e9
+SHA512:
+  metadata.gz: 7b22d733cc9eb7bf767b179f93ae1cb36ebdcf90fef91fae0d3ba70f5a4851b227841d0c338c5c34383de0616a2cd2ec8c6838247e5dcb65710c976b943f6505
+  data.tar.gz: 445d1b9a17298e4fccc6b516bdc29f806d38954fcd1528dc866abb0acd231f3c2374d74726b3cef91c82d7dcc4da570a7ff3fbabd3bb11fe20eae8c25adfc845

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,11 @@
+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,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/logstash-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/logstash-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/remove_key_pattern.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "logstash/json"
+
+# Remove key pattern filter. Receives a parent key and an array
+# with multiple patterns to remove from it's children
+#
+# For example, if you have a parent named 'haystack', and you want to
+# remove all his children that contains a digit(\d) or 'needle', do this:
+# [source, ruby]
+#   filter {
+#     remove_key_pattern {
+#       parent_keys => ["haystack1", "haystack2"]
+#       pattern => ["\\d", "needle"]
+#       keep_only_ids => "true"
+#     }
+#   }
+#
+class LogStash::Filters::RemoveKeyPattern < LogStash::Filters::Base
+
+  config_name "remove_key_pattern"
+
+  # Array of parent keys to remove from
+  config :parent_keys, :validate => :array, :required => true
+
+  # Array of patterns to remove
+  config :pattern, :validate => :array, :required => true
+
+  # Boolean to set if the filter should prevent everything besides the ids that are not in the patterns to pass
+  config :keep_only_ids, :validate => :boolean, :required => true, :default => false
+
+  public
+  def register
+    begin
+      @pattern = Regexp.new(@pattern.join('|'))
+    rescue
+      @logger.error("One or more keys are invalid", :pattern => @pattern.join(', '))
+      raise "Bad pattern, aborting"
+    end
+  end
+
+  public
+  def filter(event)
+    @parent_keys.each do |key|
+      remove_pattern(event, key) unless event.get(key).nil?
+    end
+    filter_matched(event)
+  end
+
+  private
+  def remove_pattern(event, key)
+    hash = {}
+    event.get(key).each do |k, v|
+      unless (k =~ @pattern)
+        if @keep_only_ids && (k == 'id' or k =~ /.*_id$/)
+          hash[k] = v
+        elsif !@keep_only_ids
+          hash[k] = v
+        end
+      end
+    end
+    event.set("#{key}_json", LogStash::Json.dump(event.get(key)))
+    event.set(key, hash)
+  end
+end

data/logstash-filter-remove_key_pattern.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-remove_key_pattern'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Remove all keys that match pattern'
+  s.authors       = ['Arthur Alfredo']
+  s.email         = 'a.alfredo@miceportal.com'
+  s.require_paths = ['lib']
+  s.homepage      = 'http://github.com/miceportal/logstash_filter_remove_key_pattern'
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
+   # 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-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_development_dependency 'logstash-devutils', "~> 1.3", ">= 1.3.0"
+end

data/spec/filters/remove_key_pattern_spec.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/remove_key_pattern"
+
+describe LogStash::Filters::RemoveKeyPattern do
+
+  describe "remove a pattern from parent keys keeping only ids" do
+    config <<-CONFIG
+      filter {
+        remove_key_pattern {
+          parent_keys => ["haystack2", "haystack"]
+          pattern => ["needle", "\\d"]
+          keep_only_ids => "true"
+        }
+      }
+    CONFIG
+
+    hash = {
+      "hello" => {
+        "numbers" => ["one", "two", "three"],
+        "47" => ["2", "3", "7"],
+      },
+      "haystack" => {
+        "key1_id" => ["value1", "value2", "value3"],
+        "id" => ["value1", "value2", "value3"],
+        "key4_id" => ["value1", "value2", "value3"],
+        "key_four_id" => ["value1", "value2", "value3"],
+        "needle" => ["value1", "value2", "value3"],
+      },
+      "haystack2" => {
+        "key_one_id" => ["value1", "value2", "value3"],
+        "id" => ["value1", "value2", "value3"],
+        "key4_id" => ["value1", "value2", "value3"],
+        "key" => ["value1", "value2", "value3"],
+        "foobar" => ["value1", "value2", "value3"],
+      }
+    }
+
+    sample(hash) do
+      insist { subject.get("hello") }.include?("numbers")
+      insist { subject.get("haystack") }.include?("id")
+      insist { subject.get("haystack") }.include?("key_four_id")
+      reject { subject.get("haystack") }.include?("key4_id")
+      reject { subject.get("haystack2") }.include?("needle")
+      insist { subject.get("haystack2") }.include?("key_one_id")
+      reject { subject.get("haystack2") }.include?("key4_id")
+      reject { subject.get("haystack2") }.include?("key")
+      reject { subject.get("haystack2") }.include?("foobar")
+    end
+  end
+
+  describe "remove a pattern from parent keys without keeping only ids" do
+    config <<-CONFIG
+      filter {
+        remove_key_pattern {
+          parent_keys => ["haystack2", "haystack"]
+          pattern => ["needle", "\\d"]
+          keep_only_ids => "false"
+        }
+      }
+    CONFIG
+
+    hash = {
+      "hello" => {
+        "numbers" => ["one", "two", "three"],
+        "47" => ["2", "3", "7"],
+      },
+      "haystack" => {
+        "key1_id" => ["value1", "value2", "value3"],
+        "id" => ["value1", "value2", "value3"],
+        "key4_id" => ["value1", "value2", "value3"],
+        "key_four_id" => ["value1", "value2", "value3"],
+        "needle" => ["value1", "value2", "value3"],
+      },
+      "haystack2" => {
+        "key_one_id" => ["value1", "value2", "value3"],
+        "id" => ["value1", "value2", "value3"],
+        "key4_id" => ["value1", "value2", "value3"],
+        "key" => ["value1", "value2", "value3"],
+        "foobar" => ["value1", "value2", "value3"],
+      }
+    }
+
+    sample(hash) do
+      insist { subject.get("hello") }.include?("numbers")
+      insist { subject.get("haystack") }.include?("id")
+      insist { subject.get("haystack") }.include?("key_four_id")
+      reject { subject.get("haystack") }.include?("key4_id")
+      reject { subject.get("haystack2") }.include?("needle")
+      insist { subject.get("haystack2") }.include?("key_one_id")
+      reject { subject.get("haystack2") }.include?("key4_id")
+      insist { subject.get("haystack2") }.include?("key")
+      insist { subject.get("haystack2") }.include?("foobar")
+    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,94 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-remove_key_pattern
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arthur Alfredo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description:
+email: a.alfredo@miceportal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/remove_key_pattern.rb
+- logstash-filter-remove_key_pattern.gemspec
+- spec/filters/remove_key_pattern_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/miceportal/logstash_filter_remove_key_pattern
+licenses:
+- Apache-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.6.8
+signing_key:
+specification_version: 4
+summary: Remove all keys that match pattern
+test_files:
+- spec/filters/remove_key_pattern_spec.rb
+- spec/spec_helper.rb