logstash-filter-rediss 0.3.5 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e73636b9648b878f1d962d5fe80287c306c9ca68cfb4611ffc18789712a36c9
-  data.tar.gz: cc85150046052b65002092f9000997065056290d68159030cdd0be58ce48c93f
+  metadata.gz: 300e9f93677fcf02905c91573ab605abcee5760a600d30d6cb7dddf83ca655be
+  data.tar.gz: a1034196a4ddeb9b22c3d2ee2def4cb5145a7ef1864917964a74a8393098ffbe
 SHA512:
-  metadata.gz: 85774259a88a2df9e31439a077d22c590b2a3d87533056637368d626a198dfefeacce1dd2dda1cc23f31ed85fb8b2b427f51ccec8ba38d3bb057074d25aac018
-  data.tar.gz: c0ad14407e0736b3b768a01ae7cdbbcd293dddb3f4048023802c6dea3be459d446a81247c72cbb5e030fa79450d1586518c294fc0917ecc6afa12027a7becb83
+  metadata.gz: '0313399da64d527725b273f983c369a438815044776a54617476ec678d7058b18ded2c459a9e0372cccb0ceac353a2eec906bab7c1406bd0a7a46ede443d36aa'
+  data.tar.gz: ea8144cdf41d8fcfd8da4f87d849043d007ac7d783e8a2dd5877846e34849f56126d8a98bb6f335a454932a9a1d06d3181eaba456e7f52576755a4e57385e20d

data/CHANGELOG.md

@@ -1,19 +1,9 @@
-## 0.3.2
- - Introduce redis command `sismember`
-
-## 0.3.1
- - Prevent infinite loops for retries after errors or failed lock acquisitions
+## 1.0.2
+ - Support for GET, HGET, SET, HSET, SETEX, EXISTS, DEL, SADD, SMEMBERS, SISMEMBER and SCARD;
+ - Support SSL (redis or rediss protocol);
+ - Support TTL (when you uses SETEX);
+ - Introduce new control field `cmd_key_is_formatted` for declaring commands
+   to be resolved through - see %{foo} handling;
  - Introduce optional configuration options for controlling the count and
    the interval of retries - see :max_retries, :lock_retry_interval and
-   :max_lock_retries
-
-## 0.3.0
- - Support for GET, SET, EXISTS, DEL, SADD, SMEMBERS and SCARD
- - Introduce new control field `cmd_key_is_formatted` for declaring commands
-   to be resolved through - see %{foo} handling
-
-## 0.2.0
- - Support for HSET and HGET
-
-## 0.1.0
- - Initial version; simple caching with redis
+   :max_lock_retries;

data/CONTRIBUTORS

@@ -1,10 +1,4 @@
-The following is a list of people who have contributed ideas, code, bug
-reports, or in general have helped logstash-filter-cache-redis along its way.
-
 Contributors:
+* Thiago Barradas (ThiagoBarradas)
+* Bruno Sales (bruno-sales)
 * David Robakowski (drobakowski)
-
-Note: If you've sent us patches, bug reports, or otherwise contributed to
-logstash-filter-cache-redis, 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/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016, Synlay Technologies UG & Co. KG.
+Copyright (c) 2019, Thiago Barradas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,23 +1,61 @@
-# Logstash Filter Redis Cache Plugin
+# Logstash Filter Rediss Plugin
 
-[![Build Status](https://travis-ci.org/synlay/logstash-filter-cache-redis.svg)](https://travis-ci.org/synlay/logstash-filter-cache-redis)
-[![Coverage Status](https://coveralls.io/repos/github/synlay/logstash-filter-cache-redis/badge.svg?branch=master)](https://coveralls.io/github/synlay/logstash-filter-cache-redis?branch=master)
-[![Gem Version](https://badge.fury.io/rb/logstash-filter-cache-redis.svg)](https://badge.fury.io/rb/logstash-filter-cache-redis)
-[![GitHub license](https://img.shields.io/github/license/synlay/logstash-filter-cache-redis.svg)](https://github.com/synlay/logstash-filter-cache-redis)
+[![Build Status](https://travis-ci.org/thiagobarradas/logstash-filter-rediss.svg)](https://travis-ci.org/thiagobarradas/logstash-filter-rediss)
+[![Gem Version](https://badge.fury.io/rb/logstash-filter-rediss.svg)](https://badge.fury.io/rb/logstash-filter-rediss)
+[![GitHub license](https://img.shields.io/github/license/thiagobarradas/logstash-filter-rediss.svg)](https://github.com/thiagobarradas/logstash-filter-rediss)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
-It is fully free and fully open source. The license is MIT, see [LICENSE](http://github.com/synlay/logstash-filter-cache-redis/LICENSE) for further infos.
+It is fully free and fully open source. The license is MIT, see [LICENSE](http://github.com/thiagobarradas/logstash-filter-rediss/LICENSE) for further infos.
 
 ## Documentation
 
-This filter will store and retrieve data from Redis data cache. The fields `source` and `target` are used alternatively as data in- or output fields, while the value of a defined command like `rpush` will look for the corresponding event and use that value as the key. The following example for instance will store data from the event `ProductEntity` under the key based upon the data from the event `ProductId`:
+Actions allowed:
+- `get` - Get cache with key in :get and set value in :target
+- `set` - Set cache with key in :set and value from :source
+- `setex` - Set cache with key in :setex, considering TTL from :ttl (in seconds) and value from :source
+- `exists` - Checks if key :exists exists and save result in :target
+- `del` - Deletes cache with key :del
+- `llen` - Get length of a list with key :llen and save result in :target
+- `rpush` - Appends a value :source in a list with key :rpush
+- `rpushnx` - Appends a value :source in a list with key :rpush only with key not exists. This operation uses red lock;
+- `hset` - Set hash with key in :hset, field from : field and value from :source
+- `hget` - Get a value into :target from a hash field with :hget key
+- `sadd` - Adds one or more members from :sadd to a set :source
+- `sismember` - Determine if a :source value is a member of a set :sismember and save in :target
+- `smembers` - Get all members from :smembers key and put in :target
+- `scard` - Get number of members of set :scard and put in :target
+- `rpop` - Removes and get last element from list :rpop and save in :target
+- `lpop` - Removes and get first element from list :lpop and save in :target
+- `lget` Get all elements from a list :lget and save in :target
+
+Get Sample:
+
+```ruby
+filter {
+    rediss {
+        host => "redis.company.com"
+        port => 6379
+        db => 0
+        password => "authtoken"
+        get => "[data][id]"
+        target => "[data][result]"
+    }
+}
+```
+
+Set with TTL Sample:
 
 ```ruby
 filter {
-    cache_redis {
-        rpush => "ProductId"
-        source => "ProductEntity"
+    rediss {
+        host => "redis.company.com"
+        port => 6379
+        db => 0
+        password => "authtoken"
+		ttl => 300
+        setex => "[data][id]"
+        source => "[data][content]"
     }
 }
 ```

data/lib/logstash/filters/rediss.rb

@@ -8,20 +8,19 @@ class LogStash::Filters::Rediss < LogStash::Filters::Base
     config_name "rediss"
 
     # The field to perform filter
-    #
     config :source, :validate => :string, :default => "message"
 
     # The name of the container to put the result
-    #
     config :target, :validate => :string, :default => "message"
 
+    # The field to use in hset
     config :field, :validate => :string
 
-    # Expire time in seconds
+    # Expire time in seconds for setex
     config :ttl => :number
 
     # Informs if the connection is to be made with SSL or not
-    config :ssl => :boolean
+    config :ssl, :validate => :boolean, :default => false
 
     # For now only working for rpushnx and llen!
     config :cmd_key_is_formatted, :validate => :boolean, :default => false
@@ -62,62 +61,83 @@ class LogStash::Filters::Rediss < LogStash::Filters::Base
     # Interval for retrying to acquire a lock
     config :lock_retry_interval, :validate => :number, :default => 1
 
+    # config :get, :validate => :boolean, :default => false
+    config :lock_timeout, :validate => :number, :default => 5000
+
     # Maximal count of retries to acquire a lock
     config :max_lock_retries, :validate => :number, :default => 3
 
+    ################# ACTIONS
+
+    # Sets the action. If has value, this action will be executed
+    # GET: get cache with key in :get and set value in :target
     config :get, :validate => :string
 
+    # Sets the action. If has value, this action will be executed
+    # SET: set cache with key in :set and value from :source
     config :set, :validate => :string
 
+    # Sets the action. If has value, this action will be executed
+    # SETEX: set cache with key in :setex, considering TTL from :ttl (in seconds) and value from :source
     config :setex, :validate => :string
 
+    # Sets the action. If has value, this action will be executed
+    # EXISTS: perform exists operation in :exists key and save result in :target
     config :exists, :validate => :string
 
+    # Sets the action. If has value, this action will be executed
+    # DEL: deletes cache with key :del
     config :del, :validate => :string
 
-    # # Sets the action. If set to true, it will get the data from redis cache
-    # config :get, :validate => :boolean, :default => false
+    # Sets the action. If has value, this action will be executed
+    # LLEN: get length of a list with key :llen and save result in :target
     config :llen, :validate => :string
 
-    # # Sets the action. If set to true, it will get the data from redis cache
-    # config :get, :validate => :boolean, :default => false
+    # Sets the action. If has value, this action will be executed
+    # RPUSH: aapend value :source in a list with key :rpush
     config :rpush, :validate => :string
 
-    # # Sets the action. If set to true, it will get the data from redis cache
-    # config :get, :validate => :boolean, :default => false
+    # Sets the action. If has value, this action will be executed
+    # RPUSHNX: aapend value :source in a list with key :rpush only with key not exists
+    # This operation uses red lock;
     config :rpushnx, :validate => :string
 
-    # Sets the action. If set to true, it will get the data from redis cache
+    # Sets the action. If has value, this action will be executed
+    # HSET: set hash with key in :hset, field from : field and value from :source
     config :hset, :validate => :string
 
-    # Sets the action. If set to true, it will get the data from redis cache
+    # Sets the action. If has value, this action will be executed
+    # HGET: get a value into :target from a hash field with :hget key
     config :hget, :validate => :string
 
+    # Sets the action. If has value, this action will be executed
+    # SADD: add one or more members from :sadd to a set :source
     config :sadd, :validate => :string
 
+    # Sets the action. If has value, this action will be executed
+    # SISMEMBER: Determine if a :source value is a member of a set :sismember and save in :target
     config :sismember, :validate => :string
 
+    # Sets the action. If has value, this action will be executed
+    # SMEMBERS: Get all members from :smembers key and put in :target
     config :smembers, :validate => :string
 
+    # Sets the action. If has value, this action will be executed
+    # SCARD: Get number of members of set :scard and put in :target
     config :scard, :validate => :string
 
-    # config :get, :validate => :boolean, :default => false
-    config :lock_timeout, :validate => :number, :default => 5000
-
-    # # Sets the action. If set to true, it will get the data from redis cache
-    # config :get, :validate => :boolean, :default => false
+    # Sets the action. If has value, this action will be executed
+    # RPOP: Remove and get last element from list :rpop and save in :target
     config :rpop, :validate => :string
 
-    # # Sets the action. If set to true, it will get the data from redis cache
-    # config :get, :validate => :boolean, :default => false
+    # Sets the action. If has value, this action will be executed
+    # LPOP: Remove and get first element from list :lpop and save in :target
     config :lpop, :validate => :string
 
-    # # Sets the action. If set to true, it will get the data from redis cache
-    # config :get, :validate => :boolean, :default => false
-    # O(N)
+    # Sets the action. If has value, this action will be executed
+    # LGET: Get all elements from a list :lget and save in :target
     config :lget, :validate => :string
 
-
     public
     def register
         @redis = nil
@@ -128,7 +148,6 @@ class LogStash::Filters::Rediss < LogStash::Filters::Base
         @host_idx = 0
     end # def register
 
-
     def filter(event)
 
         # TODO: Maybe refactor the interface into a more flexible one with two
@@ -153,7 +172,7 @@ class LogStash::Filters::Rediss < LogStash::Filters::Base
             end
 
             if @exists
-                @redis.exists(event.get(@exists))
+                event.set(@target, @redis.exists(event.get(@exists)))
             end
 
             if @del
@@ -177,7 +196,7 @@ class LogStash::Filters::Rediss < LogStash::Filters::Base
             end
 
             if @smembers
-                @redis.smembers(event.get(@smembers))
+                event.set(@target, @redis.smembers(event.get(@smembers)))
             end
 
             if @scard
@@ -242,7 +261,6 @@ class LogStash::Filters::Rediss < LogStash::Filters::Base
         filter_matched(event)
     end # def filter
 
-
     private
     def connect
         @current_host, @current_port = @host[@host_idx].split(':')
@@ -260,7 +278,7 @@ class LogStash::Filters::Rediss < LogStash::Filters::Base
             :ssl => @ssl
         }
 
-        @logger.debug("connection params", params)
+        @logger.debug("Connection params", params)
 
         if @password
             params[:password] = @password.value
@@ -279,6 +297,6 @@ class LogStash::Filters::Rediss < LogStash::Filters::Base
         @logger.debug("lock_manager hosts", hosts)
 
         Redlock::Client.new(hosts)
-    end # def connect
+    end # def connect_lockmanager
 
-end # class LogStash::Filters::Example
+end # class LogStash::Filters::Rediss

data/logstash-filter-rediss.gemspec

@@ -1,18 +1,19 @@
 Gem::Specification.new do |s|
-  s.name = 'logstash-filter-rediss'
-  s.version         = '0.3.5'
+  s.name            = 'logstash-filter-rediss'
+  s.version         = '1.0.2'
   s.licenses        = ['MIT']
-  s.summary         = "Redis Cache Filter for Logstash"
+  s.summary         = "Redis (with SSL) Filter for Logstash"
   s.description     = "A Logstash filter plugin for storing and retrieving data from redis cache. This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gem_name. This gem is not a stand-alone program."
-  s.authors         = ["David Robakowski"]
-  s.email           = 'david.robakowski@synlay.com'
-  s.homepage        = "https://github.com/bruno-sales/logstash-filter-cache-redis"
-  s.require_paths = ["lib"]
-  s.platform = Gem::Platform::JAVA if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+  s.authors         = ["Thiago Barradas", "Bruno Sales", "David Robakowski"]
+  s.email           = 'th.barradas@gmail.com'
+  s.homepage        = "https://github.com/thiagobarradas/logstash-filter-rediss"
+  s.require_paths   = ["lib"]
+  s.platform        = Gem::Platform::JAVA if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
 
   # Files
   s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE']
-   # Tests
+   
+  # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
   # Special flag to let us know this is actually a logstash plugin

metadata

@@ -1,9 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-rediss
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 1.0.2
 platform: ruby
 authors:
+- Thiago Barradas
+- Bruno Sales
 - David Robakowski
 autorequire: 
 bindir: bin
@@ -82,7 +84,7 @@ description: A Logstash filter plugin for storing and retrieving data from redis
   This gem is a Logstash plugin required to be installed on top of the Logstash core
   pipeline using $LS_HOME/bin/logstash-plugin install gem_name. This gem is not a
   stand-alone program.
-email: david.robakowski@synlay.com
+email: th.barradas@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -94,7 +96,7 @@ files:
 - README.md
 - lib/logstash/filters/rediss.rb
 - logstash-filter-rediss.gemspec
-homepage: https://github.com/bruno-sales/logstash-filter-cache-redis
+homepage: https://github.com/thiagobarradas/logstash-filter-rediss
 licenses:
 - MIT
 metadata:
@@ -119,5 +121,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Redis Cache Filter for Logstash
+summary: Redis (with SSL) Filter for Logstash
 test_files: []