logstash-filter-redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a33ce0bd137fe32dbd8b1bc716c31a512f6d2d53
+  data.tar.gz: 3b72ea72d1401d9f066149110ecc5ba90fa4b637
+SHA512:
+  metadata.gz: fdb174a1c449c536020f8ba5b14798c9339245b615363274b0bfe9d48ec3181d999e87793ff748dd178203e3a910d18cfdc66cc61e1d204a949b88ab84a362a7
+  data.tar.gz: f0fa4f2b728a16062c72c9e31f5814bb5654736366b553f1a8cc199982df7d0a13533a3aca12ffda2b22546e6fc1d991c4b67bbffebc6b2d8a748acffce47c4b

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,88 @@
+# TODO: remove/alter Elasticsearch example text from this file and the licence/copyright/etc...
+
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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.elasticsearch.org/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/elasticsearch/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/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/redis.rb

@@ -0,0 +1,110 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+
+class LogStash::Filters::Redis < LogStash::Filters::Base
+
+  config_name "redis"
+
+  # The hostname of your Redis server.
+  config :host, :validate => :string, :default => "127.0.0.1"
+
+  # The port to connect on.
+  config :port, :validate => :number, :default => 6379
+
+  # Password to authenticate with. There is no authentication by default.
+  config :password, :validate => :password
+
+  # The Redis database number.
+  config :db, :validate => :number, :default => 0
+  
+  # Tag to store key
+  config :store_tag, :validate => :string, :required => true
+
+  # Tag to retrieve key
+  config :retrieve_tag, :validate => :string, :required => true
+
+  # Redis key name
+  config :key, :validate => :string, :required => true
+
+  # Delete on retrieval
+  config :delete, :validate => :boolean, :default => false
+
+  # Fields to store in the Redis value
+  config :fields, :validate => :array, :default => ["message"]
+
+  # Field prefix
+  config :prefix, :validate => :string, :default => "old_"
+
+  # Connection timeout
+  config :timeout, :validate => :number, :required => false, :default => 5
+
+  # Key expiry time
+  config :expiry, :validate => :number, :default => 1800
+
+  public
+  def register
+    require 'redis'
+    require 'json'
+    @redis = nil
+    @redis_url = "redis://#{@password}@#{@host}:#{@port}/#{@db}"
+  end # def register
+
+  public
+  def filter(event)
+    return unless filter?(event)
+
+    # Allow dynamic key names using fields etc
+    key = event.sprintf(@key)
+
+    relevant = [@store_tag, @retrieve_tag].select do |t|
+       event["tags"].include?(t)
+    end
+ 
+    @logger.debug(relevant)
+    return unless [] != relevant
+ 
+    # Do we retrieve data from a prior event?
+    # N.b. we retrieve before we store so that we can do both if we want!
+    # (e.g. packet sequence numbers? ...)
+    #
+    if event["tags"].include?(@retrieve_tag)
+      @logger.debug("Found retrieve tag %{retrieve_tag}")
+      @redis ||= connect
+      val = @redis.get(key)
+      if val != nil
+        @logger.debug("Found key in Redis")
+        JSON.parse(val).each do |k,v|
+          event[prefix + k] = v
+        end
+        if @delete
+          @redis.del(key) && @logger.debug("Deleted key")
+        end
+      else
+        @logger.debug("Key not found in Redis")
+      end
+    end
+    # Do we store data? 
+    if event["tags"].include?(@store_tag)
+      @logger.debug("Found store tag %{store_tag}")
+      val = event.to_hash().select { |name,value| fields.include?(name) }
+      @redis ||= connect
+      @redis.set(key, val.to_json) && @logger.debug("Stored key")
+      @redis.expire(key, @expiry) && @logger.debug("Set expiry key")
+    end
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+
+  private
+  def connect
+     Redis.new(
+       :host => @host,
+       :port => @port, 
+       :timeout => @timeout,
+       :db => db,
+       :password => @password.nil? ? nil : @password.value
+     )
+  end #def connect
+end # class LogStash::Filters::Redis

data/logstash-filter-redis.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-redis'
+  s.version = '0.1.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter allows the storage of event fields in a redis key to be retrieved by a later event"
+  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 = ["meulop"]
+  s.email = '[info@meulop.uk]'
+  s.homepage = "https://github.com/meulop/lostash-redis-filter"
+  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", '>= 1.4.0', '< 2.0.0'
+  s.add_development_dependency 'logstash-devutils'
+  s.add_runtime_dependency "redis", '>= 3.0.0', '< 4.0.0'
+end

