fluent-plugin-eventcounter 0.0.2 → 0.0.3

data/README.md

@@ -1,12 +1,49 @@
 fluent-plugin-eventcounter
 ==========================
 
-This plugin is designed to count occurrences of unique values in a specified key and pass them through as counts either as a re-emit or by directly incrementing a specified redis hash.
+This plugin is designed to count occurrences of unique values in a specified key and pass them through as counts either as a re-emit or by directly incrementing a specified redis hash. As it's a buffered plugin it will write or re-emit at a (tunable) sane pace.
 
-Installation
-------------
+##Example
 
-OSX/fluentd
+Given a set of input like
+
+```
+important.thing.12086 { 'time': 1413544800, 'event': 'seen', 'user_id': 12345 }
+important.thing.1337 { 'time': 1413544890, 'event': 'seen', 'user_id': 1337 }
+important.thing.12086 { 'time': 1413544830, 'event': 'liked', 'user_id': 33864 }
+important.thing.12086 { 'time': 1413544860, 'event': 'clicked', 'user_id': 12345, url: 'http://example.com/promote?someParam=something' }
+important.thing.12086 { 'time': 1413544890, 'event': 'seen', 'user_id': 40555 }
+important.thing.12086 { 'time': 1413544860, 'event': 'clicked', 'user_id': 12345, url: 'http://example.com/promote?someParam=somethingElse' }
+```
+
+With a conf like
+
+```
+<match important.thing.*>
+    type eventcounter
+    count_key event
+    input_tag_exclude important.thing.
+
+    capture_extra_if url
+    capture_extra_replace \?.*$
+
+    emit_only true
+    emit_tag event.counts
+</match>
+```
+
+You would get
+
+```
+event.counts { 12086: { 'seen': 2, 'liked': 1, 'clicked:http://example.com/12086': 1 } }
+event.counts { 1337: { 'seen': 1 } }
+```
+
+If the plugin is not set to emit only, and redis is properly configured each of those counts increment a key in a hash specified by `redis_output_key`:`tag` `count_key`
+
+##Installation
+
+OSX
 
     /opt/td-agent/embedded/bin/gem install fluent-plugin-eventcounter
 
@@ -15,8 +52,57 @@ or
     fluent-gem install fluent-plugin-eventcounter
 
 
-Configuration
--------------
+##Configuration
+
+###Parameters
+
+- **count_key** (**required**)
+    - The key within the record to count unique instances of 
+        - *eg. event*
+
+- **input_tag_exclude** (optional)
+    - A pattern to exclude from the incoming tag 
+        - *default: ''*
+
+- **emit_only** (optional) - *boolean*
+    - Skip redis and re-emit using emit_to 
+        - *default: false*
+    
+- **emit_to** (optional) - *string*
+    - Tag to re-emit with 
+        - *default: debug.events*
+    
+- **redis_host** (optional) - *string*
+    - Host address of the redis server 
+        - *default: localhost*
+    
+- **redis_port** (optional)
+    - Port of the redis server 
+        - *default: 6379*
+    
+- **redis_password** (optional)
+    - Password for the redis server 
+        - *default: nil*
+    
+- **redis_db_number** (optional)
+    - Redis DB 
+        - *default: 0*
+
+- **redis_output_key** (optional)
+    - 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: ''*
+
+- **flush_interval** (optional)
+    - Provided from **Fluent::BufferedOutput** time in seconds between flushes 
+        - *default: 60*
+
 
   
-    

data/fluent-plugin-eventcounter.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name        = "fluent-plugin-eventcounter"
-  gem.version     = "0.0.2"
+  gem.version     = "0.0.3"
   gem.authors     = ["Sean Dick", "Change.org"]
   gem.email       = ["sean@change.org"]
-  gem.homepage    = "https://github.com/seanmdick/fluent-plugin-eventcounter"
+  gem.homepage    = "https://github.com/change/fluent-plugin-eventcounter"
   gem.summary     = %q{Fluentd plugin to count occurences of values in a field and emit them or write them to redis}
   gem.description = %q{Fluentd plugin to count occurences of values in a field and emit them or write them to redis}
   gem.license     = "MIT"

data/lib/fluent/plugin/out_eventcounter.rb

@@ -18,8 +18,7 @@ class Fluent::EventCounterOutput < Fluent::BufferedOutput
   config_param :capture_extra_if, :string, :default => nil
   config_param :capture_extra_replace, :string, :default => ''
 
-  config_param :count_key, :string
-  config_param :flush_interval, :time, :default => 10
+  config_param :count_key, :string # REQUIRED 
 
   attr_accessor :counts
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-eventcounter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2014-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -108,7 +108,7 @@ files:
 - lib/fluent/plugin/out_eventcounter.rb
 - spec/out_eventcounter_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/seanmdick/fluent-plugin-eventcounter
+homepage: https://github.com/change/fluent-plugin-eventcounter
 licenses:
 - MIT
 post_install_message: