fluent-plugin-stdout_ex 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5d9c7f8995e802b5f9932cf0cb6c5b8e06315a9
+  data.tar.gz: aaf0526219d97294ea957405b0540d5b29d870d9
+SHA512:
+  metadata.gz: bdde4cdbc9c12208d6206cc280575e7beae33a914e03c2dceaa47f847660bf9e94ec1176aa4f1663e01fbf56237b7d6c8c81934ec9cab77f0adc0618e8b10762
+  data.tar.gz: 8d889d39a9830f49ddcddea8a245c2ee3c492420d68b9a020e1d24b7eb2f7066f83c4a921ed2249b16e0e977f882d4bde730e3abaa2c4381d0764c7a07ebb2c9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.*
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.0.1
+
+First version
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1 @@
+Same with Fluentd

data/README.md

@@ -0,0 +1,57 @@
+# fluent-plugin-stdout_ex
+
+Fluentd out\_stdout extension
+
+## Introduction
+
+Although the original `out_stdout` outputs log messages as:
+
+```
+2010-05-04 12:02:01 +0900 test: {"test":"test"}
+```
+
+this plugin outputs log messages as:
+
+```
+2014-05-02 02:02:21 +0900 [info]: 2010-05-04 12:02:01 +0900 test: {"test":"test"}
+```
+
+where the first time expresses the current time of *logging*, and the second time expresses the time field of messages, i.e., 
+the time when the message is created or, the time written in application logs.
+
+This behavior is very useful because we can see the latency between receiving (logging) and sending (creating) of messages.
+
+## Configuration
+
+```apache
+<match **>
+  type stdout_ex
+</match>
+```
+
+## Parameters
+
+Basically same with out\_stdout plugin. See http://docs.fluentd.org/articles/out_stdout
+
+* format ltsv
+
+   The output becomes LTSV format as followings:
+    
+   current_time:2010-05-04 12:02:01 +0900    time:2010-05-04 12:02:01 +0900    tag:test    record:{"test":"test"}
+
+## 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)
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## stdoutright
+
+* Copyright (c) 2014- Naotoshi Seo
+* See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*.rb'
+  test.verbose = true
+end
+task :default => :test
+
+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-stdout_ex.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-stdout_ex"
+  s.version     = "0.0.1"
+  s.authors     = ["Naotoshi Seo"]
+  s.email       = ["sonots@gmail.com"]
+  s.homepage    = "https://github.com/sonots/fluent-plugin-stdout_ex"
+  s.summary     = "Fluentd out_stdout extension"
+  s.description = s.summary
+  s.licenses    = ["MIT"]
+
+  s.rubyforge_project = "fluent-plugin-stdout_ex"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/out_stdout_ex.rb

@@ -0,0 +1,60 @@
+#
+# Fluent
+#
+# Copyright (C) 2011 FURUHASHI Sadayuki
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+module Fluent
+  class StdoutExOutput < Output
+    Plugin.register_output('stdout_ex', self)
+
+    OUTPUT_PROCS = {
+      :json => Proc.new {|record| Yajl.dump(record) },
+      :hash => Proc.new {|record| record.to_s },
+    }
+
+    config_param :output_type, :default => :json do |val|
+      case val.downcase
+      when 'json'
+        :json
+      when 'hash'
+        :hash
+      else
+        raise ConfigError, "stdout output output_type should be 'json' or 'hash'"
+      end
+    end
+    config_param :format, :type => :string, :default => nil
+
+    def configure(conf)
+      super
+      @output_proc = OUTPUT_PROCS[@output_type]
+      @format_proc =
+        if @format == "ltsv"
+          Proc.new {|time, tag, record| "current_time:#{Time.now.localtime}\ttime:#{Time.at(time).localtime}\ttag:#{tag}\trecord:#{@output_proc.call(record)}\n" }
+        else
+          # [info]: is a fake ;-)
+          Proc.new {|time, tag, record| "#{Time.now.localtime} [info]: #{Time.at(time).localtime} #{tag}: #{@output_proc.call(record)}\n" }
+        end
+    end
+
+    def emit(tag, es, chain)
+      es.each {|time,record|
+        $log.write @format_proc.call(time, tag, record)
+      }
+      $log.flush
+
+      chain.next
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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'
+require 'fluent/plugin/out_stdout_ex'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_stdout_ex.rb

@@ -0,0 +1,72 @@
+require 'fluent/test'
+
+class StdoutExOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::OutputTestDriver.new(Fluent::StdoutExOutput).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal :json, d.instance.output_type
+  end
+
+  def test_configure_output_type
+    d = create_driver(CONFIG + "\noutput_type json")
+    assert_equal :json, d.instance.output_type
+
+    d = create_driver(CONFIG + "\noutput_type hash")
+    assert_equal :hash, d.instance.output_type
+
+    assert_raise(Fluent::ConfigError) do
+      d = create_driver(CONFIG + "\noutput_type foo")
+    end
+  end
+
+  def test_emit_json
+    d = create_driver(CONFIG + "\noutput_type json")
+    time = Time.now
+    out = capture_log { d.emit({'test' => 'test'}, time) }
+    assert_equal "#{time.localtime} [info]: #{time.localtime} test: {\"test\":\"test\"}\n", out
+
+    # NOTE: Float::NAN is not jsonable
+    assert_raise(Yajl::EncodeError) { d.emit({'test' => Float::NAN}, time) }
+  end
+
+  def test_emit_hash
+    d = create_driver(CONFIG + "\noutput_type hash")
+    time = Time.now
+    out = capture_log { d.emit({'test' => 'test'}, time) }
+    assert_equal "#{time.localtime} [info]: #{time.localtime} test: {\"test\"=>\"test\"}\n", out
+
+    # NOTE: Float::NAN is not jsonable, but hash string can output it.
+    out = capture_log { d.emit({'test' => Float::NAN}, time) }
+    assert_equal "#{time.localtime} [info]: #{time.localtime} test: {\"test\"=>NaN}\n", out
+  end
+
+  def test_emit_ltsv
+    d = create_driver(CONFIG + "\nformat ltsv")
+    time = Time.now
+    out = capture_log { d.emit({'test' => 'test'}, time) }
+    assert_equal "current_time:#{time.localtime}\ttime:#{time.localtime}\ttag:test\trecord:{\"test\":\"test\"}\n", out
+  end
+
+  private
+
+  # Capture the log output of the block given
+  def capture_log(&block)
+    tmp = $log
+    $log = StringIO.new
+    yield
+    return $log.string
+  ensure
+    $log = tmp
+  end
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-stdout_ex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 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: 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: 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: pry-nav
+  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: Fluentd out_stdout extension
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-stdout_ex.gemspec
+- lib/fluent/plugin/out_stdout_ex.rb
+- test/helper.rb
+- test/plugin/test_out_stdout_ex.rb
+homepage: https://github.com/sonots/fluent-plugin-stdout_ex
+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: fluent-plugin-stdout_ex
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fluentd out_stdout extension
+test_files:
+- test/helper.rb
+- test/plugin/test_out_stdout_ex.rb