fluent-plugin-record-reformer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7d6ae389089e590c847be0a6f9969cab1e56138
+  data.tar.gz: 69a52f47a536d08d3d317ce8803d761cba44ea97
+SHA512:
+  metadata.gz: f4bb261c67b3842003d83b54729a3b0e453b09f8d6a3efce0f741acebe0d8b569e644898bc634bb20ea3440fe815c456c48a0e0a495abe3109ce8523ce734830
+  data.tar.gz: bb9f7cce04fc9ea24db7e25a6ed9d882824328433b1a99ce427a00b1c90260d1751dc4ca2661ecfbc73aebb7b4d89dbd7253a0c7c20013c3bbd53a887e073529

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: i4DJCtdksuIwhBck1tukIjzKoMCxWIIvQ

data/.gitignore

@@ -0,0 +1,12 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1  (2013/05/02)
+
+First release

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem 'simplecov', git: 'https://github.com/colszowka/simplecov.git'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Naotoshi SEO
+
+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,78 @@
+# fluent-plugin-record-reformer [![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-record-reformer.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-record-reformer) [![Dependency Status](https://gemnasium.com/sonots/fluent-plugin-record-reformer.png)](https://gemnasium.com/sonots/fluent-plugin-record-reformer) [![Coverage Status](https://coveralls.io/repos/sonots/fluent-plugin-record-reformer/badge.png?branch=master)](https://coveralls.io/r/sonots/fluent-plugin-record-reformer)
+
+Add or replace fields of a event record
+
+## Installation
+
+Use RubyGems:
+
+    gem install fluent-plugin-record-reformer
+
+## Configuration
+
+    <match foo.**>
+      type record_reformer
+      output_tag reformed
+      
+      hostname ${hostname}
+      tag ${tag}
+      time ${time.strftime('%Y-%m-%dT%H:%M:%S%z')}
+      message ${hostname} ${tags.last} ${message}
+    </match>
+
+Assume following input is coming:
+
+```js
+foo.bar {"message":"hello world!", "foo":"bar"}
+```
+
+then output becomes as below (indented):
+
+```js
+reformed {
+  "hostname":"your_hostname", 
+  "tag":"foo.bar",
+  "time":"2013-05-01T01:13:14Z",
+  "message":"your_hostname bar hello world!",
+  "foo":"bar"
+ }
+```
+
+### Placeholders
+
+The keys of input json are available as placeholders. In the above example, 
+
+* ${foo}
+* ${message}
+
+shall be available. In addition, following placeholders are reserved: 
+
+* ${hostname} hostname
+* ${tag} input tag
+* ${tags} input tag splitted by '.'
+* ${time} time of the event
+
+It is also possible to write a ruby code in placeholders, so you may write some codes as
+
+* ${time.strftime('%Y-%m-%dT%H:%M:%S%z')}
+* ${tags.last}  
+
+## Relatives
+
+* [fluent-plugin-record-modifier](https://github.com/repeatedly/fluent-plugin-record-modifier)
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## 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](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2013 Naotoshi SEO. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+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']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/fluent-plugin-record-reformer.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-record-reformer"
+  gem.version     = "0.0.1"
+  gem.authors     = ["Naotoshi Seo"]
+  gem.email       = "sonots@gmail.com"
+  gem.homepage    = "https://github.com/sonots/fluent-plugin-record-reformer"
+  gem.description = "Output filter plugin for reforming each event record"
+  gem.summary     = gem.description
+  gem.has_rdoc    = false
+
+  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_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency 'coveralls'
+end

data/lib/fluent/plugin/out_record_reformer.rb

@@ -0,0 +1,52 @@
+require 'socket'
+
+module Fluent
+  class RecordReformerOutput < Output
+    Fluent::Plugin.register_output('record_reformer', self)
+
+    config_param :output_tag, :string
+
+    BUILTIN_CONFIGURATIONS = %W(type output_tag)
+
+    def configure(conf)
+      super
+
+      @map = {}
+      conf.each_pair { |k, v|
+        next if BUILTIN_CONFIGURATIONS.include?(k)
+        conf.has_key?(k)
+        @map[k] = v
+      }
+
+      @hostname = Socket.gethostname
+    end
+
+    def emit(tag, es, chain)
+      tags = tag.split('.')
+      es.each { |time, record|
+        Engine.emit(@output_tag, time, expand_record(record, tag, tags, time))
+      }
+      chain.next
+    end
+
+    private
+
+    def expand_record(record, tag, tags, time)
+      time = Time.at(time)
+      @map.each_pair { |k, v|
+        record[k] = expand(v, record, tag, tags, time)
+      }
+      record
+    end
+
+    def expand(str, record, tag, tags, time)
+      struct = OpenStruct.new(record)
+      struct.tag  = tag
+      struct.tags = tags
+      struct.time = time
+      struct.hostname = @hostname
+      str = str.gsub(/\$\{([^}]+)\}/, '#{\1}') # ${..} => #{..}
+      eval "\"#{str}\"", struct.instance_eval { binding }
+    end
+  end
+end

data/spec/out_record_expander_spec.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe Fluent::RecordReformerOutput do
+  before { Fluent::Test.setup }
+  CONFIG = %[
+    type reformed
+    output_tag reformed
+
+    hostname ${hostname}
+    tag ${tag}
+    time ${time.strftime('%S')}
+    message ${hostname} ${tags.last} ${message}
+  ]
+  let(:tag) { 'test.tag' }
+  let(:tags) { tag.split('.') }
+  let(:hostname) { Socket.gethostname.chomp }
+  let(:driver) { Fluent::Test::OutputTestDriver.new(Fluent::RecordReformerOutput, tag).configure(config) }
+
+  describe 'test configure' do
+    describe 'good configuration' do
+      subject { driver.instance }
+
+      context "check default" do
+        let(:config) { CONFIG }
+        its(:output_tag) { should == 'reformed' }
+      end
+    end
+  end
+
+  describe 'test emit' do
+    let(:time) { Time.now }
+    let(:emit) do
+      driver.run do
+        driver.emit({'foo'=>'bar', 'message' => 1}, time.to_i)
+        driver.emit({'foo'=>'bar', 'message' => 2}, time.to_i)
+      end
+    end
+
+    let(:config) { CONFIG }
+    before do
+      Fluent::Engine.stub(:now).and_return(time)
+      Fluent::Engine.should_receive(:emit).with("reformed", time.to_i, {
+        'foo' => 'bar',
+        'hostname' => hostname,
+        'tag' => tag,
+        'time' => time.strftime('%S'),
+        'message' => "#{hostname} #{tags.last} 1",
+      })
+      Fluent::Engine.should_receive(:emit).with("reformed", time.to_i, {
+        'foo' => 'bar',
+        'hostname' => hostname,
+        'tag' => tag,
+        'time' => time.strftime('%S'),
+        'message' => "#{hostname} #{tags.last} 2",
+      })
+    end
+    it { emit }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'fluent/test'
+require 'rspec'
+require 'pry'
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fluent/plugin/out_record_reformer'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-record-reformer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: coveralls
+  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: Output filter plugin for reforming each event record
+email: sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-record-reformer.gemspec
+- lib/fluent/plugin/out_record_reformer.rb
+- spec/out_record_expander_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-plugin-record-reformer
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: Output filter plugin for reforming each event record
+test_files:
+- spec/out_record_expander_spec.rb
+- spec/spec_helper.rb