fluent-plugin-delay-inspector 0.0.1

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-plugin-delay-inspector.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,45 @@
+# fluent-plugin-delay-inspector
+
+## DelayInspectorOutput
+
+Fluentd plugin to inspect diff of real-time and log-time, and emit message as:
+
+* new message with single key-value pair (DEFAULT)
+* whole message with original attributes and injected delay information (with `reserve_data true`)
+
+## Configuration
+
+To get delay information only with specified tag `delayinfo` and key name `delay`(default):
+
+    <match message.whatever.**>
+      type delay_inspector
+      tag  delayinfo
+    </match>
+
+Specify `remove_prefix` and/or `add_prefix` to get tags based on original tag:
+
+    <match message.whatever.**>
+      type delay_inspector
+      remove_prefix message
+      add_prefix    delayinfo        #=> get tags as: 'delayinfo.whatever.you.want'
+    </match>
+
+To add delay info into original messages with specified key name (and pass these to other plugins):
+
+    <match raw.message.whatever.**>
+      type delay_inspector
+      remove_prefix raw
+      key_name      delay_seconds
+      reserve_data  yes
+    </match>
+
+## TODO
+
+* patches welcome!
+
+## Copyright
+
+* Copyright
+  * Copyright (c) 2012- TAGOMORI Satoshi (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-plugin-delay-inspector.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-delay-inspector"
+  gem.version       = "0.0.1"
+  gem.authors       = ["TAGOMORI Satoshi"]
+  gem.email         = ["tagomoris@gmail.com"]
+  gem.summary       = %q{Fluentd plugin to inspect diff of real-time and log-time}
+  gem.description   = %q{Inspect delay of log, and emit it, or inject it into message itself with specified attribute name}
+  gem.homepage      = "https://github.com/tagomoris/fluent-plugin-delay-inspector"
+
+  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_development_dependency "rake"
+  gem.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_delay_inspector.rb

@@ -0,0 +1,58 @@
+class Fluent::DelayInspectorOutput < Fluent::Output
+  Fluent::Plugin.register_output('delay_inspector', self)
+
+  config_param :tag, :string, :default => nil
+  config_param :remove_prefix, :string, :default => nil
+  config_param :add_prefix, :string, :default => nil
+
+  config_param :key_name, :string, :default => 'delay'
+  config_param :reserve_data, :bool, :default => false
+
+  def configure(conf)
+    super
+
+    if not @tag and not @remove_prefix and not @add_prefix
+      raise Fluent::ConfigError, "missing both of remove_prefix and add_prefix"
+    end
+    if @tag and (@remove_prefix or @add_prefix)
+      raise Fluent::ConfigError, "both of tag and remove_prefix/add_prefix must not be specified"
+    end
+    if @remove_prefix
+      @removed_prefix_string = @remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+    if @add_prefix
+      @added_prefix_string = @add_prefix + '.'
+    end
+  end
+
+  def emit(tag, es, chain)
+    tag = if @tag
+            @tag
+          else
+            if @remove_prefix and
+                ( (tag.start_with?(@removed_prefix_string) and tag.length > @removed_length) or tag == @remove_prefix)
+              tag = tag[@removed_length..-1]
+            end 
+            if @add_prefix
+              tag = if tag and tag.length > 0
+                      @added_prefix_string + tag
+                    else
+                      @add_prefix
+                    end
+            end     
+            tag
+          end
+    if @reserve_data
+      es.each do |time,record|
+        record[@key_name] = Fluent::Engine.now - time
+        Fluent::Engine.emit(tag, time, record)
+      end
+    else
+      es.each do |time,record|
+        Fluent::Engine.emit(tag, time, {@key_name => (Fluent::Engine.now - time)})
+      end
+    end
+    chain.next
+  end
+end

data/test/helper.rb

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

data/test/plugin/test_out_delay_inspector.rb

@@ -0,0 +1,110 @@
+require 'helper'
+
+class DelayInspectorOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG1 = %[
+    tag delay.info
+  ]
+  CONFIG2 = %[
+    add_prefix fixed
+    key_name delayinfo
+  ]
+  CONFIG3 = %[
+    remove_prefix before
+    add_prefix after
+    reserve_data true
+  ]
+
+  def create_driver(conf=CONFIG1, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::DelayInspectorOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    assert_nothing_raised {
+      d = create_driver %[
+        tag foo
+      ]
+    }
+    assert_nothing_raised {
+      d = create_driver %[
+        remove_prefix bar
+      ]
+    }
+
+    d = create_driver
+    assert_equal 'delay', d.instance.key_name
+    assert_equal false, d.instance.reserve_data
+
+    d3 = create_driver(CONFIG3)
+    assert_equal true, d3.instance.reserve_data
+  end
+
+  def test_emit1
+    d1 = create_driver(CONFIG1, 'whatever')
+    time = Time.now.to_i - 3
+    d1.run do
+      d1.emit({'foo' => 'bar', 'baz' => 'boo'}, time)
+      d1.emit({'foo' => 'bar', 'baz' => 'boo'}, time)
+    end
+    emits = d1.emits
+    assert_equal 2, emits.length
+
+    assert_equal 'delay.info', emits[0][0]
+    assert_equal time, emits[0][1]
+    assert_equal ['delay'], emits[0][2].keys
+    assert ( 3 <= emits[0][2]['delay'].to_i && emits[0][2]['delay'] <= 4 )
+
+    assert_equal 'delay.info', emits[1][0]
+    assert_equal time, emits[1][1]
+    assert_equal ['delay'], emits[1][2].keys
+    assert ( 3 <= emits[1][2]['delay'].to_i && emits[1][2]['delay'] <= 4 )
+  end
+
+  def test_emit2
+    d1 = create_driver(CONFIG2, 'whatever')
+    time = Time.now.to_i - 3
+    d1.run do
+      d1.emit({'foo' => 'bar', 'baz' => 'boo'}, time)
+      d1.emit({'foo' => 'bar', 'baz' => 'boo'}, time)
+    end
+    emits = d1.emits
+    assert_equal 2, emits.length
+
+    assert_equal 'fixed.whatever', emits[0][0]
+    assert_equal time, emits[0][1]
+    assert_equal ['delayinfo'], emits[0][2].keys
+    assert ( 3 <= emits[0][2]['delayinfo'].to_i && emits[0][2]['delayinfo'] <= 4 )
+
+    assert_equal 'fixed.whatever', emits[1][0]
+    assert_equal time, emits[1][1]
+    assert_equal ['delayinfo'], emits[1][2].keys
+    assert ( 3 <= emits[1][2]['delayinfo'].to_i && emits[1][2]['delayinfo'] <= 4 )
+  end
+
+  def test_emit3
+    d1 = create_driver(CONFIG3, 'before.whatever')
+    time = Time.now.to_i - 3
+    d1.run do
+      d1.emit({'foo' => 'bar', 'baz' => 'boo'}, time)
+      d1.emit({'foo' => 'bar', 'baz' => 'boo'}, time)
+    end
+    emits = d1.emits
+    assert_equal 2, emits.length
+
+    assert_equal 'after.whatever', emits[0][0]
+    assert_equal time, emits[0][1]
+    assert_equal ['baz', 'delay', 'foo'], emits[0][2].keys.sort
+    assert ( 3 <= emits[0][2]['delay'].to_i && emits[0][2]['delay'] <= 4 )
+
+    assert_equal 'after.whatever', emits[1][0]
+    assert_equal time, emits[1][1]
+    assert_equal ['baz', 'delay', 'foo'], emits[0][2].keys.sort
+    assert ( 3 <= emits[1][2]['delay'].to_i && emits[1][2]['delay'] <= 4 )
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-delay-inspector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-14 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: rake
+  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: Inspect delay of log, and emit it, or inject it into message itself with
+  specified attribute name
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-delay-inspector.gemspec
+- lib/fluent/plugin/out_delay_inspector.rb
+- test/helper.rb
+- test/plugin/test_out_delay_inspector.rb
+homepage: https://github.com/tagomoris/fluent-plugin-delay-inspector
+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: Fluentd plugin to inspect diff of real-time and log-time
+test_files:
+- test/helper.rb
+- test/plugin/test_out_delay_inspector.rb