fluent-plugin-record-modifier 0.1.0

data/ChangeLog

@@ -0,0 +1,3 @@
+Release 0.1.0 - 2013/04/7
+
+  * First release

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+# Output filter plugin for modifying each event record
+
+Adding arbitary field to event record without custmizing existence plugin.
+
+For example, generated event from *in_tail* doesn't contain "hostname" of running machine.
+In this case, you can use *record_modifier* to add "hostname" field to event record.
+
+## Installation
+
+Use RubyGems:
+
+    gem install fluent-plugin-record-modifier
+
+## Configuration
+
+    <match pattern>
+      type record_modifier
+      tag foo.filtered
+
+      gen_host ${hostname}
+      foo bar
+    </match>
+
+If following record is passed:
+
+```js
+{"message":"hello world!"}
+```
+
+then you got new record like below:
+
+```js
+{"message":"hello world!", "gen_host":"oreore-mac.local", "foo":"bar"}
+```
+
+### Mixins
+
+* [SetTagKeyMixin](https://github.com/fluent/fluentd/blob/master/lib/fluent/mixin.rb#L181)
+* [fluent-mixin-config-placeholders](https://github.com/tagomoris/fluent-mixin-config-placeholders)
+
+## TODO
+
+* Adding following features if needed
+
+    * Use HandleTagNameMixin to keep original tag
+
+    * Remove record field
+
+    * Replace record value
+
+
+## Copyright
+
+<table>
+  <tr>
+    <td>Author</td><td>Masahiro Nakagawa <repeatedly@gmail.com></td>
+  </tr>
+  <tr>
+    <td>Copyright</td><td>Copyright (c) 2013- Masahiro Nakagawa</td>
+  </tr>
+  <tr>
+    <td>License</td><td>MIT License</td>
+  </tr>
+</table>

data/Rakefile

@@ -0,0 +1,14 @@
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/*.rb']
+  test.verbose = true
+end
+
+task :default => [:build]
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/fluent-plugin-record-modifier.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-record-modifier"
+  gem.description = "Output filter plugin for modifying each event record"
+  gem.homepage    = "https://github.com/repeatedly/fluent-plugin-record-modifier"
+  gem.summary     = gem.description
+  gem.version     = File.read("VERSION").strip
+  gem.authors     = ["Masahiro Nakagawa"]
+  gem.email       = "repeatedly@gmail.com"
+  gem.has_rdoc    = false
+  #gem.platform    = Gem::Platform::RUBY
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "fluentd", "~> 0.10.17"
+  gem.add_dependency "fluent-mixin-config-placeholders", "~> 0.2.0"
+  gem.add_development_dependency "rake", ">= 0.9.2"
+end

data/lib/fluent/plugin/out_record_modifier.rb

@@ -0,0 +1,44 @@
+require 'fluent/mixin/config_placeholders'
+
+module Fluent
+  class RecordModifierOutput < Output
+    Fluent::Plugin.register_output('record_modifier', self)
+
+    config_param :tag, :string
+
+    include SetTagKeyMixin
+    include Fluent::Mixin::ConfigPlaceholders
+
+    BUILTIN_CONFIGURATIONS = %W(type tag include_tag_key tag_key)
+
+    def configure(conf)
+      super
+
+      @map = {}
+      conf.each_pair { |k, v|
+        unless BUILTIN_CONFIGURATIONS.include?(k)
+          conf.has_key?(k)
+          @map[k] = v
+        end
+      }
+    end
+
+    def emit(tag, es, chain)
+      es.each { |time, record|
+        Engine.emit(@tag, time, modify_record(record))
+      }
+
+      chain.next
+    end
+
+    private
+
+    def modify_record(record)
+      @map.each_pair { |k, v|
+        record[k] = v
+      }
+
+      record
+    end
+  end
+end

data/test/out_record_modifier.rb

@@ -0,0 +1,49 @@
+require 'fluent/test'
+require 'fluent/plugin/out_record_modifier'
+
+
+class RecordModifierOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    type record_modifier
+    tag foo.filtered
+
+    gen_host ${hostname}
+    foo bar
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::OutputTestDriver.new(Fluent::RecordModifierOutput).configure(conf)
+  end
+
+  def get_hostname
+    require 'socket'
+    Socket.gethostname.chomp
+  end
+
+  def test_configure
+    d = create_driver
+    map = d.instance.instance_variable_get(:@map)
+
+    assert_equal get_hostname, map['gen_host']
+    assert_equal 'bar', map['foo']
+  end
+
+  def test_format
+    d = create_driver
+
+    d.run do
+      d.emit("a" => 1)
+      d.emit("a" => 2)
+    end
+
+    mapped = {'gen_host' => get_hostname, 'foo' => 'bar'}
+    assert_equal [
+      {"a" => 1}.merge(mapped),
+      {"a" => 2}.merge(mapped),
+    ], d.records
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-record-modifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Masahiro Nakagawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 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.10.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+- !ruby/object:Gem::Dependency
+  name: fluent-mixin-config-placeholders
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Output filter plugin for modifying each event record
+email: repeatedly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ChangeLog
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-record-modifier.gemspec
+- lib/fluent/plugin/out_record_modifier.rb
+- test/out_record_modifier.rb
+homepage: https://github.com/repeatedly/fluent-plugin-record-modifier
+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'
+      segments:
+      - 0
+      hash: -302354387031894905
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -302354387031894905
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Output filter plugin for modifying each event record
+test_files:
+- test/out_record_modifier.rb