logstash-filter-lrucache 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13f2d298a5c8e847bbe8459dcec6eabfdd4cf0028ece4598cc5daf3fe7601299
+  data.tar.gz: 59fabc950eaf36864f48d9c9cfbcdf8938c22119d9355214461294be17bb92d0
+SHA512:
+  metadata.gz: a5deceda36715a0cd8ab21a1116d25427757f05fb326065cf73c87822db5aa8b32c0ace06e3c24d56bfd968881b8febaf35ab030618d4200267360f6a4627013
+  data.tar.gz: 9c7d8159d515edaa24b6d7623115fa12fc311f91a998bf44379f883af9d39f4b9b06424b0e6bf72c58c52dacba3f6a048da6f54a446323a746d7034cb70f20bb

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-lrucache
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

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

@@ -0,0 +1,117 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "lru_redux"
+
+# The lrucache filter provides caching using the LRU(Least Recently Used) algorithm.
+# 
+# If you are use filter that retrieve values ​​dynamically from external data sources,
+# you may experience performance problems when handling many logs.
+# This plugin designed to solve these problems.
+# 
+# See below an example of how this filter might be used.
+# [source,ruby]
+# --------------------------------------------------
+# filter {
+#   # Find `blacklisted_at` value for particular `host` in cache.
+#   lrucache {
+#     namespace => "blacklisted_at"
+#     action => "get"
+#     key => "%{host}"
+#     target => "blacklisted_at"
+#   }
+#
+#   if ![blacklisted_at] {
+#     # If no value is found in cache, Query to elasticsearch.
+#     elasticsearch {
+#       query => "host:%{host}"
+#       index => "blacklist"
+#       fields => { "@timestamp" => "blacklisted_at" }
+#     }
+#
+#     if [blacklisted_at] {
+#       # Store query result into cache.
+#       lrucache {
+#         namespace => "blacklisted_at"
+#         action => "set"
+#         key => "%{host}"
+#         value => "%{blacklisted_at}"
+#       }
+#     }
+#   }
+#
+#   if [blacklisted_at] {
+#     # Drop incoming log from blacklisted host.
+#     drop {}
+#   }
+# }
+# --------------------------------------------------
+# 
+# NOTE: If the filter to use already has a cache function, consider it first.
+#
+class LogStash::Filters::Lrucache < LogStash::Filters::Base
+
+  config_name "lrucache"
+  
+  # Each namespace has own cache storage.
+  config :namespace, :validate => :string, :default => "default"
+
+  # The action to perform.
+  config :action, :validate => [ "get", "set", "delete", "clear" ], :required => true
+
+  # The key to access cache. It can be dynamic and include parts of the event using the %{field}. Not used in `clear` action.
+  config :key, :validate => :string
+  
+  # Store the value found in cache into the given target field. Field is overwritten if exists. Used only in `get` action.
+  config :target, :validate => :string, :default => "cached_value"
+
+  # Default value used when no value is found in cache. Used only in `get` action.
+  config :default_value, :validate => :string
+
+  # The value to set. It can be dynamic and include parts of the event using the %{field}. Used only in `set` action.
+  config :value, :validate => :string
+
+  # Maximum size for cache storage. Used once per namespace in `set` action.
+  config :max_size, :validate => :number, :default => 1000
+
+  # The TTL(Time To Live) of value stored in cache storage. Used once per namespace in `set` action.
+  config :ttl, :validate => :number, :default => 5.0
+
+  @@cache_storage = {}
+
+  public
+  def register
+    # Do nothing
+  end # def register
+
+  public
+  def filter(event)
+    cache = lookupCacheStorage(@namespace)
+    formattedKey = event.sprintf(@key);
+
+    case @action
+      when "get"
+        value = (cache[formattedKey] if cache) || @default_value
+        event.set(@target, value)
+      when "set"
+        value = event.sprintf(@value)
+        cache[formattedKey] = value
+      when "delete"
+        cache.delete(formattedKey) if cache
+      when "clear"
+        cache.clear() if cache
+    end
+
+    @logger.debug("Do `#{@action}`.", :namespace => @namespace, :key => formattedKey, :value => value) if @logger.debug?
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+
+  def lookupCacheStorage(namespace)
+    if !@@cache_storage.has_key?(namespace) && @action == "set"
+      @@cache_storage[namespace] = ::LruRedux::TTL::ThreadSafeCache.new(@max_size, @ttl)
+    end
+    @@cache_storage[namespace]
+  end
+end # class LogStash::Filters::Lrucache

data/logstash-filter-lrucache.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-lrucache'
+  s.version       = '1.0.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'You can use this filter to cache values using LRU algorithm.'
+  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-lrucache'
+  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-sleep'
+end

data/spec/filters/lrucache_spec.rb

