fluent-plugin-formatter_sprintf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02096918dee431715480041b7b23f0040680191e
+  data.tar.gz: 92220382a6186a03b5dc37dc703d3edaac121cbd
+SHA512:
+  metadata.gz: ef617634e2246ce43a034caef558a629af61f0832073f81065fd88bed4abc4ec52542dd9476a0c10884678ed201e8c2a4ef95f97b7b37f2cc3cd67742512915b
+  data.tar.gz: 27495d9dfd9f7a088878320110905450de30106351d4805464ba6ad71fadbaa7a25079c2277b6dd50f92ab27a542d9ea848620955d742281b5898758b0cc1091

data/.gitignore

@@ -0,0 +1,14 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.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,3 @@
+## 0.0.1
+
+First version

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Hiroshi Toyama
+
+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,75 @@
+# fluent-plugin-formatter_sprintf
+
+[![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-formatter_sprintf.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-formatter_sprintf)
+
+Fluentd sprintf formatter plugin
+
+## Install
+
+Use RubyGems:
+
+```
+gem install fluent-plugin-formatter_sprintf
+```
+
+## Configuration Example
+
+`out_file` and `out_s3` plugin supports formatter plugin.
+
+### out_file
+
+```apache
+<match test.file>
+  type file
+  path /tmp/test.log
+  format sprintf
+  sprintf_format "${tag} ${time} ${url} ${ip_address}\n"
+  time_format "%Y-%m-%d %H:%M:%S"
+</match>
+```
+
+### out_s3
+
+```apache
+<match test.s3>
+  type s3
+
+  aws_key_id XXXXXXXXXXXXXXXXXX
+  aws_sec_key XXXXXXXXXXXXXXXXXX
+  s3_bucket sample-bucket
+  s3_object_key_format %{path}%{time_slice}%{index}
+  path logs/
+  buffer_path /tmp/fluent/s3
+  buffer_chunk_limit 8m
+
+  time_slice_format %Y/%m/%d/test.log.%H%M
+  time_slice_wait 1m
+  time_format %Y-%m-%d %H:%M:%S,%3N
+  store_as text
+
+  format sprintf
+  sprintf_format "${tag} ${time} ${url} ${ip_address}\n"
+
+</match>
+```
+
+### bad syntax(at error)
+
+  sprintf_format "%s ${tag} ${time} ${url} ${ip_address}\n"
+
+
+## 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) 2014 Hiroshi Toyama. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+desc 'Run test_unit based test'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = Dir["test/**/test_*.rb"].sort
+  t.verbose = true
+  #t.warning = 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-formatter_sprintf.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-formatter_sprintf"
+  s.version     = "0.0.1"
+  s.authors     = ["Hiroshi Toyama"]
+  s.email       = ["toyama0919@gmail.com"]
+  s.homepage    = "https://github.com/toyama0919/fluent-plugin-formatter_sprintf"
+  s.summary     = "Fluentd Free formatter plugin, Use sprintf."
+  s.description = s.summary
+  s.licenses    = ["MIT"]
+
+  s.rubyforge_project = "fluent-plugin-formatter_sprintf"
+
+  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 "test-unit"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/formatter_sprintf.rb

@@ -0,0 +1,42 @@
+module Fluent
+  module TextFormatter
+    class SprintfFormatter < Formatter
+      Plugin.register_formatter('sprintf', self)
+
+      include Configurable
+      include HandleTagAndTimeMixin
+
+      config_param :sprintf_format, :string
+
+      def initialize
+        super
+      end
+
+      def configure(conf)
+        super
+        @time_format = @time_format || '%Y-%m-%d %H:%M:%S'
+        r = /\$\{([^}]+)\}/
+        @keys = @sprintf_format.scan(r).map{ |key| key.first }
+        @sprintf_format = @sprintf_format.gsub(/\$\{([^}]+)\}/, '%s')
+        begin
+          @sprintf_format % @keys
+        rescue ArgumentError => e
+          raise Fluent::ConfigError, "formatter_sprintf: @sprintf_format is can't include '%'"
+        end
+      end
+
+      def format(tag, time, record)
+        values = @keys.map{ |key| 
+          if key == 'tag'
+            tag
+          elsif key == 'time'
+            Time.at(time).strftime(@time_format)
+          else
+            record[key] 
+          end
+        }
+        @sprintf_format % values
+      end
+    end
+  end
+end

data/sample/fluent.conf

@@ -0,0 +1,7 @@
+<match test.file>
+  type file
+  path /tmp/test.log
+  format sprintf
+  sprintf_format "${tag} ${time} ${url} ${ip_address}\n"
+  time_format "%Y-%m-%d_%H:%M:%S"
+</match>

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end

data/test/test_formatter_sprintf.rb

@@ -0,0 +1,45 @@
+require_relative 'helper'
+require 'fluent/formatter'
+require 'fluent/plugin/formatter_sprintf'
+
+class SprintfFormatterTest < ::Test::Unit::TestCase
+  def setup
+    @formatter = Fluent::Plugin.new_formatter('sprintf')
+    @time = Fluent::Engine.now
+  end
+
+  def configure(conf)
+  end
+
+  def test_format_space
+    @formatter.configure({'sprintf_format' => "${tag} ${url} ${ip_address}\n"})
+    tag = 'file.test'
+    record = {"url" => "/", "ip_address" => "127.0.0.1"}
+
+    formatted = @formatter.format(tag, @time, record)
+    assert_equal("file.test / 127.0.0.1\n", formatted)
+  end
+
+  def test_format_tsv
+    @formatter.configure({'sprintf_format' => "${tag}\t${url}\t${ip_address}\n"})
+    tag = 'file.test'
+    record = {"url" => "/", "ip_address" => "127.0.0.1"}
+
+    formatted = @formatter.format(tag, @time, record)
+    assert_equal("file.test\t/\t127.0.0.1\n", formatted)
+  end
+
+  def test_format_literal_error
+    assert_raise(Fluent::ConfigError) do
+      @formatter.configure({'sprintf_format' => "%s\t${url}\t${ip_address}\n"})
+    end    
+
+    assert_raise(Fluent::ConfigError) do
+      @formatter.configure({'sprintf_format' => "${url}\t${ip_address}\t%s"})
+    end    
+
+    assert_raise(Fluent::ConfigError) do
+      @formatter.configure({'sprintf_format' => "${url}\t%s\t${ip_address}\t"})
+    end    
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-formatter_sprintf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hiroshi Toyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 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: test-unit
+  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 Free formatter plugin, Use sprintf.
+email:
+- toyama0919@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-formatter_sprintf.gemspec
+- lib/fluent/plugin/formatter_sprintf.rb
+- sample/fluent.conf
+- test/helper.rb
+- test/test_formatter_sprintf.rb
+homepage: https://github.com/toyama0919/fluent-plugin-formatter_sprintf
+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-formatter_sprintf
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Fluentd Free formatter plugin, Use sprintf.
+test_files:
+- test/helper.rb
+- test/test_formatter_sprintf.rb