fluent-plugin-filter 0.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.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 'http://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-filter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 muddydixon
+
+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.rdoc

@@ -0,0 +1,49 @@
+= fluent-plugin-filter
+
+== Component
+
+=== FilterOutput
+
+Filtering messages by simple allow/deny rules.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-filter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-filter
+
+== Configuration
+
+=== FilterOutput
+
+Filter out messages contains <tt>{status : 404}</tt> :
+
+    <match accesslog.**>
+      type filter
+      all allow
+      deny status: 404
+    </match>
+    <match filtered.**>
+      type stdout
+    </match>
+
+in above configuration, {status: 404} is filtered out and {status: 200}, {status: 303}, {status: 401} passed.
+Messages passing filter are add_prefix (default filtered.)
+
+So you catch "filtered" tag and do next process.
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+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-filter.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["muddydixon"]
+  gem.email         = ["muddydixon@gmail.com"]
+  gem.description   = %q{Simple output filter}
+  gem.summary       = %q{Simple output filter}
+  gem.homepage      = "https://github.com/muddydixon/fluent-plugin-filter"
+  gem.rubyforge_project      = "fluent-plugin-filter"
+
+  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-filter"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.0"
+
+  gem.extra_rdoc_files = [
+    "ChangeLog",
+    "README.rdoc"
+  ] 
+  gem.add_development_dependency "fluentd"
+  gem.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_filter.rb

