fluent-plugin-suppress 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~
+.#*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-suppress.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012 FUJIWARA Shunichiro
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,52 @@
+= fluent-plugin-suppress
+
+== Component
+
+=== SuppressOutout
+
+Fluentd plugin to suppress same messages.
+
+== Configuration
+
+=== SuppressOutput
+
+fluentd.conf
+
+    <match foo.**>
+      type           suppress
+      interval       10
+      num            2
+      attr_keys      host,message
+      add_tag_prefix sp.
+    </match>
+
+In [interval] sec, [num] messages which grouped by attr_keys value, add tag prefix "sp" and pass. Other messages will be removed.
+
+Input messages:
+
+     2012-11-22T11:22:33 foo.info {"id":1,"host":"web01","message":"error!!"}
+     2012-11-22T11:22:34 foo.info {"id":2,"host":"web01","message":"error!!"}
+   * 2012-11-22T11:22:35 foo.info {"id":3,"host":"web01","message":"error!!"}
+   * 2012-11-22T11:22:36 foo.info {"id":4,"host":"web01","message":"error!!"}
+     2012-11-22T11:22:37 foo.info {"id":5,"host":"app01","message":"error!!"}
+   * 2012-11-22T11:22:38 foo.info {"id":6,"host":"web01","message":"error!!"}
+   * 2012-11-22T11:22:39 foo.info {"id":7,"host":"web01","message":"error!!"}
+   * 2012-11-22T11:22:40 foo.info {"id":8,"host":"web01","message":"error!!"}
+     2012-11-22T11:22:45 foo.info {"id":9,"host":"web01","message":"error!!"}
+   (* = suppressed)
+
+Output messages:
+
+    2012-11-22T11:22:33 sp.foo.info {"id":1,"host":"web01","message":"error!!"}
+    2012-11-22T11:22:34 sp.foo.info {"id":2,"host":"web01","message":"error!!"}
+    2012-11-22T11:22:37 sp.foo.info {"id":5,"host":"app01","message":"error!!"}
+    2012-11-22T11:22:45 sp.foo.info {"id":9,"host":"web01","message":"error!!"}
+
+== TODO
+
+- patches welcome!
+
+== Copyright
+
+Copyright:: Copyright (c) 2012- FUJIWARA Shunichiro
+License::   Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+# -*- mode:ruby -*-
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-supress.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+# -*- mode:ruby -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["FUJIWARA Shunichiro"]
+  gem.email         = ["fujiwara.shunichiro@gmail.com"]
+  gem.description   = %q{Fluentd plugin to suppress same messages}
+  gem.summary       = %q{Fluentd plugin to suppress same messages}
+  gem.homepage      = "https://github.com/fujiwara/fluent-plugin-suppress"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "fluent-plugin-suppress"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  gem.add_development_dependency "fluentd"
+  gem.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_suppress.rb

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+module Fluent
+  class SuppressOutput < Output
+    Fluent::Plugin.register_output('suppress', self)
+
+    include Fluent::HandleTagNameMixin
+
+    config_param :attr_keys,     :string,  :default => nil
+    config_param :num,           :integer, :default => 3
+    config_param :interval,      :integer, :default => 300
+
+    def configure(conf)
+      super
+
+      unless @attr_keys
+        raise ConfigError, "out_suppress: attr_keys is required."
+      end
+
+      if ( !@remove_tag_prefix and !@remove_tag_suffix and !@add_tag_prefix and !@add_tag_suffix )
+        raise ConfigError, "out_suppress: Set remove_tag_prefix, remove_tag_suffix, add_tag_prefix or add_tag_suffix."
+      end
+
+      @keys  = @attr_keys.split(/ *, */)
+      @slots = {}
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        key  = @keys.map{|k| record[k]}.join("\0")
+        key  = tag + "\0" + key
+        slot = @slots[key] ||= []
+
+        # expire old records time
+        expired = time.to_f - @interval
+        while slot.first and slot.first <= expired
+          slot.shift
+        end
+
+        if slot.length >= @num
+          $log.debug "suppressed record: #{record.to_json}"
+          break
+        end
+
+        slot.push(time.to_f)
+        _tag = tag.clone
+        filter_record(_tag, time, record)
+        if tag != _tag
+          Engine.emit(_tag, time, record)
+        else
+          $log.warn "Drop record #{record} tag '#{tag}' was not replaced. Can't emit record, cause infinity looping. Set remove_tag_prefix, remove_tag_suffix, add_tag_prefix or add_tag_suffix correctly."
+        end
+      end
+
+      chain.next
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_suppress'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_suppress.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+class SuppressOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    interval       10
+    num            2
+    attr_keys      host, message
+    add_tag_prefix sp.
+  ]
+
+  def create_driver(conf = CONFIG, tag='test.info')
+    Fluent::Test::OutputTestDriver.new(Fluent::SuppressOutput, tag).configure(conf)
+  end
+
+  def test_emit
+    d = create_driver
+
+    time = Time.parse("2012-11-22 11:22:33 UTC").to_i
+    d.run do
+      d.emit({"id" => 1, "host" => "web01", "message" => "error!!"}, time + 1)
+      d.emit({"id" => 2, "host" => "web01", "message" => "error!!"}, time + 2)
+      d.emit({"id" => 3, "host" => "web01", "message" => "error!!"}, time + 3)
+      d.emit({"id" => 4, "host" => "web01", "message" => "error!!"}, time + 4)
+      d.emit({"id" => 5, "host" => "app01", "message" => "error!!"}, time + 4)
+      d.emit({"id" => 6, "host" => "web01", "message" => "error!!"}, time + 12)
+      d.emit({"id" => 7, "host" => "web01", "message" => "error!!"}, time + 13)
+      d.emit({"id" => 8, "host" => "web01", "message" => "error!!"}, time + 14)
+    end
+
+    emits = d.emits
+    assert_equal 5, emits.length
+    assert_equal ["sp.test.info", time + 1,  {"id"=>1, "host"=>"web01", "message"=>"error!!"}], emits[0]
+    assert_equal ["sp.test.info", time + 2,  {"id"=>2, "host"=>"web01", "message"=>"error!!"}], emits[1]
+    assert_equal ["sp.test.info", time + 4,  {"id"=>5, "host"=>"app01", "message"=>"error!!"}], emits[2]
+    assert_equal ["sp.test.info", time + 12, {"id"=>6, "host"=>"web01", "message"=>"error!!"}], emits[3]
+    assert_equal ["sp.test.info", time + 13, {"id"=>7, "host"=>"web01", "message"=>"error!!"}], emits[4]
+
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-suppress
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- FUJIWARA Shunichiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-22 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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Fluentd plugin to suppress same messages
+email:
+- fujiwara.shunichiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- fluent-plugin-supress.gemspec
+- lib/fluent/plugin/out_suppress.rb
+- test/helper.rb
+- test/plugin/test_out_suppress.rb
+homepage: https://github.com/fujiwara/fluent-plugin-suppress
+licenses: []
+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 suppress same messages
+test_files:
+- test/helper.rb
+- test/plugin/test_out_suppress.rb