fluent-plugin-eventcounter 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+.ruby-version
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Sean Dick and Change.org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+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.
+
+Installation
+------------
+
+OSX/fluentd
+
+    /opt/td-agent/embedded/bin/gem install fluent-plugin-eventcounter
+
+or
+
+    fluent-gem install fluent-plugin-eventcounter
+
+
+Configuration
+-------------
+
+  
+    

data/fluent-plugin-eventcounter.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-eventcounter"
+  gem.version     = "0.0.1"
+  gem.authors     = ["Sean Dick", "Change.org"]
+  gem.email       = ["sean@change.org"]
+  gem.homepage    = "https://github.com/seanmdick/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"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "redis"
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/fluent/plugin/out_eventcounter.rb

@@ -0,0 +1,79 @@
+class Fluent::EventCounterOutput < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('eventcounter', self)
+  def initialize
+    super
+    require 'redis'
+  end
+
+  config_param :emit_only, :bool, :default => false
+  config_param :emit_to, :string, :default => 'debug.events'
+
+  config_param :redis_host, :string, :default => 'localhost'
+  config_param :redis_port, :integer, :default => 6379
+  config_param :redis_password, :string, :default => nil
+  config_param :redis_db_number, :integer, :default => 0
+  config_param :redis_output_key, :string, :default => ''
+
+  config_param :input_tag_exclude, :string, :default => ''
+  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
+
+  attr_accessor :counts
+
+  def configure(conf)
+    super
+    @capture_extra_replace = Regexp.new(@capture_extra_replace) if @capture_extra_replace.length > 0
+  end
+
+  def start
+    super
+    @redis = Redis.new(
+        host: @redis_host,
+        port: @redis_port,
+        password: @redis_password,
+        thread_safe: true,
+        db: @redis_db_number
+      ) unless @emit_only
+  end
+
+  def format(tag, time, record)
+    return '' unless record[@count_key]
+
+    if @capture_extra_if && record[@capture_extra_if]
+      extra = record[@capture_extra_if].gsub(@capture_extra_replace, '')
+      [tag.gsub(@input_tag_exclude,""), [record[@count_key], extra].compact.join(':')].to_json + "\n"
+    else
+      [tag.gsub(@input_tag_exclude,""), record[@count_key]].to_json + "\n"
+    end
+  end
+
+  def write(chunk)
+    counts = Hash.new {|hash, key| hash[key] = Hash.new {|h,k| h[k] = 0 } }
+    chunk.open do |io|
+      items = io.read.split("\n")
+      items.each do |item|
+        key, event = JSON.parse(item)
+        counts[key][event] += 1 
+      end
+    end
+    if @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(':')
+            Fluent::Engine.emit(@emit_to, Time.now, redis_key => { event => c})
+            @redis.hincrby(redis_key, event, c.to_i)
+          end        
+        end
+      end
+    end
+  end
+
+end

data/spec/out_eventcounter_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Fluent::EventCounterOutput do
+  before { Fluent::Test.setup }
+  
+
+  describe '#format' do
+    context 'no capture extra is set' do
+      let (:conf) {
+        %[
+          count_key event
+        ]
+      }
+      let (:eventcounter) { Fluent::Test::BufferedOutputTestDriver.new(Fluent::EventCounterOutput.new).configure(conf) }
+      context 'the input contains the count key' do
+        it 'produces the expected output' do
+          eventcounter.tag = 'something'
+          eventcounter.emit( { 'event' => 'the_event'}, Time.now )
+          eventcounter.expect_format ['something', 'the_event'].to_json + "\n"
+          eventcounter.run
+        end
+      end
+
+      context 'the input does not contain the count key' do
+        it 'does not add it to the buffer' do
+          eventcounter.tag = 'something'
+          eventcounter.emit( { 'not_an_event' => 'the_event'}, Time.now )
+          eventcounter.expect_format ''
+          eventcounter.run
+        end
+      end
+    end
+    context 'capture_extra_if is set' do
+      let (:conf) {
+        %[
+          count_key event
+          capture_extra_if url
+        ]
+      }
+      
+      let (:eventcounter) { Fluent::Test::BufferedOutputTestDriver.new(Fluent::EventCounterOutput.new).configure(conf) }
+
+      context 'the provided data contains the capture extra' do
+        it 'captures the count_key:capture_extra' do
+          eventcounter.tag = 'something'
+          eventcounter.emit( { 'event' => 'the_event', 'url' => 'http://www.example.com?someparam=somethingElse'}, Time.now )
+          eventcounter.expect_format ['something', 'the_event:http://www.example.com?someparam=somethingElse'].to_json + "\n"
+          eventcounter.run
+        end
+        context 'with capture_extra_replace' do
+          let (:conf) { 
+            %[
+              count_key event
+              capture_extra_if url
+              capture_extra_replace \\?.*$
+            ]
+          }
+          let (:eventcounter) { Fluent::Test::BufferedOutputTestDriver.new(Fluent::EventCounterOutput.new).configure(conf) }
+
+          it 'transforms the capture_extra with the provided regex' do
+            eventcounter.tag = 'something'
+            eventcounter.emit( { 'event' => 'the_event', 'url' => 'http://www.example.com?someparam=somethingElse'}, Time.now )
+            eventcounter.expect_format ['something', 'the_event:http://www.example.com'].to_json + "\n"
+            eventcounter.run
+          end
+        end
+      end
+      context 'the provided data DOES NOT contain the capture extra' do
+        it 'captures only the count_key' do
+          eventcounter.tag = 'something'
+          eventcounter.emit( { 'event' => 'the_event', 'not_a_url' => 'http://www.example.com'}, Time.now )
+          eventcounter.expect_format ['something', 'the_event'].to_json + "\n"
+          eventcounter.run
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'fluent/test'
+require 'rspec'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fluent/plugin/out_eventcounter'

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-eventcounter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sean Dick
+- Change.org
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd plugin to count occurences of values in a field and emit them
+  or write them to redis
+email:
+- sean@change.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- fluent-plugin-eventcounter.gemspec
+- lib/fluent/plugin/out_eventcounter.rb
+- spec/out_eventcounter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/seanmdick/fluent-plugin-eventcounter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fluentd plugin to count occurences of values in a field and emit them or
+  write them to redis
+test_files:
+- spec/out_eventcounter_spec.rb
+- spec/spec_helper.rb