fluent-mixin-plaintextformatter 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~
+\#*
+.\#*
+*.swp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TAGOMORI Satoshi
+
+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,90 @@
+# Fluent::Mixin::PlainTextFormatter
+
+Fluent::Mixin::PlainTextFormatter is a mix-in module, that provides '#format' instance method and its configurations to Fluentd BufferedOutput Plugin and TimeSlicedOutput Plugin, to output plain text data (to file, REST storages, KVSs ...).
+
+This module provides features to:
+
+* format whole data as serialized JSON, single attribute or separated multi attributes
+* include time as line header (formatted by time_format in UTC(default) or localtime), or not
+* include tag as line header (remove_prefix available), or not
+* change field separator (TAB(default), SPACE or COMMA)
+* add new line as termination, or not
+
+## Usage
+
+To use this module in your fluentd plugin, include this module like below:
+
+    class FooOutput < BufferedOutput
+      Fluent::Plugin.register_output('foo', self)
+      
+      config_set_default :buffer_type, 'memory'
+      
+      include Fluent::Mixin::PlainTextFormatter
+      
+      config_param :foo_config_x, :string, :default => nil
+
+      # and other your plugin's configuration parameters...
+
+      def configure(conf)
+        super
+        
+        # ....
+      end
+      
+      def start
+        # ...
+      end
+      
+      def shutdown
+        # ....
+      end
+      
+      # def format(tag, time, record)
+      #   # do not define 'format'
+      # end
+      
+      def write(chunk)
+        # ....
+      end
+    end
+
+And you can overwrite default formatting configurations on your plugin (values below are default of mix-in):
+
+    class FooOutput < BufferedOutput
+      # ...
+      
+      config_set_default :output_include_time, true
+      config_set_default :output_include_tag, true
+      config_set_default :output_data_type, 'json'
+      config_set_default :field_separator, 'TAB'
+      config_set_default :add_newline, true
+      config_set_default :time_format, nil   # nil means ISO8601 '2012-07-13T19:29:49+09:00'
+      config_set_default :remove_prefix, nil
+      config_set_default :default_tag, nil
+      
+      # ...
+    end
+
+Provided configurations are below:
+
+* output\_include\_time [yes/no]
+* output\_include\_tag [yes/no]
+* output\_data\_type
+  * 'json': output by JSON
+  * 'attr:key1,key2,key3': values of 'key1' and 'key2' and ..., with separator specified by 'field_separator'
+* field\_separator [TAB/SPACE/COMMA]
+* add_newline [yes/no]
+* time_format
+  * format string like '%Y-%m-%d %H:%M:%S' or you want
+* remove_prefix
+  * input tag 'test.foo' with 'remove_prefix test', output tag is 'foo'.
+  * 'default\_tag' configuration is used when input tag is completely equal to 'remove\_prefix'
+
+## AUTHORS
+
+* TAGOMORI Satoshi <tagomoris@gmail.com>
+
+## LICENSE
+
+* Copyright: Copyright (c) 2012- tagomoris
+* License: Apache License, Version 2.0

data/Rakefile

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

data/fluent-mixin-plaintextformatter.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-mixin-plaintextformatter"
+  gem.version       = "0.1.0"
+  gem.authors       = ["TAGOMORI Satoshi"]
+  gem.email         = ["tagomoris@gmail.com"]
+  gem.description   = %q{included to format values into json, tsv or csv}
+  gem.summary       = %q{Text formatter mixin module to create fluentd plugin}
+  gem.homepage      = "https://github.com/tagomoris/fluent-mixin-plaintextformatter"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "fluentd"
+  gem.add_runtime_dependency "fluentd"
+end

data/lib/fluent/mixin/plaintextformatter.rb

@@ -0,0 +1,98 @@
+require 'fluent/config'
+
+module Fluent
+  module Mixin
+    module PlainTextFormatter
+      attr_accessor :output_include_time, :output_include_tag, :output_data_type
+      attr_accessor :add_newline, :field_separator
+      attr_accessor :remove_prefix, :default_tag
+
+      attr_accessor :f_separator
+
+      def first_value(*args)
+        args.reduce{|a,b| (not a.nil?) ? a : b}
+      end
+
+      def configure(conf)
+        super
+
+        @output_include_time = first_value( Fluent::Config.bool_value(conf['output_include_time']), @output_include_time, true )
+        @output_include_tag = first_value( Fluent::Config.bool_value(conf['output_include_tag']), @output_include_tag, true )
+
+        @output_data_type = first_value( conf['output_data_type'], @output_data_type, 'json' )
+
+        @field_separator = first_value( conf['field_separator'], @field_separator, 'TAB' )
+        @f_separator = case @field_separator
+                       when /SPACE/i then ' '
+                       when /COMMA/i then ','
+                       else "\t"
+                       end
+
+        @add_newline = first_value( Fluent::Config.bool_value(conf['add_newline']), @add_newline, true )
+
+        @remove_prefix = conf['remove_prefix']
+        if @remove_prefix
+          @removed_prefix_string = @remove_prefix + '.'
+          @removed_length = @removed_prefix_string.length
+        end
+        if @output_include_tag and @remove_prefix and @remove_prefix.length > 0
+          @default_tag = first_value( conf['default_tag'], @default_tag, nil )
+          if @default_tag.nil? or @default_tag.length < 1
+            raise Fluent::ConfigError, "Missing 'default_tag' with output_include_tag and remove_prefix."
+          end
+        end
+
+        # default timezone: utc
+        if not conf.has_key?('localtime') and not conf.has_key?('utc')
+          @localtime = false
+        elsif conf.has_key?('localtime')
+          @localtime = true
+        elsif conf.has_key?('utc')
+          @localtime = false
+        end
+        # mix-in default time formatter (or you can overwrite @timef on your own configure)
+        @time_format = first_value( conf['time_format'], @time_format, nil )
+        @timef = @output_include_time ? Fluent::TimeFormatter.new(@time_format, @localtime) : nil
+
+        @custom_attributes = if @output_data_type == 'json'
+                               nil
+                             elsif @output_data_type =~ /^attr:(.+)$/
+                               $1.split(',')
+                             else
+                               raise Fluent::ConfigError, "invalid output_data_type:'#{@output_data_type}'"
+                             end
+      end
+
+      def stringify_record(record)
+        if @custom_attributes.nil?
+          record.to_json
+        else
+          @custom_attributes.map{|attr|
+            (record[attr] || 'NULL').to_s
+          }.join(@f_separator)
+        end
+      end
+
+      def format(tag, time, record)
+        if @remove_prefix
+          if tag.start_with?(@removed_prefix_string) and tag.length > @removed_length
+            tag = tag[@removed_length..-1]
+          elsif tag == @remove_prefix
+            tag = @default_tag
+          end
+        end
+        time_str = if @output_include_time
+                     @timef.format(time) + @f_separator
+                   else
+                     ''
+                   end
+        tag_str = if @output_include_tag
+                    tag + @f_separator
+                  else
+                    ''
+                  end
+        time_str + tag_str + stringify_record(record) + (@add_newline ? "\n" : '')
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+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
+
+require 'fluent/mixin/plaintextformatter'
+require_relative 'output'
+
+class Test::Unit::TestCase
+end

data/test/mixin/test_plaintextformatter.rb

