fluent-plugin-filter_keys 0.0.1

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/.travis.yml

@@ -0,0 +1,5 @@
+# https://github.com/travis-ci/travis-ci/wiki/.travis.yml-options
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kohei Hasegawa
+
+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,46 @@
+# fluent-plugin-filter_keys
+[![Build Status](https://secure.travis-ci.org/banyan/fluent-plugin-filter_keys.png)](http://travis-ci.org/banyan/fluent-plugin-filter_keys)
+
+## Overview
+
+Fluentd plugin to filter if a specific key is present or not in event logs.
+
+## Installation
+
+```
+$ gem install fluent-plugin-filter_keys
+```
+
+## Configuration
+
+```
+<match test.**>
+  type filter_keys
+
+  add_tag_prefix filter_keys.
+  ensure_keys    foo, bar
+</match>
+
+<match test.**>
+  type filter_keys
+
+  add_tag_prefix filter_keys.
+  denied_keys    foo, bar
+</match>
+```
+
+#### ensure_keys
+
+The keys to be existed in event logs. If it doesn't match, the event log will be discarded.
+
+#### denied_keys
+
+The keys to be not existed in event logs. If it matches, the event log will be discarded.
+
+## 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

data/Rakefile

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

data/fluent-plugin-filter_keys.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-filter_keys"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Kohei Hasegawa"]
+  spec.email         = ["ameutau@gmail.com"]
+  spec.description   = %q{Fluentd plugin to filter if a specific key is present or not in event logs.}
+  spec.summary       = %q{Fluentd plugin to filter if a specific key is present or not in event logs.}
+  spec.homepage      = "https://github.com/banyan/fluent-plugin-filter_keys"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fluentd"
+end

data/lib/fluent/plugin/out_filter_keys.rb

@@ -0,0 +1,48 @@
+# coding: utf-8
+
+module Fluent
+  class FilterKeysOutput < Output
+    include Fluent::HandleTagNameMixin
+
+    Fluent::Plugin.register_output('filter_keys', self)
+
+    config_param :ensure_keys, :string, :default => nil
+    config_param :denied_keys, :string, :default => nil
+
+    def configure(conf)
+      super
+
+      if (ensure_keys && denied_keys) || (ensure_keys.nil? && denied_keys.nil?)
+        raise ConfigError, "filter_keys: Either ensure_keys or denied_keys are required to be set."
+      end
+
+      @ensure_keys = ensure_keys && ensure_keys.split(/\s*,\s*/)
+      @denied_keys = denied_keys && denied_keys.split(/\s*,\s*/)
+    end
+
+    def emit(tag, es, chain)
+      es.each { |time, record|
+        t = tag.dup
+        filter_record(t, time, record)
+        if ensure_keys_in?(record) || denied_keys_not_in?(record)
+          Engine.emit(t, time, record)
+        end
+      }
+
+      chain.next
+    end
+
+    def filter_record(tag, time, record)
+      super(tag, time, record)
+    end
+
+    private
+    def ensure_keys_in?(record)
+      @ensure_keys && @ensure_keys.all? { |key| record.include? key }
+    end
+
+    def denied_keys_not_in?(record)
+      @denied_keys && !@denied_keys.any? { |key| record.include? key }
+    end
+  end
+end

data/test/plugin/test_out_filter_keys.rb

@@ -0,0 +1,182 @@
+# coding: utf-8
+
+require 'test_helper'
+require 'fluent/plugin/out_filter_keys'
+
+class FilterKeysOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(
+      Fluent::FilterKeysOutput, tag
+    ).configure(conf)
+  end
+
+  def test_configure_on_success
+    d = create_driver(%[
+      add_tag_prefix filter_keys.
+      ensure_keys    zoo, woo
+    ])
+
+    assert_equal 'filter_keys.', d.instance.add_tag_prefix
+    assert_equal %w(zoo woo),    d.instance.ensure_keys
+  end
+
+  def test_configure_on_failure
+    # when mandatory keys not set
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[
+        blah blah
+      ])
+    end
+
+    # when ensure_keys and denied_keys are both set
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[
+        add_tag_prefix filter_keys.
+        ensure_keys    zoo, woo
+        denied_keys    foo, bar
+      ])
+    end
+  end
+
+  def test_emit_with_ensure_keys_exists
+    d = create_driver(%[
+      ensure_keys foo
+      add_tag_prefix filter_keys.
+    ])
+
+    record = {
+      'foo' => "50",
+      'bar' => "100",
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 1,                  emits.count
+    assert_equal 'filter_keys.test', emits[0][0]
+    assert_equal '50',               emits[0][2]['foo']
+    assert_equal '100',              emits[0][2]['bar']
+  end
+
+  def test_emit_with_ensure_keys_exists_on_multiple_arguments
+    d = create_driver(%[
+      ensure_keys    foo, bar
+      add_tag_prefix filter_keys.
+    ])
+
+    record = {
+      'foo' => "50",
+      'bar' => "100",
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 1,                  emits.count
+    assert_equal 'filter_keys.test', emits[0][0]
+    assert_equal '50',               emits[0][2]['foo']
+    assert_equal '100',              emits[0][2]['bar']
+  end
+
+  def test_emit_with_ensure_keys_not_exists
+    d = create_driver(%[
+      ensure_keys    foo
+      add_tag_prefix filter_keys.
+    ])
+
+    record = {
+      'not' => "match",
+      'at'  => "all",
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 0,  emits.count
+    assert_equal [], emits
+  end
+
+  def test_emit_with_ensure_keys_not_exists_on_multiple_arguments
+    d = create_driver(%[
+      ensure_keys foo, bar
+      add_tag_prefix   filter_keys.
+    ])
+
+    record = {
+      'foo' => "50",
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 0,  emits.count
+    assert_equal [], emits
+  end
+
+  def test_emit_with_denied_keys_exists
+    d = create_driver(%[
+      denied_keys    foo
+      add_tag_prefix filter_keys.
+    ])
+
+    record = {
+      'foo' => "50",
+      'bar' => "100",
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 0,  emits.count
+    assert_equal [], emits
+  end
+
+  def test_emit_with_denied_keys_not_exists
+    d = create_driver(%[
+      denied_keys    foo
+      add_tag_prefix filter_keys.
+    ])
+
+    record = {
+      'baz' => "50",
+      'bar' => "100",
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 1,                  emits.count
+    assert_equal 'filter_keys.test', emits[0][0]
+    assert_equal '50',               emits[0][2]['baz']
+    assert_equal '100',              emits[0][2]['bar']
+  end
+
+  def test_emit_multi_records
+    d = create_driver(%[
+      add_tag_prefix filter_keys.
+      ensure_keys    baz
+    ])
+
+    record = {
+      'baz' => "50",
+      'bar' => "100",
+    }
+
+    d.run do
+      3.times { d.emit(record) }
+    end
+    emits = d.emits
+
+    assert_equal 3, emits.count
+
+    emits.each do |e|
+      assert_equal 'filter_keys.test', e[0]
+      assert_equal '50',               e[2]['baz']
+      assert_equal '100',              e[2]['bar']
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+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
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter_keys
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kohei Hasegawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+description: Fluentd plugin to filter if a specific key is present or not in event
+  logs.
+email:
+- ameutau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-filter_keys.gemspec
+- lib/fluent/plugin/out_filter_keys.rb
+- test/plugin/test_out_filter_keys.rb
+- test/test_helper.rb
+homepage: https://github.com/banyan/fluent-plugin-filter_keys
+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 filter if a specific key is present or not in event logs.
+test_files:
+- test/plugin/test_out_filter_keys.rb
+- test/test_helper.rb
+has_rdoc: