fluent-plugin-format 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab742e2958a313675dffc077f30329c1f96b3bfa
+  data.tar.gz: 18a07bc6d76325e9fafa6b2b7f3bffeafbfb4eb9
+SHA512:
+  metadata.gz: fd37c653ac6a7016a943f184fea57d4d3520d7fa95292de5b52de0a7f912ea194d5bd4349092352b7d5210b64844b303f7da4d2898db634b15c0c5fb0877f7e8
+  data.tar.gz: 21c57f7532882d3d235db5afd1cade627659fe7fe2cab613cb2b0cc8d805852c120f7bd40e8f1c837467671f663044e27c7ff75197e438222de882489a27bb59

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 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-format.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Akinori Machino
+
+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,66 @@
+# Fluent::Plugin::Format
+
+Output plugin to format fields of records.
+You can add or change fields using existing values.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-format'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-format
+
+## Usage
+
+    <match pattern>
+        type format
+        tag new_tag
+        key1 %{key1} changed!
+        new_key1 key1 -> %{key1}
+        new_key2 key1 -> %{key1}, key2 -> %{key2}
+    </match>
+
+Pass
+
+    {
+        "key1": "val1",
+        "key2": "val2"
+    }
+
+Then you get
+
+    {
+        "key1": "val1 changed!",
+        "key2": "val2",
+        "new_key1": "key1 -> val1",
+        "new_key2": "key1 -> val1, key2 -> val2"
+    }
+
+You can set `include_original_fields false` to exclude original fields.
+
+    <match pattern>
+        type format
+        tag new_tag
+        include_original_fields false
+        html <h1>%{title}</h1><div><%{content}/div>
+    </match>
+
+Pass
+
+    {
+        "title": "Fluentd: Open Source Log Management",
+        "content": "Fluentd is an open-source tool to collect events and logs. 150+ plugins instantly enables you to store the massive data for Log Search, Big Data Analytics, and Archiving (MongoDB, S3, Hadoop)."
+    }
+
+Then you get
+
+    {
+        "html": "<h1>Fluentd: Open Source Log Management</h1><div>Fluentd is an open-source tool to collect events and logs. 150+ plugins instantly enables you to store the massive data for Log Search, Big Data Analytics, and Archiving (MongoDB, S3, Hadoop).</div>"
+    }

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_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 => :test

data/fluent-plugin-format.gemspec

@@ -0,0 +1,24 @@
+# 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-format"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Akinori Machino"]
+  spec.email         = ["akinori.machino@icloud.com"]
+  spec.description   = %q{Output plugin to format fields of records and re-emit them.}
+  spec.summary       = %q{Output plugin to format fields and re-emit them.}
+  spec.homepage      = "https://github.com/mach/fluent-plugin-format"
+  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", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fluentd"
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_format.rb

@@ -0,0 +1,45 @@
+module Fluent
+  class FormatOutput < Output
+    Fluent::Plugin.register_output('format', self)
+
+    config_param :tag, :string
+    config_param :include_original_fields, :bool, :default => true
+
+    CONF_KEYS = %w{type tag include_original_fields}
+
+    def configure(conf)
+      super
+
+      @fields = {}
+      conf.each do |k, v|
+        unless CONF_KEYS.include?(k)
+          @fields[k] = v
+        end
+      end
+    end
+
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        Engine.emit(@tag, time, format_record(record))
+      end
+
+      chain.next
+    end
+
+    private
+
+    def format_record(record)
+      result = {}
+
+      if @include_original_fields
+        result.merge!(record)
+      end
+
+      @fields.each do |k, v|
+        result[k] = v.gsub(/%{(.+?)}/).each { record[$1] }
+      end
+
+      return result
+    end
+  end
+end

data/test/test_cout_format.rb

@@ -0,0 +1,96 @@
+require 'fluent/test'
+require 'fluent/plugin/out_format'
+
+class FormatOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf)
+    Fluent::Test::OutputTestDriver.new(Fluent::FormatOutput).configure(conf)
+  end
+
+  def test_format
+    d1 = create_driver %[
+      type format
+      tag formatted
+      key1 %{key1} changed!
+      new_key1 key1 -> %{key1}
+      new_key2 key1 -> %{key1}, key2 -> %{key2}
+    ]
+
+    d1.run do
+      d1.emit({'key1' => 'val1', 'key2' => 'val2'})
+      d1.emit({'key1' => 'val1'})
+    end
+
+    assert_equal [
+      {
+        'key1' => 'val1 changed!',
+        'key2' => 'val2',
+        'new_key1' => 'key1 -> val1',
+        'new_key2' => 'key1 -> val1, key2 -> val2'
+      },
+      {
+        'key1' => 'val1 changed!',
+        'new_key1' => 'key1 -> val1',
+        'new_key2' => 'key1 -> val1, key2 -> '
+      }
+    ], d1.records
+
+    d2 = create_driver %[
+      type format
+      tag formatted
+      include_original_fields true
+      key1 %{key1} changed!
+      new_key1 key1 -> %{key1}
+      new_key2 key1 -> %{key1}, key2 -> %{key2}
+    ]
+
+    d2.run do
+      d2.emit({'key1' => 'val1', 'key2' => 'val2'})
+      d2.emit({'key1' => 'val1'})
+    end
+
+    assert_equal [
+      {
+        'key1' => 'val1 changed!',
+        'key2' => 'val2',
+        'new_key1' => 'key1 -> val1',
+        'new_key2' => 'key1 -> val1, key2 -> val2'
+      },
+      {
+        'key1' => 'val1 changed!',
+        'new_key1' => 'key1 -> val1',
+        'new_key2' => 'key1 -> val1, key2 -> '
+      }
+    ], d2.records
+
+    d3 = create_driver %[
+      type format
+      tag formatted
+      include_original_fields false
+      key1 %{key1} changed!
+      new_key1 key1 -> %{key1}
+      new_key2 key1 -> %{key1}, key2 -> %{key2}
+    ]
+
+    d3.run do
+      d3.emit({'key1' => 'val1', 'key2' => 'val2'})
+      d3.emit({'key1' => 'val1'})
+    end
+
+    assert_equal [
+      {
+        'key1' => 'val1 changed!',
+        'new_key1' => 'key1 -> val1',
+        'new_key2' => 'key1 -> val1, key2 -> val2'
+      },
+      {
+        'key1' => 'val1 changed!',
+        'new_key1' => 'key1 -> val1',
+        'new_key2' => 'key1 -> val1, key2 -> '
+      }
+    ], d3.records
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akinori Machino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: fluentd
+  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: 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'
+description: Output plugin to format fields of records and re-emit them.
+email:
+- akinori.machino@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-format.gemspec
+- lib/fluent/plugin/out_format.rb
+- test/test_cout_format.rb
+homepage: https://github.com/mach/fluent-plugin-format
+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: Output plugin to format fields and re-emit them.
+test_files:
+- test/test_cout_format.rb