fluent-plugin-grepcounter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e62f5b7c59d5196eb5a38630bb8a1292883f1d07
+  data.tar.gz: 64a2bede2b197b7f693207bc63b6a71101df8c50
+SHA512:
+  metadata.gz: 49ae4eca6395c2b381631ced8bebdb30d3451cd4f504a817b2ec858a45c9acbd198385c465062f93968e547cf49c52ec6f124d6e198b9a72457c1048a37e9cd7
+  data.tar.gz: f9d7d8b9c50c6d45e22af946edef16d440e147c76f1e2507bf48dd272c837dd52282db09fa9d3411aa6cf44971c35f8c410a40622ac746b23118ec041286be79

data/.gitignore

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

data/.rdebugrc

@@ -0,0 +1,4 @@
+set autolist
+set autoeval
+set autoreload
+

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Naotoshi SEO
+
+MIT License
+
+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,64 @@
+# fluent-plugin-grepcounter [![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-grepcounter.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-grepcounter) [![Dependency Status](https://gemnasium.com/sonots/fluent-plugin-grepcounter.png)](https://gemnasium.com/sonots/fluent-plugin-grepcounter)
+
+## Component
+
+### GrepCounterOutput
+
+Fluentd plugin to count the number of matched messages
+
+## Configuration
+
+## GrepCounterOutput
+
+Assume inputs from another plugin are as belows:
+
+    syslog.host1: {"message":"2013/01/13T07:02:11.124202 INFO GET /ping" }
+    syslog.host1: {"message":"2013/01/13T07:02:13.232645 WARN POST /auth" }
+    syslog.host1: {"message":"2013/01/13T07:02:21.542145 WARN GET /favicon.ico" }
+    syslog.host1: {"message":"2013/01/13T07:02:43.632145 WARN POST /login" }
+
+An example of grepcounter configuration:
+
+    <match syslog.**>
+      type grepcounter
+      count_interval 60
+      input_key message
+      regexp WARN
+      exclude favicon.ico
+      threshold 1
+      add_tag_prefix warn.count
+    </source>
+
+Outputs as belows:
+
+    warn.count.syslog.host1: {"count":2,"input_tag":"syslog.host1","input_tag_last":"host1"}
+
+Another example of grepcounter configuration:
+
+    <match syslog.**>
+      type grepcounter
+      count_interval 60
+      input_key message
+      regexp WARN
+      exclude favicon.ico
+      threshold 1
+      add_tag_prefix warn.count
+      output_matched_message true
+      output_with_joined_delimiter \n
+    </source>
+
+Outputs as belows:
+
+    warn.count.syslog.host1: {"count":2,"input_tag":"syslog.host1","input_tag_last":"host1","message":"2013/01/13T07:02:13.232645 WARN POST /auth\n2013/01/13T07:02:43.632145 WARN POST /login"}
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2013 Naotoshi SEO. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/fluent-plugin-grepcounter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-grepcounter"
+  s.version     = "0.0.1"
+  s.authors     = ["Naotoshi SEO"]
+  s.email       = ["sonots@gmail.com"]
+  s.homepage    = "https://github.com/sonots/fluent-plugin-grepcounter"
+  s.summary     = "Count the number of matched messages"
+  s.description = s.summary
+
+  s.rubyforge_project = "fluent-plugin-grepcounter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+  # s.add_development_dependency "delorean"
+end

data/lib/fluent/plugin/out_grepcounter.rb

