fluent-plugin-eventcounter 0.0.3 → 0.0.4

data/README.md

@@ -35,7 +35,7 @@ With a conf like
 You would get
 
 ```
-event.counts { 12086: { 'seen': 2, 'liked': 1, 'clicked:http://example.com/12086': 1 } }
+event.counts { 12086: { 'seen': 2, 'liked': 1, 'clicked:http://example.com/promote': 2 } }
 event.counts { 1337: { 'seen': 1 } }
 ```
 
@@ -56,6 +56,8 @@ or
 
 ###Parameters
 
+#### Basic
+
 - **count_key** (**required**)
     - The key within the record to count unique instances of 
         - *eg. event*
@@ -71,6 +73,18 @@ or
 - **emit_to** (optional) - *string*
     - Tag to re-emit with 
         - *default: debug.events*
+
+#### Extra Capture (optional)
+
+- **capture_extra_if** (optional)
+    - An additional field to attach to the captured key 
+        - *default: nil*
+    
+- **capture_extra_replace** (optional)
+    - A regular expression to replace a portion of the extra capture. *(note: this is passed as a string and parsed as a regex so be aware that you may need to escape reserved characters to preserve their meaning.)*
+        - *default: ''*
+
+#### Redis Config (optional)
     
 - **redis_host** (optional) - *string*
     - Host address of the redis server 
@@ -92,13 +106,7 @@ or
     - The key to prefix against the tag 
         - *default: ''*
 
-- **capture_extra_if** (optional)
-    - An additional field to attach to the captured key 
-        - *default: nil*
-    
-- **capture_extra_replace** (optional)
-    - A regular expression to replace a portion of the extra capture 
-        - *default: ''*
+#### Other
 
 - **flush_interval** (optional)
     - Provided from **Fluent::BufferedOutput** time in seconds between flushes 

data/fluent-plugin-eventcounter.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name        = "fluent-plugin-eventcounter"
-  gem.version     = "0.0.3"
+  gem.version     = "0.0.4"
   gem.authors     = ["Sean Dick", "Change.org"]
   gem.email       = ["sean@change.org"]
   gem.homepage    = "https://github.com/change/fluent-plugin-eventcounter"

data/lib/fluent/plugin/out_eventcounter.rb

@@ -17,6 +17,7 @@ class Fluent::EventCounterOutput < Fluent::BufferedOutput
   config_param :input_tag_exclude, :string, :default => ''
   config_param :capture_extra_if, :string, :default => nil
   config_param :capture_extra_replace, :string, :default => ''
+  config_param :debug_emit, :boolean, :default => false
 
   config_param :count_key, :string # REQUIRED 
 
@@ -58,18 +59,18 @@ class Fluent::EventCounterOutput < Fluent::BufferedOutput
         counts[key][event] += 1 
       end
     end
-    if @emit_only
+    if @debug_emit || @emit_only
       counts.each do |tag, events|
         Fluent::Engine.emit(@emit_to, Time.now, tag => events)
       end
-    else
-      @redis.pipelined do
-        counts.each do |tag,events|
-          events.each do |event, c|
-            redis_key = [@redis_output_key,tag].join(':')
-            @redis.hincrby(redis_key, event, c.to_i)
-          end        
-        end
+      return if @emit_only
+    end
+    @redis.pipelined do
+      counts.each do |tag,events|
+        events.each do |event, c|
+          redis_key = [@redis_output_key,tag].join(':')
+          @redis.hincrby(redis_key, event, c.to_i)
+        end        
       end
     end
   end

data/spec/out_eventcounter_spec.rb

@@ -75,4 +75,36 @@ describe Fluent::EventCounterOutput do
       end
     end
   end
+
+  describe 'output' do
+    let (:conf) {
+      %[
+        count_key event
+        capture_extra_if url
+        capture_extra_replace \\?.*$
+        emit_only true
+      ]
+    }
+    let (:input) {
+      %[{"email": "john.doe@example.com", "timestamp": "1337197600", "smtp-id": "<4FB4041F.6080505@example.com>", "event": "processed", "local_record_id": "11"}
+        {"email": "john.doe@example.com", "timestamp": "1337966815", "category": "newuser", "event": "click", "url": "http://example.com?foo=bar&baz=quux", "local_record_id": "72"}
+        {"email": "john.doe@example.com", "timestamp": "1337969592", "smtp-id": "<20120525181309.C1A9B40405B3@Example-Mac.local>", "event": "processed", "local_record_id": "72"}
+        {"email": "john.doe@example.com", "timestamp": "1337197600", "smtp-id": "<4FB4041F.6080505@example.com>", "event": "processed", "local_record_id": "72"}
+        {"email": "john.doe@example.com", "timestamp": "1337966815", "category": "newuser", "event": "click", "url": "http://example.com?blop=spop", "local_record_id": "72"}
+        {"email": "john.doe@example.com", "timestamp": "1337969592", "smtp-id": "<20120525181309.C1A9B40405B3@Example-Mac.local>", "event": "processed", "local_record_id": "72"}]
+    }
+    let (:eventcounter) { Fluent::Test::BufferedOutputTestDriver.new(Fluent::EventCounterOutput.new).configure(conf) }
+
+    it "formats the counts against the provided tag" do
+      eventcounter.tag = 'test'
+      input.split("\n").each do |line|
+        data = JSON.parse line
+        eventcounter.emit data, Time.now 
+      end
+      output = eventcounter.run['test']
+
+      expect(output['processed']).to eq 4
+      expect(output['click:http://example.com']).to eq 2
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-eventcounter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-17 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd