logstash-filter-memoize 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c65bd92d7752bac24f3628bd6e8e1cf6602c86f93352e7407b1af93a74460387
+  data.tar.gz: f00ff3c23edb2e739a856df0ccc75b7ca72a4529aa07967399dc0df9caf3230c
+SHA512:
+  metadata.gz: fcbd837e0783fbb51b6bfd01054db16dfa66da3dc414e8e15a8c4551d80b99587b4581c1c3a6d4d5c131397dc5467278faa4ca9475242aa2d1cdb678ec0c71db
+  data.tar.gz: 9312c84637543d6361d487fc5b85da96aad8e24726507b101d3a19f5e1a3046b07fcff8c5098d8ac42529358f4abcac2f3341196667d3ceab48e78d08d61662a

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 1.0.0
+  - Plugin created with the logstash plugin generator
+  - Implemented memoization using [lru_redux](https://github.com/SamSaffron/lru_redux).
+  - Following options are supported: `key`, `fields`, `filter_name`, `filter_options`, `cache_size`, `ttl`

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:
+* sw.jung - kjss10@gmail.com
+
+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-memoize
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

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/memoize.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "lru_redux"
+
+# This filter provides https://en.wikipedia.org/wiki/Memoization[memoization] to wrapped filter.
+# Internally, It based on https://en.wikipedia.org/wiki/Cache_replacement_policies#LRU[LRU] cache algorithm.
+#
+# See below an example of how this filter might be used.
+# [source,ruby]
+# --------------------------------------------------
+# filter {
+#   memoize {
+#     key => "%{host}" <1>
+#     fields => ["host_owner", "host_location"] <2>
+#     filter_name => "elasticsearch" <3>
+#     filter_options => { <4>
+#       query => "host:%{host}"
+#       index => "known_host"
+#       fields => {
+#         "host_owner" => "host_owner"
+#         "host_location" => "host_location"
+#       }
+#     }
+#   }
+# }
+# --------------------------------------------------
+# 
+# * When an event with a new <1> key comes in, execute wrapped <3> <4> filter and caches the <2> fields value.
+# * When an event with a same <1> key comes in, sets cached value to target <2> fields without wrapped <3> <4> filter execution.
+#
+class LogStash::Filters::Memoize < LogStash::Filters::Base
+
+  config_name "memoize"
+
+  # The key to use caching and retrieving values. It can be dynamic and include parts of the event using the %{field}.
+  config :key, :validate => :string, :required => true
+
+  # The fields to be cached from result, or to be set cached value.
+  config :fields, :validate => :array, :required => true
+
+  # The filter name what you want to use.
+  config :filter_name, :validate => :string, :required => true
+
+  # The filter options what you want to use. You can use all of options in the `filter_name` filter.
+  config :filter_options, :validate => :hash, :default => {}
+
+  # Maximum size of cache.
+  config :cache_size, :validate => :number, :default => 1000
+
+  # The TTL(Time To Live) of cached value.
+  config :ttl, :validate => :number
+  
+  public
+  def register
+    @filter = LogStash::Plugin.lookup("filter", @filter_name).new(@filter_options)
+    @filter.register
+    @cache = ::LruRedux::TTL::ThreadSafeCache.new(@cache_size, @ttl)
+  end # def register
+
+  public
+  def filter(event)
+    formattedKey = event.sprintf(@key);
+    result = @cache[formattedKey]
+
+    if !result.nil?
+      @logger.debug("Cached value found.", :key => formattedKey, :value => result) if @logger.debug?
+      @fields.each { |field| event.set(field, result[field]) }
+    else
+      @logger.debug("Cached value not found. Do filter.", :key => formattedKey, :filter => @filter) if @logger.debug?
+      @filter.filter(event)
+      @fields.each { |field| (result ||= {})[field] = event.get(field) }
+      @cache[formattedKey] = result
+    end
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+end # class LogStash::Filters::Memoize

data/logstash-filter-memoize.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-memoize'
+  s.version       = '1.0.0'
+  s.licenses      = ['Apache License (2.0)']
+  s.summary       = 'This filter-plugin provides memoization to any filter you want.'
+  s.description   = 'This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program'
+  s.homepage      = 'https://github.com/sw-jung/logstash-filter-memoize'
+  s.authors       = ['sw.jung']
+  s.email         = 'kjss10@gmail.com'
+  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-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'lru_redux'
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-filter-ruby'
+  s.add_development_dependency 'logstash-filter-sleep'
+end

data/spec/filters/memoize_spec.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/memoize"
+
+describe LogStash::Filters::Memoize do
+  describe "basic work" do
+    let(:config) do <<-CONFIG
+      filter {
+        ruby {
+          code => "event.set('time', Time.now.to_f)"
+        }
+
+        memoize {
+          key => "%{key}"
+          fields => ["result"]
+          filter_name => "ruby"
+          filter_options => {
+            code => "event.set('result', event.get('time'))"
+          }
+        }
+      }
+    CONFIG
+    end
+
+    sample([
+      {"key" => "cache_key"},
+      {"key" => "cache_key2"},
+      {"key" => "cache_key"}
+    ]) do
+      # If key is different, result different also.
+      expect(subject[0].get("time")).to eq(subject[0].get("result"))
+      expect(subject[1].get("time")).to eq(subject[1].get("result"))
+      expect(subject[0].get("time")).not_to eq(subject[1].get("result"))
+      
+      # If key is same, cache works
+      expect(subject[0].get("time")).to eq(subject[0].get("result"))
+      expect(subject[2].get("time")).not_to eq(subject[2].get("result"))
+      expect(subject[0].get("time")).to eq(subject[2].get("result"))
+    end
+  end
+
+  describe "ttl work" do
+    let(:config) do <<-CONFIG
+      filter {
+        ruby {
+          code => "event.set('time', Time.now.to_f)"
+        }
+
+        memoize {
+          key => "%{key}"
+          fields => ["result"]
+          filter_name => "ruby"
+          filter_options => {
+            code => "event.set('result', event.get('time'))"
+          }
+          ttl => 1
+        }
+
+        sleep {
+          time => "2"
+        }
+      }
+    CONFIG
+    end
+
+    sample([
+      {"key" => "cache_key"},
+      {"key" => "cache_key"}
+    ]) do
+      # After ttl seconds, cached value are delete
+      expect(subject[0].get("time")).to eq(subject[0].get("result"))
+      expect(subject[1].get("time")).to eq(subject[1].get("result"))
+      expect(subject[0].get("time")).not_to eq(subject[1].get("result"))
+    end
+  end
+
+  describe "cache_size work" do
+    let(:config) do <<-CONFIG
+      filter {
+        ruby {
+          code => "event.set('time', Time.now.to_f)"
+        }
+
+        memoize {
+          key => "%{key}"
+          fields => ["result"]
+          filter_name => "ruby"
+          filter_options => {
+            code => "event.set('result', event.get('time'))"
+          }
+          cache_size => 1
+        }
+      }
+    CONFIG
+    end
+
+    sample([
+      {"key" => "cache_key"},
+      {"key" => "cache_key2"},
+      {"key" => "cache_key"}
+    ]) do
+      # If cache over cache size, old cached value are delete first
+      expect(subject[0].get("time")).to eq(subject[0].get("result"))
+      expect(subject[1].get("time")).to eq(subject[1].get("result"))
+      expect(subject[2].get("time")).to eq(subject[2].get("result"))
+      expect(subject[0].get("time")).not_to eq(subject[2].get("result"))
+    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,129 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-memoize
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sw.jung
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: lru_redux
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-filter-ruby
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-filter-sleep
+  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/logstash-plugin install gemname. This
+  gem is not a stand-alone program
+email: kjss10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/memoize.rb
+- logstash-filter-memoize.gemspec
+- spec/filters/memoize_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sw-jung/logstash-filter-memoize
+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.6.13
+signing_key:
+specification_version: 4
+summary: This filter-plugin provides memoization to any filter you want.
+test_files:
+- spec/filters/memoize_spec.rb
+- spec/spec_helper.rb