@@ -0,0 +1,156 @@
+require 'helper'
+
+class PlainTextFormatterTest < Test::Unit::TestCase
+  def create_plugin_instance(type, conf = CONFIG, tag='test')
+    Fluent::Test::BufferedOutputTestDriver.new(type, tag).configure(conf).instance
+  end
+
+  def test_first_value
+    p = create_plugin_instance(Fluent::TestAOutput, "type testa\n")
+    assert_equal nil, p.first_value()
+    assert_equal nil, p.first_value(nil, nil)
+    assert_equal 'hoge', p.first_value(nil, nil, 'hoge')
+    assert_equal 'bar', p.first_value(nil, 'bar', 'hoge')
+    assert_equal 'foo', p.first_value('foo', 'bar', 'hoge')
+    assert_equal 'foo', p.first_value('foo', nil, 'hoge')
+    assert_equal 'foo', p.first_value('foo', 'bar', nil)
+    assert_equal 'foo', p.first_value('foo', nil, nil)
+  end
+
+  def test_default_with_time_tag
+    p = create_plugin_instance(Fluent::TestAOutput, "type testa\n")
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal r, JSON.parse(p.stringify_record(r))
+
+    line = p.format('test.a', 1342163105, r)
+    # add_newline true
+    assert_equal line[0..-2], line.chomp
+    # output_include_time true, output_include_tag true
+    assert_equal ['2012-07-13T07:05:05Z', 'test.a'], line.chomp.split(/\t/)[0..1]
+    # output_data_type json
+    assert_equal r, JSON.parse(line.chomp.split(/\t/)[2])
+  end
+
+  def test_field_separator_newline_json
+    p = create_plugin_instance(Fluent::TestBOutput, "type testb\nlocaltime\n")
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal r, JSON.parse(p.stringify_record(r))
+
+    line = p.format('test.b', 1342163105, r)
+    # add_newline false
+    assert_equal line[0..-1], line.chomp
+    # output_include_time true, output_include_tag true, localtime, separator COMMA
+    assert_equal ['2012-07-13T16:05:05+09:00', 'test.b'], line.chomp.split(/,/, 3)[0..1]
+    # output_data_type json
+    assert_equal r, JSON.parse(line.chomp.split(/,/, 3)[2])
+  end
+
+  def test_time_format
+    p = create_plugin_instance(Fluent::TestBOutput, %[
+type testb
+localtime
+time_format %Y/%m/%d %H:%M:%S
+])
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal r, JSON.parse(p.stringify_record(r))
+
+    line = p.format('test.b', 1342163105, r)
+    # add_newline false
+    assert_equal line[0..-1], line.chomp
+    # output_include_time true, output_include_tag true, localtime, separator COMMA
+    assert_equal ['2012/07/13 16:05:05', 'test.b'], line.chomp.split(/,/, 3)[0..1]
+    # output_data_type json
+    assert_equal r, JSON.parse(line.chomp.split(/,/, 3)[2])
+  end
+  def test_separator_space_remove_prefix
+    p = create_plugin_instance(Fluent::TestBOutput, %[
+type testb
+localtime
+time_format %Y/%m/%d:%H:%M:%S
+field_separator space
+remove_prefix test
+])
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal r, JSON.parse(p.stringify_record(r))
+
+    line = p.format('test.b', 1342163105, r)
+    # add_newline false
+    assert_equal line[0..-1], line.chomp
+    # output_include_time true, output_include_tag true, localtime, separator COMMA
+    assert_equal ['2012/07/13:16:05:05', 'b'], line.chomp.split(/ /, 3)[0..1]
+    # output_data_type json
+    assert_equal r, JSON.parse(line.chomp.split(/ /, 3)[2])
+  end
+
+  def test_default_without_time_tag
+    p = create_plugin_instance(Fluent::TestCOutput, "type testc\n")
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal r, JSON.parse(p.stringify_record(r))
+
+    line = p.format('test.c', 1342163105, r)
+    # add_newline
+    assert_equal line[0..-2], line.chomp
+    # output_include_time false, output_include_tag false
+    assert_equal 1, line.chomp.split(/\t/).size
+    # output_data_type json
+    assert_equal r, JSON.parse(line.chomp.split(/\t/).first)
+  end
+
+  def test_format_single_attribute
+    p = create_plugin_instance(Fluent::TestAOutput, %[
+type testa
+output_include_time true
+output_include_tag true
+output_data_type attr:foo
+])
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal 'foo foo baz', p.stringify_record(r)
+    # format
+    assert_equal "2012-07-13T07:05:05Z\ttest.a\tfoo foo baz\n", p.format('test.a', 1342163105, r)
+
+    p = create_plugin_instance(Fluent::TestAOutput, %[
+type testa
+output_include_time false
+output_include_tag false
+output_data_type attr:bar
+])
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal '10000', p.stringify_record(r)
+    # format
+    assert_equal "10000\n", p.format('test.a', 1342163105, r)
+  end
+
+  def test_format_multi_attribute
+    p = create_plugin_instance(Fluent::TestAOutput, %[
+type testa
+output_include_time true
+output_include_tag true
+output_data_type attr:foo,bar
+])
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal "foo foo baz\t10000", p.stringify_record(r)
+    # format
+    assert_equal "2012-07-13T07:05:05Z\ttest.a\tfoo foo baz\t10000\n", p.format('test.a', 1342163105, r)
+
+    p = create_plugin_instance(Fluent::TestAOutput, %[
+type testa
+output_include_time false
+output_include_tag false
+output_data_type attr:bar,foo
+field_separator comma
+])
+    r = {'foo' => 'foo foo baz', 'bar' => 10000}
+    # stringify
+    assert_equal "10000,foo foo baz", p.stringify_record(r)
+    # format
+    assert_equal "10000,foo foo baz\n", p.format('test.a', 1342163105, r)
+  end
+end

data/test/output.rb

@@ -0,0 +1,64 @@
+require 'fluent/mixin/plaintextformatter'
+
+module Fluent
+  class TestAOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('testa', self)
+
+    config_set_default :buffer_type, 'memory'
+
+    include Fluent::Mixin::PlainTextFormatter
+
+    config_set_default :output_include_time, true
+    config_set_default :output_include_tag, true
+    config_set_default :output_data_type, 'json'
+    config_set_default :field_separator, "\t"
+    config_set_default :add_newline, true
+    config_set_default :remove_prefix, nil
+    config_set_default :default_tag, 'tag.blank'
+
+    def configure(conf)
+      super
+    end
+  end
+
+  class TestBOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('testa', self)
+
+    config_set_default :buffer_type, 'memory'
+
+    include Fluent::Mixin::PlainTextFormatter
+
+    config_set_default :output_include_time, true
+    config_set_default :output_include_tag, true
+    config_set_default :output_data_type, 'json'
+    config_set_default :field_separator, "COMMA"
+    config_set_default :add_newline, false
+    config_set_default :remove_prefix, nil
+    config_set_default :default_tag, 'tag.blank'
+
+    def configure(conf)
+      super
+    end
+  end
+
+  class TestCOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('testc', self)
+
+    config_set_default :buffer_type, 'memory'
+
+    include Fluent::Mixin::PlainTextFormatter
+
+    config_set_default :output_include_time, false
+    config_set_default :output_include_tag, false
+    config_set_default :output_data_type, 'json'
+    config_set_default :field_separator, "\t"
+    config_set_default :add_newline, true
+    config_set_default :remove_prefix, nil
+    config_set_default :default_tag, 'tag.blank'
+
+    def configure(conf)
+      super
+    end
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: fluent-mixin-plaintextformatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-13 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'
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: included to format values into json, tsv or csv
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-mixin-plaintextformatter.gemspec
+- lib/fluent/mixin/plaintextformatter.rb
+- test/helper.rb
+- test/mixin/test_plaintextformatter.rb
+- test/output.rb
+homepage: https://github.com/tagomoris/fluent-mixin-plaintextformatter
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Text formatter mixin module to create fluentd plugin
+test_files:
+- test/helper.rb
+- test/mixin/test_plaintextformatter.rb
+- test/output.rb