@@ -0,0 +1,75 @@
+module Fluent
+class FilterOutput < Output
+  Plugin.register_output('filter', self)
+
+  config_param :all, :string, :default => 'allow'
+  config_param :allow, :string, :default => ''
+  config_param :deny, :string, :default => ''
+  config_param :add_prefix, :string, :default => 'filtered'
+  
+  attr_accessor :allows
+  attr_accessor :denies
+
+  def configure(conf)
+    super
+    @allows = toMap(@allow)
+    @denies = toMap(@deny)
+  end
+
+  def toMap (str)
+    str.split(/\s*,\s*/).map do|pair|
+      k, v = pair.split(/\s*:\s*/)
+      if v =~ /^\d+$/
+        v = v.to_i
+      elsif v =~ /^[\d\.]+(e\d+)?$/
+        v = v.to_f
+      elsif v =~ /^\/[^\/]+\/$/
+        v = Regexp.new(v.gsub(/^\/|\/$/, ''))
+      else
+        v = v.gsub(/^[\"\']|[\"\']$/, '')
+      end
+      [k, v]
+    end
+  end
+
+  def passRules (record)
+    if @all == 'allow'
+      @denies.each do |deny|
+        if (deny[1].is_a? Regexp and record[deny[0]].match(deny[1])) or record[deny[0]] == deny[1]
+          @allows.each do |allow|
+            if (allow[1].is_a? Regexp and record[allow[0]].match(allow[1])) or record[allow[0]] == allow[1]
+              return true
+            end
+          end
+          return false
+        end
+      end
+      return true
+    else
+      @allows.each do |allow|
+        if (allow[1].is_a? Regexp and record[allow[0]].match(allow[1])) or record[allow[0]] == allow[1]
+          @denies.each do |deny|
+            if (deny[1].is_a? Regexp and record[deny[0]].match(deny[1])) or record[deny[0]] == deny[1]
+              return false
+            end
+          end
+          return true
+        end
+      end
+      return false
+    end
+  end
+
+  def emit(tag, es, chain)
+    if @add_prefix
+      tag = @add_prefix + '.' + tag
+    end
+    es.each do |time, record|
+      next unless passRules(record)
+      Engine.emit(tag, time, record)
+    end
+    chain.next
+  end
+end
+
+end

data/sample.conf

@@ -0,0 +1,13 @@
+<source>
+  type forward
+  port 9999
+</source>
+<match test.**>
+  type filter
+  all allow
+  deny status: 404
+</match>
+<match filtered.**>
+  type stdout
+</match>
+  

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_filter'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_filter.rb

@@ -0,0 +1,160 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class Filter < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    all allow
+    deny status: 404
+  ]
+
+  def create_driver(conf = CONFIG, tag='test.input')
+    Fluent::Test::OutputTestDriver.new(Fluent::FilterOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    # add tag
+    d = create_driver %[
+      all deny
+      allow status: 200
+      add_prefix hoge
+    ]
+    assert_equal "hoge", d.instance.add_prefix
+    assert_equal [['status', 200]], d.instance.allows
+    assert_equal [], d.instance.denies
+
+    # int value
+    d = create_driver %[
+      all deny
+      allow status: 200
+    ]
+    assert_equal [['status', 200]], d.instance.allows
+    assert_equal [], d.instance.denies
+
+    # float value
+    d = create_driver %[
+      all deny
+      allow status: 200.0
+    ]
+    assert_equal [['status', 200.0]], d.instance.allows
+    assert_equal [], d.instance.denies
+
+    # text value
+    d = create_driver %[
+      all deny
+      allow status: "200"
+    ]
+    assert_equal [['status', '200']], d.instance.allows
+    assert_equal [], d.instance.denies
+
+    # regexp value
+    d = create_driver %[
+      all deny
+      allow url: /hoge/
+    ]
+    assert_equal [['url', /hoge/]], d.instance.allows
+    assert_equal [], d.instance.denies
+    
+  end
+  def test_emit
+    data = [
+      {'status' => 200, 'agent' => 'IE'},
+      {'status' => 303, 'agent' => 'Gecko'},
+      {'status' => 200, 'agent' => 'IE'},
+      {'status' => 401, 'agent' => 'Gecko'},
+      {'status' => 200, 'agent' => 'Gecka'},
+      {'status' => 404, 'agent' => 'Gecko'},
+    ]
+
+    d = create_driver(CONFIG, 'test.input')
+    d.run do
+      data.each do |dat|
+        d.emit dat
+      end
+    end
+    assert_equal 5, d.emits.length
+
+    d = create_driver(%[
+      all deny
+      allow status: 200
+    ], 'test.input')
+    d.run do
+      data.each do |dat|
+        d.emit dat
+      end
+    end
+    assert_equal 3, d.emits.length
+
+    d = create_driver(%[
+      all deny
+      allow status: 200, status: 303
+    ], 'test.input')
+    d.run do
+      data.each do |dat|
+        d.emit dat
+      end
+    end
+    assert_equal 4, d.emits.length
+
+    d = create_driver(%[
+      all deny
+      allow agent: Gecko
+    ], 'test.input')
+    d.run do
+      data.each do |dat|
+        d.emit dat
+      end
+    end
+    assert_equal 3, d.emits.length
+
+    d = create_driver(%[
+      all deny
+      allow agent: "Gecko"
+    ], 'test.input')
+    d.run do
+      data.each do |dat|
+        d.emit dat
+      end
+    end
+    assert_equal 3, d.emits.length
+
+    d = create_driver(%[
+      all deny
+      allow agent: "Gecko"
+      deny status: 200
+    ], 'test.input')
+    d.run do
+      data.each do |dat|
+        d.emit dat
+      end
+    end
+    assert_equal 3, d.emits.length
+
+    d = create_driver(%[
+      all deny
+      allow agent: /Geck/
+    ], 'test.input')
+    d.run do
+      data.each do |dat|
+        d.emit dat
+      end
+    end
+    assert_equal 4, d.emits.length
+
+    d = create_driver(%[
+      all deny
+      allow agent: /Geck/
+      add_prefix hoge
+    ], 'test.input')
+    d.run do
+      data.each do |dat|
+        d.emit dat
+      end
+    end
+    assert_equal "hoge.test.input", d.emits[0][0]
+
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- muddydixon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &2152828080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152828080
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &2152827620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152827620
+description: Simple output filter
+email:
+- muddydixon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog
+- README.rdoc
+files:
+- .gitignore
+- ChangeLog
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- fluent-plugin-filter.gemspec
+- lib/fluent/plugin/out_filter.rb
+- sample.conf
+- test/helper.rb
+- test/plugin/test_out_filter.rb
+homepage: https://github.com/muddydixon/fluent-plugin-filter
+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: fluent-plugin-filter
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple output filter
+test_files:
+- test/helper.rb
+- test/plugin/test_out_filter.rb