logstash-filter-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 909dcb096518a55347b4391ccdbc8cb2eccb9339
+  data.tar.gz: dddb405a4a719286a63085b1852656ad58b06e8c
+SHA512:
+  metadata.gz: fdabb6f0b88142013da4037b5f3a72393202f9cbcbf3a4a6c5d4663a10124104e87e7d12b6ba527746feefab5d2d7ac33eb21442c064d0270bc5365828a58241
+  data.tar.gz: 1085d4cb41ada8863af80770e9049d37e79d928f588632e014c9d3ef86144c389adc5d4738a6d60da4ff0b1c8db5474bb62b1fc8538f2ef282fbf411eb3cafea

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

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 logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+
+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-example
+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,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,23 @@
+# Logstash Filter Cache
+
+This filter provide a cache where you can store data.
+
+## Installation
+```sh
+bin/plugin install logstash-filter-cache
+```
+
+## Usage
+
+```javascript
+
+```
+
+## Example
+
+```sh
+bin/logstash -e 'input { stdin {} } filter { sequence { field => "sequence" } } output {stdout { codec => rubydebug }}' -w 1
+Default settings used: Filter workers: 1
+Logstash startup completed
+
+```

data/lib/logstash/filters/cache.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# This filter provide a cache where you can store data.
+#
+class LogStash::Filters::Cache < LogStash::Filters::Base
+
+  # The config looks like this:
+  #
+  #     filter {
+  #       cache {
+  #         key => "YYYY"
+  #         value => "XXXX"
+  #         get => "boolean"
+  #         field => "ZZZZZ"
+  #       }
+  #     }
+  #
+  # The `field` is the field you want added to the event.
+  config_name "cache"
+ 
+  # This filter needs to keep state.
+  @@cachetab = Hash.new
+
+  # The key for the data you want to store or retrieve
+  config :key, :validate => :string, :required => true
+
+  # The value for the data you want to store or retrieve
+  config :value, :validate => :string, :required => false
+
+  # Sets the action. If set to true, it will get the data from cache
+  config :get, :validate => :boolean, :default => false
+
+  # The field where the value be set for get => "true"
+  config :field, :validate => :string, :required => false, :default => "cache_value"
+
+  public
+  def register
+    # Nothing
+    @threadsafe = false
+  end # def register
+
+  public
+  def filter(event)
+    if @get
+      event[@field] = @@cachetab[@key]
+      if event[@field] == nil
+        event["tags"] ||= []
+        event["tags"] << "cache_miss" unless event["tags"].include?("cache_miss")
+      else
+        # filter_matched should go in the last line of our successful code
+        filter_matched(event)
+      end
+    else
+      @@cachetab[@key]= event.sprintf(@value)
+      # filter_matched should go in the last line of our successful code
+      filter_matched(event)
+    end
+
+  end # def filter
+end # class LogStash::Filters::Cache

data/logstash-filter-cache.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-cache'
+  s.version         = '0.1.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter provide a cache where you can store data."
+  s.description = "This filter provide a cache where you can store data. 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, apenvern"]
+  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/cache_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'spec_helper'
+require "logstash/filters/example"
+
+describe LogStash::Filters::Cache do
+  describe "Add a sequence number to a log entry do"
+    let(:config) do <<-CONFIG
+      filter {
+        sequence {
+          field => "sequence"
+        }
+      }
+    CONFIG
+    end
+
+    sample("field" => "seq_field") do
+      expect(subject).to include("seq_field")
+    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-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elastic, apenvern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-11-19 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 filter provide a cache where you can store data. 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/cache.rb
+- logstash-filter-cache.gemspec
+- spec/filters/cache_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 provide a cache where you can store data.
+test_files:
+- spec/filters/cache_spec.rb
+- spec/spec_helper.rb