fluent-plugin-timestamper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6af72ca1bbf8a29b8ff8497ef45a6113774cb92
+  data.tar.gz: 6c81a92960780aa22c39e22cd8e5f45262568bbe
+SHA512:
+  metadata.gz: 34a3fe22d05f26f268095a865d2baee9095e561cc9653412656c996b79e2cb06d0ef0c5d571f700c9ee02bc470bc8d825c050d3c8b87708af84278c8a9468eb1
+  data.tar.gz: 5cadededb4609aca79fb2d9f4d71d1786b94939cef206ea82d19d6787bb9ff8ea441b6f5fb9a9cb011ad540e97e383c70681e938ee4fa50561d64476ab436be0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Masaki Matsushita
+
+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,29 @@
+# fluent-plugin-timestamper
+
+Fluentd output plugin which adds timestamp field to record.
+Timestamp format can be seconds and milliseconds from epoch, iso8601 and you can also use strftime() format.
+
+## Installation
+
+    $ gem install fluent-plugin-timestamper
+
+## Usage
+
+Put your configuration in /etc/fluent/fluent.conf
+
+```xml:fluent.conf
+<match foo>
+  type timestamper
+  tag tag.to.rewrite
+  key name_of_key
+  format milliseconds # or "seconds", "iso8601", "%Y-%m-%d"
+</match>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fluent-plugin-timestamper/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+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-plugin-timestamper.gemspec

@@ -0,0 +1,23 @@
+# 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-timestamper"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Masaki Matsushita"]
+  spec.email         = ["glass.saga@gmail.com"]
+  spec.summary       = %q{Fluentd output plugin which adds timestamp field to record in various formats.}
+  spec.homepage      = "https://github.com/Glasssaga/fluent-plugin-timestamper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "timecop"
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_timestamper.rb

@@ -0,0 +1,34 @@
+module Fluent
+  class Timestamper < Output
+    Fluent::Plugin.register_output('timestamper', self)
+
+    config_param :tag, :string
+    config_param :key, :string
+    config_param :format, :string
+
+    def configure(conf)
+      super
+    end
+
+    def emit(tag, es, chain)
+      now = Time.now
+
+      es.each do |time, record|
+        case @format
+        when "seconds"
+          record[@key] = now.to_i
+        when "milliseconds"
+          record[@key] = (now.to_i * 1000) + (now.usec / 1000.0).round
+        when "iso8601"
+          record[@key] = now.iso8601
+        else
+          record[@key] = now.strftime(@format)
+        end
+
+        Fluent::Engine.emit(@tag, time, record)
+      end
+
+      chain.next
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+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/plugin/out_timestamper'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_timestamper.rb

@@ -0,0 +1,79 @@
+require 'helper'
+require 'timecop'
+
+class TimestamperOutputTest < Test::Unit::TestCase
+  def setup
+    @time = Time.parse("2011-01-02 13:14:15 UTC")
+    @tag = "foo"
+    @key = "timestamp"
+    Timecop.freeze(@time)
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::Timestamper, tag).configure(conf)
+  end
+
+  def test_format_seconds
+    d = create_driver %[
+      tag #{@tag}
+      key #{@key}
+      format seconds
+    ]
+
+    seconds = @time.to_i
+    timestamp = pick_timestamp(d)
+    assert_equal seconds, timestamp
+  end
+
+  def test_format_milliseconds
+    d = create_driver %[
+      tag #{@tag}
+      key #{@key}
+      format milliseconds
+    ]
+
+    milliseconds = (@time.to_i * 1000) + (@time.usec / 1000.0).round
+    timestamp = pick_timestamp(d)
+    assert_equal milliseconds, timestamp
+  end
+
+  def test_format_iso8601
+    d = create_driver %[
+      tag #{@tag}
+      key #{@key}
+      format iso8601
+    ]
+
+    iso8601 = Time.now.iso8601
+    timestamp = pick_timestamp(d)
+    assert_equal iso8601, timestamp
+  end
+
+  def test_format_strftime
+    d = create_driver %[
+      tag #{@tag}
+      key #{@key}
+      format %X
+    ]
+
+    formatted = Time.now.strftime("%X")
+    timestamp = pick_timestamp(d)
+    assert_equal formatted, timestamp
+  end
+
+  private
+
+  def pick_timestamp(d)
+    d.run do
+      d.emit({"a"=>1}, @time.to_i)
+    end
+
+    record = d.emits.first.last
+    return record[@key]
+  end
+
+  def teardown
+    Timecop.return
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-timestamper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masaki Matsushita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: 
+email:
+- glass.saga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-timestamper.gemspec
+- lib/fluent/plugin/out_timestamper.rb
+- test/helper.rb
+- test/plugin/test_out_timestamper.rb
+homepage: https://github.com/Glasssaga/fluent-plugin-timestamper
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Fluentd output plugin which adds timestamp field to record in various formats.
+test_files:
+- test/helper.rb
+- test/plugin/test_out_timestamper.rb