@@ -0,0 +1,254 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/lrucache"
+require "logstash/filters/sleep"
+
+describe LogStash::Filters::Lrucache do
+  describe "basic get-set" do
+    let(:config) do <<-CONFIG
+      filter {
+        # get non-cache value
+        lrucache {
+          namespace => "basic_get-set"
+          action => "get"
+          key => "%{key}"
+          target => "empty_result"
+        }
+
+        # get default value
+        lrucache {
+          namespace => "basic_get-set"
+          action => "get"
+          key => "%{key}"
+          target => "default_value"
+          default_value => "NotFound"
+        }
+
+        # set value into cache
+        lrucache {
+          namespace => "basic_get-set"
+          action => "set"
+          key => "%{key}"
+          value => "%{value}"
+        }
+
+        # get cached value
+        lrucache {
+          namespace => "basic_get-set"
+          action => "get"
+          key => "%{key}"
+          target => "successful_result"
+        }
+      }
+    CONFIG
+    end
+
+    sample("key" => "cache_key", "value" => "cached_result") do
+      expect(subject.get("empty_result").nil?)
+      expect(subject.get("default_value")).to eq("NotFound")
+      expect(subject.get("successful_result")).to eq("cached_result")
+    end
+  end
+
+  describe "delete, clear" do
+    let(:config) do <<-CONFIG
+      filter {
+        # Initialize cache
+        lrucache {
+          namespace => "delete_clear"
+          action => "set"
+          key => "a"
+          value => "a"
+        }
+
+        lrucache {
+          namespace => "delete_clear"
+          action => "set"
+          key => "b"
+          value => "b"
+        }
+
+        # Delete one
+        lrucache {
+          namespace => "delete_clear"
+          action => "delete"
+          key => "a"
+        }
+
+        # Check values
+        lrucache {
+          namespace => "delete_clear"
+          action => "get"
+          key => "a"
+          target => "deleted_a"
+        }
+
+        lrucache {
+          namespace => "delete_clear"
+          action => "get"
+          key => "b"
+          target => "not_deleted_b"
+        }
+
+        # Clear all
+        lrucache {
+          namespace => "delete_clear"
+          action => "clear"
+        }
+
+        # Check values
+        lrucache {
+          namespace => "delete_clear"
+          action => "get"
+          key => "b"
+          target => "cleared_b"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "dummy") do
+      expect(subject.get("deleted_a").nil?)
+      expect(subject.get("not_deleted_b")).to eq("b")
+      expect(subject.get("cleared_b").nil?)
+    end
+  end
+
+  describe "get-set with different namespaces" do
+    let(:config) do <<-CONFIG
+      filter {
+        # init values into different namespaces
+        lrucache {
+          namespace => "a"
+          action => "set"
+          key => "a"
+          value => "a"
+        }
+
+        lrucache {
+          namespace => "b"
+          action => "set"
+          key => "b"
+          value => "b"
+        }
+
+        # get values
+        lrucache {
+          namespace => "a"
+          action => "get"
+          key => "a"
+          target => "[a][a]"
+        }
+
+        lrucache {
+          namespace => "a"
+          action => "get"
+          key => "b"
+          target => "[a][b]"
+        }
+
+        lrucache {
+          namespace => "b"
+          action => "get"
+          key => "b"
+          target => "[b][b]"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "dummy") do
+      expect(subject.get("[a][a]")).to eq("a")
+      expect(subject.get("[a][b]").nil?)
+      expect(subject.get("[b][b]")).to eq("b")
+    end
+  end
+  
+  describe "with ttl option" do
+    let(:config) do <<-CONFIG
+      filter {
+        lrucache {
+          namespace => "ttl_1s"
+          action => "set"
+          key => "a"
+          value => "a"
+          ttl => 1
+        }
+
+        lrucache {
+          namespace => "ttl_5s"
+          action => "set"
+          key => "a"
+          value => "a"
+          ttl => 5
+        }
+
+        sleep {
+          time => "2"
+        }
+
+        lrucache {
+          namespace => "ttl_1s"
+          action => "get"
+          key => "a"
+          target => "expired_a"
+        }
+
+        lrucache {
+          namespace => "ttl_5s"
+          action => "get"
+          key => "a"
+          target => "alive_a"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "dummy") do
+      expect(subject.get("expired_a").nil?)
+      expect(subject.get("alive_a")).to eq("a")
+    end
+  end
+
+  describe "with max_size option" do
+    let(:config) do <<-CONFIG
+      filter {
+        lrucache {
+          namespace => "size_limited"
+          action => "set"
+          max_size => 1
+          key => "a"
+          value => "a"
+        }
+
+        lrucache {
+          namespace => "size_limited"
+          action => "set"
+          max_size => 1
+          key => "b"
+          value => "b"
+        }
+
+        lrucache {
+          namespace => "size_limited"
+          action => "get"
+          key => "a"
+          target => "flushed_a"
+        }
+
+        lrucache {
+          namespace => "size_limited"
+          action => "get"
+          key => "b"
+          target => "remained_b"
+        }
+      }
+      CONFIG
+    end
+    
+    sample("message" => "dummy") do
+      expect(subject.get("flushed_a").nil?)
+      expect(subject.get("remained_b")).to eq("b")
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-lrucache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sw-jung
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-10-25 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-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/lrucache.rb
+- logstash-filter-lrucache.gemspec
+- spec/filters/lrucache_spec.rb
+homepage: https://github.com/sw-jung/logstash-filter-lrucache
+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.13
+signing_key:
+specification_version: 4
+summary: You can use this filter to cache values using LRU algorithm.
+test_files:
+- spec/filters/lrucache_spec.rb