fluent-plugin-conditional_filter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cab6711bb735bb3f4cdba2f091567ce6d432645d
+  data.tar.gz: 85e70261a231649cc302071c8a49459df4712432
+SHA512:
+  metadata.gz: ad91077d850402e1d1a5c373920d92218459b7607a999a382d521e5bfa259b7f8c9c696def3f849daa415b413d6b16483eab9deb8da95a3339b90f8bb8e9f5cd
+  data.tar.gz: d29859f4d660c79ed199c5cecc071a5123e692057c2646250020ed827a4bf32d5a1efaaead58b44fa3429071de5be25bf883086242fbf47f1f7e8e386ed9501f

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
+vendor/
+

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - rbx-19mode
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kentaro Kuribayashi
+
+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,60 @@
+# Fluent::Plugin::ConditionalFilter [![BuildStatus](https://secure.travis-ci.org/kentaro/fluent-plugin-conditional_filter)](http://travis-ci.org/kentaro/fluent-plugin-conditional_filter)
+
+## Component
+
+### ConditionalFilterOutput
+
+fluent-plugin-conditional_filter provides a simple filter that filters out key/value pairs that don't match a condition.
+
+## Usage
+
+### Synopsis
+
+```
+<match test.**>
+  key_pattern @example.com$
+  condition   10
+  filter      numeric_upward
+</match>
+```
+
+### Params
+
+#### `key_pattern` (required)
+
+Key pattern to check.
+
+#### `condition` (optional: default = 'http')
+
+Condition for the filter below.
+
+#### `filter` (required)
+
+Set filtering strategy.
+
+#### `remove_tag_prefix`, `remove_tag_suffix`, `add_tag_prefix`, `add_tag_suffix`
+
+You can also use the params above inherited from [Fluent::HandleTagNameMixin](https://github.com/fluent/fluentd/blob/master/lib/fluent/mixin.rb).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-conditional_filter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-conditional_filter
+
+## 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,11 @@
+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']
+  spec.ruby_opts = %w[-w]
+end
+
+task :default => :spec
+

data/fluent-plugin-conditional_filter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fluent-plugin-conditional_filter'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Kentaro Kuribayashi']
+  spec.email         = ['kentarok@gmail.com']
+  spec.description   = %q{A fluent plugin that provides conditional filters}
+  spec.summary       = %q{A fluent plugin that provides conditional filters}
+  spec.homepage      = 'http://github.com/kentaro/fluent-plugin-conditional_filter'
+  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_runtime_dependency 'fluentd'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end
+

data/lib/fluent/plugin/out_conditional_filter.rb

@@ -0,0 +1,53 @@
+class Fluent::ConditionalFilterOutput < Fluent::Output
+  Fluent::Plugin.register_output('conditional_filter', self)
+
+  include Fluent::HandleTagNameMixin
+
+  config_param :key_pattern, :string
+  config_param :condition,   :string
+  config_param :filter,      :string
+
+  def configure(conf)
+    super
+
+    not_configured_params = %w[key_pattern condition filter].select { |p| !send(p.to_sym) }
+    if not_configured_params.any?
+      raise Fluent::ConfigError(
+        "[out_conditional_filter] missing mandatory parameter: #{not_configured_params.join(',')}"
+      )
+    end
+
+    @key_pattern_regexp = /#{key_pattern}/
+  end
+
+  def emit(tag, es, chain)
+    es.each do |time, record|
+      t = tag.dup
+      record = filter_record(t, time, record)
+
+      if record.any?
+        Fluent::Engine.emit(t, time, record)
+      end
+    end
+
+    chain.next
+  end
+
+  private
+
+  def filter_record(tag, time, record)
+    case filter
+    when 'numeric_upward'
+      filter_record = record.select do |key, value|
+        key.match(@key_pattern_regexp) &&
+          record[key].to_f >= condition.to_f
+      end
+    else
+      raise ArgumentError.new("[out_conditional_filter] no such filter: #{filter}")
+    end
+
+    filter_record
+  end
+end
+
+

data/spec/lib/out_conditional_filter_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe Fluent::ConditionalFilterOutput do
+  describe '#configure' do
+
+    context "success" do
+      let(:conf) {
+        %[
+          key_pattern @example.com$
+          condition   10
+          filter      numeric_upward
+        ]
+      }
+
+      let(:driver) { Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(conf) }
+      subject {
+        driver.instance
+      }
+
+      it {
+        expect(subject).to be_an_instance_of described_class
+        expect(subject.key_pattern).to be == '@example.com$'
+        expect(subject.instance_variable_get(:@key_pattern_regexp)).to be == /@example.com$/
+      }
+    end
+
+    context "failure" do
+      context 'key_pattern not set' do
+        let(:conf) {
+          %[
+            condition   10
+            filter      numeric_upward
+          ]
+        }
+
+        it {
+          expect {
+            Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(conf)
+          }.to raise_error(Fluent::ConfigError)
+        }
+      end
+
+      context 'condition not set' do
+        let(:conf) {
+          %[
+            key_pattern @example.com$
+            filter      numeric_upward
+          ]
+        }
+
+        it {
+          expect {
+            Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(conf)
+          }.to raise_error(Fluent::ConfigError)
+        }
+      end
+
+      context 'filter not set' do
+        let(:conf) {
+          %[
+            key_pattern @example.com$
+            condition   10
+          ]
+        }
+
+        it {
+          expect {
+            Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(conf)
+          }.to raise_error(Fluent::ConfigError)
+        }
+      end
+    end
+  end
+
+  describe "#emit" do
+    context('numeric_upward') do
+      let(:conf) {
+        %[
+          key_pattern @example.com$
+          condition   10
+          filter      numeric_upward
+        ]
+      }
+
+      let(:driver) { Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(conf) }
+      subject {
+        driver.instance
+      }
+
+      context('with 0 matched key/value pair') do
+        before {
+          driver.run {
+            driver.emit('foo@example.com' => 8, 'bar@example.com' => 6, 'baz@baz.com' => 15)
+          }
+        }
+
+        it {
+          expect(driver.emits[0]).to be_nil
+        }
+      end
+
+      context('with 1 matched key/value pair') do
+        before {
+          driver.run {
+            driver.emit('foo@example.com' => 12, 'bar@example.com' => 6, 'baz@baz.com' => 15)
+          }
+        }
+
+        it {
+          expect(driver.emits[0][2].keys.length).to be == 1
+        }
+      end
+
+      context('with 2 matched key/value pairs') do
+        before {
+          driver.run {
+            driver.emit('foo@example.com' => 12, 'bar@example.com' => 10, 'baz@baz.com' => 15)
+          }
+        }
+
+        it {
+          expect(driver.emits[0][2].keys.length).to be == 2
+        }
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'fluent/test'
+require 'fluent/plugin/out_conditional_filter'
+
+RSpec.configure do |config|
+end
+
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def message
+      @message
+    end
+
+    def reset
+      @message = nil
+    end
+
+    def method_missing(method, *args)
+      @message = args.first
+    end
+  }
+  $log = nulllogger
+end
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-conditional_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kentaro Kuribayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-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: bundler
+  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: 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'
+description: A fluent plugin that provides conditional filters
+email:
+- kentarok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-conditional_filter.gemspec
+- lib/fluent/plugin/out_conditional_filter.rb
+- spec/lib/out_conditional_filter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kentaro/fluent-plugin-conditional_filter
+licenses:
+- MIT
+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: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A fluent plugin that provides conditional filters
+test_files:
+- spec/lib/out_conditional_filter_spec.rb
+- spec/spec_helper.rb