logstash-filter-throttle-prop 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45eb9268eec8e9bbd40160f0d72ef041bc3d9235
-  data.tar.gz: 7416e52a7ab4204abbd5820f5d07d6f3938551dd
+  metadata.gz: 29356acbb0d2242d095bd5bbacce2145b7bd817e
+  data.tar.gz: 373bcaeda86e835f4c02ae0dfe04838b6596bdf3
 SHA512:
-  metadata.gz: 480a1a875de4876c32ff91265e2f7a8266eb278c96e91a3b89bc10d4731962cd123644ed12255b2391beaa7d4069ee7876cca2893cd4302aed64698f043ab6dd
-  data.tar.gz: ca7d3c51eef613020c117fbfa2cb936ae19b3eed8b3057e3ad6b0f75f47532a7785dbfacb1da34ad75ce58bfa5196ea3156f4cae65a6e6c169c31acdef24bd87
+  metadata.gz: db1c34dfa73e8c858404348ba8b0ef3b9e839ddeae6e6ff1700227bdcfc92ec9be9138a1fb8e305bd51a02ce8d75d4d47eb7ba3adbbc672bbc41b3cd3e7e44bf
+  data.tar.gz: 2e32b8288633c6098edf41fa6d99d8bc6870d3217017945acc8bc7c5b67fdf1ef00633e0f30366229d94b6194b5fd1bfc0489ce3b85c0b7b660c22968ac25b32

data/CONTRIBUTORS

@@ -2,7 +2,7 @@ The following is a list of people who have contributed ideas, code, bug
 reports, or in general have helped logstash along its way.
 
 Contributors:
-* your_username - your_username@example.com
+* jeanpinzon - jean.pinzon1@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

data/lib/logstash/filters/throttle_prop.rb

@@ -14,22 +14,23 @@ require "logstash/namespace"
 # you would use the configuration:
 #
 # [source, ruby]
-#     key => "fixed_key"
+#     key => "%{property_key}"
 #     value => "%{type}"
 #     limit => 2
 #
 # Which would result in:
 # ==========================
-#     event 1  { type => 'a' } - not throttled
-#     event 2  { type => 'a' } - not throttled
-#     event 3  { type => 'b' } - not throttled
-#     event 4  { type => 'b' } - not throttled
-#     event 5  { type => 'c' } - throttled (successful filter)
-#     event 6  { type => 'c' } - throttled (successful filter)
-#     event 7  { type => 'a' } - not throttled
-#     event 8  { type => 'b' } - not throttled
-#     event 9  { type => 'c' } - throttled (successful filter)
-#     event 10 { type => 'd' } - throttled (successful filter)
+#     event 1  { property_key => 'some_key', type => 'a' } - not throttled
+#     event 2  { property_key => 'some_key', type => 'a' } - not throttled
+#     event 3  { property_key => 'some_key', type => 'b' } - not throttled
+#     event 4  { property_key => 'some_key', type => 'b' } - not throttled
+#     event 5  { property_key => 'some_key', type => 'c' } - throttled (successful filter)
+#     event 6  { property_key => 'some_key', type => 'c' } - throttled (successful filter)
+#     event 7  { property_key => 'some_key', type => 'a' } - not throttled
+#     event 8  { property_key => 'some_key', type => 'b' } - not throttled
+#     event 9  { property_key => 'some_key', type => 'c' } - throttled (successful filter)
+#     event 10 { property_key => 'some_key', type => 'd' } - throttled (successful filter)
+#     event 11  { property_key => 'other_key', type => 'd' } - not throttled
 
 class LogStash::Filters::ThrottleProp < LogStash::Filters::Base
 
@@ -48,20 +49,20 @@ class LogStash::Filters::ThrottleProp < LogStash::Filters::Base
 
   public
   def filter(event)
-    key = event.sprintf(@key)
-    value = event.sprintf(@value)
-    limit = event.sprintf(@limit).to_i
+    event_key = event.sprintf(@key)
+    event_value = event.sprintf(@value)
+    event_limit = event.sprintf(@limit).to_i
 
-    if @keys.has_key? @key
-      unless @keys[@key].include? value
-        if @keys[@key].length + 1 > limit
+    if @keys.has_key? event_key
+      unless @keys[event_key].include? event_value
+        if @keys[event_key].length + 1 > event_limit
           filter_matched(event)
         else
-          @keys[@key].push(value)
+          @keys[event_key].push(event_value)
         end
       end
     else
-      @keys[@key] = [value]
+      @keys[event_key] = [event_value]
     end
 
   end # def filter

data/logstash-filter-throttle-prop.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-throttle-prop'
-  s.version       = '0.1.2'
+  s.version       = '0.1.3'
   s.licenses      = ['Apache License (2.0)']
   s.description   = 'A logstash filter plugin to throttle events per properties'
-  s.summary       = 'Filter to throttle events per properties'
+  s.summary       = s.description
   s.homepage      = 'https://github.com/JeanPinzon/logstash-filter-throttle-prop'
   s.authors       = ['jeanpinzon']
   s.email         = 'jean.pinzon1@gmail.com'

data/spec/filters/throttle_prop_spec.rb