data/spec/filters/redis_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+require "logstash/filters/redis"
+require "redis"
+require "pp"
+require "json"
+
+describe LogStash::Filters::Redis do
+  before(:all) do
+    @redis = Redis.new()
+  end
+
+  after(:each) do
+    sleep(0.2)
+    @redis.keys("logstash-filter-redis-test*").each do |k|
+      @redis.del(k)
+    end
+  end
+
+  describe "Ignores irrelevant tag" do
+    config <<-CONFIG
+      filter {
+        redis {
+          add_tag => "STORED"
+          store_tag => "BEGIN"
+          retrieve_tag => "END"
+          key => "logstash-filter-redis-test"
+        }
+      }
+    CONFIG
+
+    sample({"message" => "Test message", "tags" => ["APACHE"]}) do
+      insist { subject["tags"].include?("STORED") } == false
+      insist { @redis.get("logstash-filter-redis-test") } == nil
+    end
+
+  end
+
+  describe "Stores key and values" do
+    config <<-CONFIG
+      filter {
+        redis {
+          add_tag => "STORED"
+          store_tag => "BEGIN"
+	  retrieve_tag => "END"
+	  key => "logstash-filter-redis-test"
+        }
+      }
+    CONFIG
+
+    sample({"message" => "Storing message", "tags" => ["BEGIN"]}) do
+      # Did we add tag to the event?
+      insist { subject["tags"].include?("STORED") } == true
+      # Did the Redis value get set correctly?
+      @stored = @redis.get("logstash-filter-redis-test")
+      insist { JSON.parse(@stored)["message"] } == "Storing message"
+    end
+  end
+
+  describe "Retrieves the stored data" do
+    config <<-CONFIG
+    filter{
+      redis {
+        store_tag => "BEGIN"
+	retrieve_tag => "END"
+	key => "logstash-filter-redis-test"
+      }
+    }
+    CONFIG
+
+    eventstore = {
+      "message" => "Storing message",
+      "tags"    => ["BEGIN"]
+    }
+    eventretrieve = {
+      "message" => "Retrieving message",
+      "tags"    => ["END"]
+    }
+
+    sample([eventstore, eventretrieve]) do
+      insist{ subject[1]["old_message"] } == "Storing message"
+    end
+  end
+
+  describe "Handles overlapping sets of events" do
+    # Fill me in
+
+    config <<-CONFIG
+    filter {
+      redis {
+        store_tag => "BEGIN"
+	retrieve_tag => "END"
+	key => "logstash-filter-redis-test-%{message}"
+      }
+    }
+    CONFIG
+
+    eventsstore = []
+    eventsretrieve = []
+    5.times do |i|
+     eventsstore << {
+       "message" => i.to_s,
+       "tags"    => ["BEGIN"]
+     }
+     eventsretrieve << {
+       "message" => i.to_s,
+       "tags"    => ["END"]
+     }
+    end
+    eventsretrieve.shuffle!
+    sample(eventsstore + eventsretrieve) do
+      insist {
+        subject[5..9].select { |e| e["old_message"] == e["message"] }
+      } != []
+    end
+  end
+
+
+  describe "Deletes after retrieval" do
+    config <<-CONFIG
+      filter {
+        redis {
+	  store_tag      => "BEGIN"
+	  retrieve_tag   => "END"
+	  delete         => true
+	  key            => "logstash-filter-redis-test"
+	}
+      }
+    CONFIG
+    estore = { "message" => "Store", "tags" => ["BEGIN"] }
+    ereceive1 = { "message" => "Receive1", "tags" => ["END"] }
+    ereceive2 = { "message" => "Receive2", "tags" => ["END"] }
+
+    sample([estore,ereceive1,ereceive2]) do
+      insist { subject[1]["old_message"] } == "Store"
+      insist { subject[2]["old_message"] } == nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- meulop
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.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'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  name: redis
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.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@meulop.uk]"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/redis.rb
+- logstash-filter-redis.gemspec
+- spec/filters/redis_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/meulop/lostash-redis-filter
+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 allows the storage of event fields in a redis key to be retrieved by a later event
+test_files:
+- spec/filters/redis_spec.rb
+- spec/spec_helper.rb