@@ -0,0 +1,107 @@
+class Fluent::GrepCounterOutput < Fluent::Output
+  Fluent::Plugin.register_output('grepcounter', self)
+
+  config_param :input_key, :string
+  config_param :regexp, :string
+  config_param :count_interval, :time, :default => 5
+  config_param :exclude, :string, :default => nil
+  config_param :threshold, :integer, :default => 1
+  config_param :output_tag, :string, :default => 'count'
+  config_param :add_tag_prefix, :string, :default => nil
+  config_param :output_matched_message, :bool, :default => false
+  config_param :output_with_joined_delimiter, :string, :default => nil
+
+  attr_accessor :matches
+  attr_accessor :last_checked
+
+  def configure(conf)
+    super
+
+    @count_interval = @count_interval.to_i
+    @input_key = @input_key.to_s
+    @regexp = Regexp.compile(@regexp) if @regexp
+    @exclude = Regexp.compile(@exclude) if @exclude
+    @threshold = @threshold.to_i
+
+    if @output_with_joined_delimiter and @output_matched_message == false
+      raise Fluent::ConfigError, "'output_matched_message' must be true to use 'output_with_joined_delimiter'"
+    end
+
+    @matches = {}
+    @counts  = {}
+    @mutex = Mutex.new
+  end
+
+  def start
+    super
+    @watcher = Thread.new(&method(:watcher))
+  end
+
+  def shutdown
+    super
+    @watcher.terminate
+    @watcher.join
+  end
+
+  # Called when new line comes. This method actually does not emit
+  def emit(tag, es, chain)
+    count = 0; matches = []
+    # filter out and insert
+    es.each do |time,record|
+      value = record[@input_key]
+      next unless @regexp and @regexp.match(value)
+      next if @exclude and @exclude.match(value)
+      matches << value if @output_matched_message
+      count += 1
+    end
+    # thread safe merge
+    @counts[tag] ||= 0
+    @matches[tag] ||= []
+    @mutex.synchronize do
+      @counts[tag] += count
+      @matches[tag] += matches
+    end
+
+    chain.next
+  end
+
+  # thread callback
+  def watcher
+    # instance variable, and public accessable, for test
+    @last_checked = Fluent::Engine.now
+    while true
+      sleep 0.5
+      if Fluent::Engine.now - @last_checked >= @count_interval
+        now = Fluent::Engine.now
+        flush_emit(now - @last_checked)
+        @last_checked = now
+      end
+    end
+  end
+
+  # This method is the real one to emit
+  def flush_emit(step)
+    time = Fluent::Engine.now
+    flushed_counts, flushed_matches, @counts, @matches = @counts, @matches, {}, {}
+    flushed_counts.keys.each do |tag|
+      count = flushed_counts[tag]
+      matches = flushed_matches[tag]
+      output = generate_output(tag, count, matches)
+      tag = @add_tag_prefix ? "#{@add_tag_prefix}.#{tag}" : @output_tag
+      Fluent::Engine.emit(tag, time, output) if output
+    end
+  end
+
+  def generate_output(input_tag, count, matches)
+    return nil if count < @threshold
+    output = {}
+    output['count'] = count
+    output['input_tag'] = input_tag
+    output['input_tag_last'] = input_tag.split(".").last
+    if @output_matched_message
+      output['message'] = @output_with_joined_delimiter.nil? ? matches : matches.join(@output_with_joined_delimiter)
+    end
+    output
+  end
+
+end

data/spec/out_grepcounter_spec.rb