@@ -7,8 +7,8 @@ describe LogStash::Filters::ThrottleProp do
   let(:config) do <<-CONFIG
     filter {
       throttle_prop {
-        key => "test"
-        value => "%{property}"
+        key => "%{property_key}"
+        value => "%{property_value}"
         limit => 2
         add_tag => [ "throttled" ]
       }
@@ -18,76 +18,113 @@ describe LogStash::Filters::ThrottleProp do
 
   describe "Throttling per property" do
     events = [{
-      "property" => "a"
+      "property_key" => "some_key",
+      "property_value" => "a"
     }, {
-      "property" => "b"
+      "property_key" => "some_key",
+      "property_value" => "b"
     }, {
-      "property" => "c"
+      "property_key" => "some_key",
+      "property_value" => "c"
     }]
 
     sample events do
-      expect(subject[0].get("property")).to eq('a')
-      expect(subject[1].get("property")).to eq('b')
-      expect(subject[2].get("property")).to eq('c')
+      expect(subject[0].get("property_value")).to eq('a')
+      expect(subject[1].get("property_value")).to eq('b')
+      expect(subject[2].get("property_value")).to eq('c')
       expect(subject[2].get("tags")).to eq([ "throttled" ])
     end
   end
 
   describe "Don't throttling equal properties" do
     events = [{
-      "property" => "a"
+      "property_key" => "some_key",
+      "property_value" => "a"
     }, {
-      "property" => "a"
+      "property_key" => "some_key",
+      "property_value" => "a"
     }, {
-      "property" => "a"
+      "property_key" => "some_key",
+      "property_value" => "a"
     }]
 
     sample events do
-      expect(subject[0].get("property")).to eq('a')
-      expect(subject[1].get("property")).to eq('a')
-      expect(subject[2].get("property")).to eq('a')
+      expect(subject[0].get("property_value")).to eq('a')
+      expect(subject[1].get("property_value")).to eq('a')
+      expect(subject[2].get("property_value")).to eq('a')
       expect(subject[2].get("tags")).to eq(nil)
     end
   end
 
   describe "Don't throttling equal properties and throttling differents" do
     events = [{
-      "property" => "a"
+      "property_key" => "some_key",
+      "property_value" => "a"
     }, {
-      "property" => "a"
+      "property_key" => "some_key",
+      "property_value" => "a"
     }, {
-      "property" => "b"
+      "property_key" => "some_key",
+      "property_value" => "b"
     }, {
-      "property" => "b"
+      "property_key" => "some_key",
+      "property_value" => "b"
     }, {
-      "property" => "c"
+      "property_key" => "some_key",
+      "property_value" => "c"
     }, {
-      "property" => "c"
+      "property_key" => "some_key",
+      "property_value" => "c"
     }, {
-      "property" => "a"
+      "property_key" => "some_key",
+      "property_value" => "a"
     }, {
-      "property" => "b"
+      "property_key" => "some_key",
+      "property_value" => "b"
     }, {
-      "property" => "c"
+      "property_key" => "some_key",
+      "property_value" => "c"
     }, {
-      "property" => "d"
+      "property_key" => "some_key",
+      "property_value" => "d"
+    }, {
+      "property_key" => "other_key",
+      "property_value" => "d"
     }]
 
     sample events do
-      expect(subject[0].get("property")).to eq('a')
-      expect(subject[1].get("property")).to eq('a')
-      expect(subject[2].get("property")).to eq('b')
-      expect(subject[3].get("property")).to eq('b')
-      expect(subject[4].get("property")).to eq('c')
-      expect(subject[5].get("property")).to eq('c')
+      expect(subject[0].get("property_value")).to eq('a')
+      expect(subject[0].get("tags")).to eq(nil)
+
+      expect(subject[1].get("property_value")).to eq('a')
+      expect(subject[1].get("tags")).to eq(nil)
+
+      expect(subject[2].get("property_value")).to eq('b')
+      expect(subject[2].get("tags")).to eq(nil)
+
+      expect(subject[3].get("property_value")).to eq('b')
+      expect(subject[3].get("tags")).to eq(nil)
+
+      expect(subject[4].get("property_value")).to eq('c')
       expect(subject[4].get("tags")).to eq([ "throttled" ])
+
+      expect(subject[5].get("property_value")).to eq('c')
       expect(subject[5].get("tags")).to eq([ "throttled" ])
-      expect(subject[6].get("property")).to eq('a')
-      expect(subject[7].get("property")).to eq('b')
-      expect(subject[8].get("property")).to eq('c')
+
+      expect(subject[6].get("property_value")).to eq('a')
+      expect(subject[6].get("tags")).to eq(nil)
+
+      expect(subject[7].get("property_value")).to eq('b')
+      expect(subject[7].get("tags")).to eq(nil)
+
+      expect(subject[8].get("property_value")).to eq('c')
       expect(subject[8].get("tags")).to eq([ "throttled" ])
-      expect(subject[9].get("property")).to eq('d')
+
+      expect(subject[9].get("property_value")).to eq('d')
       expect(subject[9].get("tags")).to eq([ "throttled" ])
+
+      expect(subject[10].get("property_value")).to eq('d')
+      expect(subject[10].get("tags")).to eq(nil)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-throttle-prop
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - jeanpinzon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,7 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key:
 specification_version: 4
-summary: Filter to throttle events per properties
+summary: A logstash filter plugin to throttle events per properties
 test_files:
 - spec/filters/throttle_prop_spec.rb
 - spec/spec_helper.rb