@@ -0,0 +1,174 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe Fluent::GrepCounterOutput do
+  before { Fluent::Test.setup }
+  CONFIG = %[
+    input_key message
+    regexp WARN
+  ]
+  let(:tag) { 'syslog.host1' }
+  let(:driver) { Fluent::Test::OutputTestDriver.new(Fluent::GrepCounterOutput, tag).configure(config) }
+
+  describe 'test configure' do
+    describe 'bad configuration' do
+      context "lack of requirements" do
+        let(:config) { '' }
+        it { expect { driver }.to raise_error(Fluent::ConfigError) }
+      end
+
+      context "check output_with_joined_delimiter" do
+        let(:config) { CONFIG + %[ output_with_joined_delimiter \\n ] }
+        it { expect { driver }.to raise_error(Fluent::ConfigError) }
+      end
+    end
+
+    describe 'good configuration' do
+      subject { driver.instance }
+
+      context "check default" do
+        let(:config) { CONFIG }
+        its(:input_key) { should == "message" }
+        its(:count_interval) { should == 5 }
+        its(:regexp) { should == /WARN/ }
+        its(:exclude) { should be_nil }
+        its(:threshold) { should == 1 }
+        its(:output_tag) { should == 'count' }
+        its(:add_tag_prefix) { should be_nil }
+        its(:output_matched_message) { should be_false }
+        its(:output_with_joined_delimiter) { should be_nil }
+      end
+    end
+  end
+
+  describe 'test emit' do
+    let(:time) { Time.now.to_i }
+    let(:messages) do
+      [
+        "2013/01/13T07:02:11.124202 INFO GET /ping",
+        "2013/01/13T07:02:13.232645 WARN POST /auth",
+        "2013/01/13T07:02:21.542145 WARN GET /favicon.ico",
+        "2013/01/13T07:02:43.632145 WARN POST /login",
+      ]
+    end
+    let(:emit) do
+      driver.run { messages.each {|message| driver.emit({'message' => message}, time) } }
+      driver.instance.flush_emit(0)
+    end
+
+    context 'count_interval' do
+      pending
+    end
+
+    context 'regexp' do
+      let(:config) { CONFIG + %[ regexp WARN ] }
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("count", time, {"count"=>3, "input_tag"=>tag, "input_tag_last"=>tag.split(".").last})
+      end
+      it { emit }
+    end
+
+    context 'exclude' do
+      let(:config) do
+        CONFIG + %[
+          exclude favicon
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("count", time, {"count"=>2, "input_tag"=>tag, "input_tag_last"=>tag.split(".").last})
+      end
+      it { emit }
+    end
+
+    context 'threshold (less than or equal to)' do
+      let(:config) do
+        CONFIG + %[
+          threshold 3
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("count", time, {"count"=>3, "input_tag"=>tag, "input_tag_last"=>tag.split(".").last})
+      end
+      it { emit }
+    end
+
+    context 'threshold (greater)' do
+      let(:config) do
+        CONFIG + %[
+          threshold 4
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_not_receive(:emit)
+      end
+      it { emit }
+    end
+
+    context 'output_tag' do
+      let(:config) do
+        CONFIG + %[
+          output_tag foo
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("foo", time, {"count"=>3, "input_tag"=>tag, "input_tag_last"=>tag.split(".").last})
+      end
+      it { emit }
+    end
+
+    context 'add_tag_prefix' do
+      let(:config) do
+        CONFIG + %[
+          add_tag_prefix foo
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("foo.#{tag}", time, {"count"=>3, "input_tag"=>tag, "input_tag_last"=>tag.split(".").last})
+      end
+      it { emit }
+    end
+
+    context 'output_matched_message' do
+      let(:config) do
+        CONFIG + %[
+          output_matched_message true
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("count", time, {
+          "count"=>3, "input_tag"=>tag, "input_tag_last"=>tag.split(".").last,
+          "message"=>["2013/01/13T07:02:13.232645 WARN POST /auth","2013/01/13T07:02:21.542145 WARN GET /favicon.ico","2013/01/13T07:02:43.632145 WARN POST /login"]
+        })
+      end
+      it { emit }
+    end
+
+    context 'output_with_joined_delimiter' do
+      let(:config) do
+        # \\n shall be \n in config file
+        CONFIG + %[
+          output_matched_message true
+          output_with_joined_delimiter \\n
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("count", time, {
+          "count"=>3, "input_tag"=>tag, "input_tag_last"=>tag.split(".").last,
+          "message"=>"2013/01/13T07:02:13.232645 WARN POST /auth\\n2013/01/13T07:02:21.542145 WARN GET /favicon.ico\\n2013/01/13T07:02:43.632145 WARN POST /login"
+        })
+      end
+      it { emit }
+    end
+  end
+end
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'fluent/test'
+require 'rspec'
+require 'pry'
+# require 'delorean'
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fluent/plugin/out_grepcounter'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-grepcounter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi SEO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Count the number of matched messages
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rdebugrc
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-grepcounter.gemspec
+- lib/fluent/plugin/out_grepcounter.rb
+- spec/out_grepcounter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-plugin-grepcounter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: fluent-plugin-grepcounter
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Count the number of matched messages
+test_files:
+- spec/out_grepcounter_spec.rb
+- spec/spec_helper.rb