fluent-plugin-tagged_copy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 926a7eb28787523670d075f04e8fb1899e951942
+  data.tar.gz: 117ede3f43ccf1c475b1e93ef2630d1bc55ab328
+SHA512:
+  metadata.gz: d55aad021eadd884789bad83839df945a85a66bbf936c54e632544ea02edd70298f01a9fa1cd97f480cccd36659c27d3f5584cdd869fed942bb2905c7a5ea0e0
+  data.tar.gz: 128b4977d657eba9473179b44b4c3c44919f6f7842b6d6769184a6d9358b35ee73bf2550244cd133cd408cbd03323e6b35a3e84eb35af86b58a40f57548b78fe

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,3 @@
+## 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,62 @@
+# fluent-plugin-tagged_copy
+
+## About
+
+Fluentd out\_copy extension to do tagging before passing to chained plugins
+
+## Examples
+
+```apache
+<match **>
+  type tagged_copy
+  <store>
+    <filter>
+       add_tag_prefix foo
+       remove_tag_prefix bar
+    </filter>
+    type stdout
+  </store>
+
+  <store>
+    <filter>
+       tag blah
+    </filter>
+    type stdout
+  </store>
+</match>
+```
+
+## Parameters
+
+Basically same with out\_copy plugin. See http://docs.fluentd.org/articles/out_copy
+
+But, you can specify `filter` directive with following options
+
+* tag
+
+    The tag name
+
+* add_tag_prefix
+
+    Add tag prefix for output message
+
+* remove_tag_prefix
+
+    Remove tag prefix for output message
+    
+## 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.
+
+## Copyright
+
+* 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-tagged_copy.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-tagged_copy"
+  s.version     = "0.0.1"
+  s.authors     = ["Naotoshi Seo"]
+  s.email       = ["sonots@gmail.com"]
+  s.homepage    = "https://github.com/sonots/fluent-plugin-tagged_copy"
+  s.summary     = "Fluentd out_copy extension to do tagging before copy"
+  s.description = s.summary
+
+  s.rubyforge_project = "fluent-plugin-tagged_copy"
+
+  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_tagged_copy.rb

@@ -0,0 +1,109 @@
+require 'fluent/plugin/out_copy'
+
+module Fluent
+  class TaggedCopyOutput < CopyOutput
+    Plugin.register_output('tagged_copy', self)
+
+    def initialize
+      super
+      @tag_procs = []
+    end 
+
+    # Override to handle filter:tag options
+    def configure(conf)
+      conf.elements.select {|e|
+        e.name == 'store'
+      }.each {|e|
+        type = e['type']
+        unless type
+          raise ConfigError, "Missing 'type' parameter on <store> directive"
+        end 
+        log.debug "adding store type=#{type.dump}"
+
+        f = e.elements.select {|i| i.name == 'filter'}.first || {}
+        tag_proc = generate_tag_proc(f['tag'], f['add_tag_prefix'], f['remove_tag_prefix'])
+        @tag_procs << tag_proc
+
+        output = Plugin.new_output(type)
+        output.configure(e)
+        @outputs << output
+      }
+    end
+
+    # Override to use TaggedOutputChain
+    def emit(tag, es, chain)
+      unless es.repeatable?
+        m = MultiEventStream.new
+        es.each {|time,record|
+          m.add(time, record)
+        }   
+        es = m 
+      end 
+      if @deep_copy
+        chain = TaggedCopyOutputChain.new(@outputs, @tag_procs, tag, es, chain)
+      else
+        chain = TaggedOutputChain.new(@outputs, @tag_procs, tag, es, chain)
+      end 
+      chain.next
+    end
+
+    private
+
+    def generate_tag_proc(tag, add_tag_prefix, remove_tag_prefix)
+      tag_prefix = "#{add_tag_prefix}." if add_tag_prefix
+      tag_prefix_match = "#{remove_tag_prefix}." if remove_tag_prefix
+      if tag
+        Proc.new {|t| tag }
+      elsif tag_prefix and tag_prefix_match
+        Proc.new {|t| "#{tag_prefix}#{lstrip(t, tag_prefix_match)}" }
+      elsif tag_prefix_match
+        Proc.new {|t| lstrip(t, tag_prefix_match) }
+      elsif tag_prefix
+        Proc.new {|t| "#{tag_prefix}#{t}" }
+      else
+        Proc.new {|t| t }
+      end
+    end
+
+    def lstrip(string, substring)
+      string.index(substring) == 0 ? string[substring.size..-1] : string
+    end
+  end 
+
+  class TaggedOutputChain
+    def initialize(array, tag_procs, tag, es, chain=NullOutputChain.instance)
+      @array = array
+      @tag_procs = tag_procs
+      @tag = tag
+      @es = es
+      @offset = 0
+      @chain = chain
+    end   
+        
+    def next
+      if @array.length <= @offset
+        return @chain.next
+      end
+      @offset += 1
+      emit_tag = @tag_procs[@offset-1].call(@tag) # added
+      result = @array[@offset-1].emit(emit_tag, @es, self)
+      result
+    end
+  end
+      
+  class TaggedCopyOutputChain < TaggedOutputChain
+    def next
+      if @array.length <= @offset
+        return @chain.next
+      end
+      @offset += 1
+      es = @array.length > @offset ? @es.dup : @es
+      emit_tag = @tag_procs[@offset-1].call(@tag) # added
+      result = @array[@offset-1].emit(emit_tag, es, self)
+      result
+    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_tagged_copy'
+
+class Test::Unit::TestCase
+end

data/test/plugin/out_tagged_copy.rb

@@ -0,0 +1,281 @@
+require_relative '../helper'
+
+class TaggedCopyOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    <store>
+      type test
+      name c0
+    </store>
+    <store>
+      type test
+      name c1
+    </store>
+    <store>
+      type test
+      name c2
+    </store>
+  ]
+
+  def create_driver(conf = CONFIG, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(Fluent::TaggedCopyOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+
+    outputs = d.instance.outputs
+    assert_equal 3, outputs.size
+    assert_equal Fluent::TestOutput, outputs[0].class
+    assert_equal Fluent::TestOutput, outputs[1].class
+    assert_equal Fluent::TestOutput, outputs[2].class
+    assert_equal "c0", outputs[0].name
+    assert_equal "c1", outputs[1].name
+    assert_equal "c2", outputs[2].name
+  end
+
+  def test_emit
+    d = create_driver
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    d.emit({"a"=>1}, time)
+    d.emit({"a"=>2}, time)
+
+    d.instance.outputs.each {|o|
+      assert_equal [
+          [time, {"a"=>1}],
+          [time, {"a"=>2}],
+        ], o.events
+    }
+  end
+
+  def test_msgpack_es_emit_bug
+    d = Fluent::Test::OutputTestDriver.new(Fluent::CopyOutput)
+
+    outputs = %w(p1 p2).map do |pname|
+      p = Fluent::Plugin.new_output('test')
+      p.configure('name' => pname)
+      p.define_singleton_method(:emit) do |tag, es, chain|
+        es.each do |time, record|
+          super(tag, [[time, record]], chain)
+        end
+      end
+      p
+    end
+
+    d.instance.instance_eval { @outputs = outputs }
+
+    es = if defined?(MessagePack::Packer)
+           time = Time.parse("2013-05-26 06:37:22 UTC").to_i
+           packer = MessagePack::Packer.new
+           packer.pack([time, {"a" => 1}])
+           packer.pack([time, {"a" => 2}])
+           Fluent::MessagePackEventStream.new(packer.to_s)
+         else
+           events = "#{[time, {"a" => 1}].to_msgpack}#{[time, {"a" => 2}].to_msgpack}"
+           Fluent::MessagePackEventStream.new(events)
+         end
+
+    d.instance.emit('test', es, Fluent::NullOutputChain.instance)
+
+    d.instance.outputs.each { |o|
+      assert_equal [
+        [time, {"a"=>1}],
+        [time, {"a"=>2}],
+      ], o.events
+    }
+  end
+
+  def create_event_test_driver(is_deep_copy = false)
+    deep_copy_config = %[
+      deep_copy true
+    ]
+
+    output1 = Fluent::Plugin.new_output('test')
+    output1.configure('name' => 'output1')
+    output1.define_singleton_method(:emit) do |tag, es, chain|
+      es.each do |time, record|
+        record['foo'] = 'bar'
+        super(tag, [[time, record]], chain)
+      end
+    end
+
+    output2 = Fluent::Plugin.new_output('test')
+    output2.configure('name' => 'output2')
+    output2.define_singleton_method(:emit) do |tag, es, chain|
+      es.each do |time, record|
+        super(tag, [[time, record]], chain)
+      end
+    end
+
+    outputs = [output1, output2]
+
+    d = Fluent::Test::OutputTestDriver.new(Fluent::CopyOutput)
+    d = d.configure(deep_copy_config) if is_deep_copy
+    d.instance.instance_eval { @outputs = outputs }
+    d
+  end
+
+  def test_one_event
+    time = Time.parse("2013-05-26 06:37:22 UTC").to_i
+
+    d = create_event_test_driver(false)
+    es = Fluent::OneEventStream.new(time, {"a" => 1})
+    d.instance.emit('test', es, Fluent::NullOutputChain.instance)
+
+    assert_equal [
+      [[time, {"a"=>1, "foo"=>"bar"}]],
+      [[time, {"a"=>1, "foo"=>"bar"}]]
+    ], d.instance.outputs.map{ |o| o.events }
+
+    d = create_event_test_driver(true)
+    es = Fluent::OneEventStream.new(time, {"a" => 1})
+    d.instance.emit('test', es, Fluent::NullOutputChain.instance)
+
+    assert_equal [
+      [[time, {"a"=>1, "foo"=>"bar"}]],
+      [[time, {"a"=>1}]]
+    ], d.instance.outputs.map{ |o| o.events }
+  end
+
+  def test_multi_event
+    time = Time.parse("2013-05-26 06:37:22 UTC").to_i
+
+    d = create_event_test_driver(false)
+    es = Fluent::MultiEventStream.new
+    es.add(time, {"a" => 1})
+    es.add(time, {"b" => 2})
+    d.instance.emit('test', es, Fluent::NullOutputChain.instance)
+
+    assert_equal [
+      [[time, {"a"=>1, "foo"=>"bar"}], [time, {"b"=>2, "foo"=>"bar"}]],
+      [[time, {"a"=>1, "foo"=>"bar"}], [time, {"b"=>2, "foo"=>"bar"}]]
+    ], d.instance.outputs.map{ |o| o.events }
+
+    d = create_event_test_driver(true)
+    es = Fluent::MultiEventStream.new
+    es.add(time, {"a" => 1})
+    es.add(time, {"b" => 2})
+    d.instance.emit('test', es, Fluent::NullOutputChain.instance)
+
+    assert_equal [
+      [[time, {"a"=>1, "foo"=>"bar"}], [time, {"b"=>2, "foo"=>"bar"}]],
+      [[time, {"a"=>1}], [time, {"b"=>2}]]
+    ], d.instance.outputs.map{ |o| o.events }
+  end
+
+  ## Belows are special tests for tagged_copy
+
+  def test_tag_emit
+    config = %[
+      <store>
+        <filter>
+          tag first
+        </filter>
+        type test
+        name c0
+      </store>
+      <store>
+        <filter>
+          tag second
+        </filter>
+        type test
+        name c0
+      </store>
+    ]
+    d = create_driver(config)
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    d.emit({"a"=>1}, time)
+    d.emit({"a"=>2}, time)
+
+    first = d.instance.outputs.first
+    assert_equal [
+      ['first', time, {"a"=>1}],
+      ['first', time, {"a"=>2}],
+    ], first.emits
+
+    second = d.instance.outputs[1]
+    assert_equal [
+      ['second', time, {"a"=>1}],
+      ['second', time, {"a"=>2}],
+    ], second.emits
+  end
+
+  def test_add_tag_prefix_emit
+    config = %[
+      <store>
+        <filter>
+          add_tag_prefix first
+        </filter>
+        type test
+        name c0
+      </store>
+      <store>
+        <filter>
+          add_tag_prefix second
+        </filter>
+        type test
+        name c0
+      </store>
+    ]
+    d = create_driver(config)
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    d.emit({"a"=>1}, time)
+    d.emit({"a"=>2}, time)
+
+    first = d.instance.outputs.first
+    assert_equal [
+      ['first.test', time, {"a"=>1}],
+      ['first.test', time, {"a"=>2}],
+    ], first.emits
+
+    second = d.instance.outputs[1]
+    assert_equal [
+      ['second.test', time, {"a"=>1}],
+      ['second.test', time, {"a"=>2}],
+    ], second.emits
+  end
+
+  def test_remove_tag_prefix_emit
+    config = %[
+      <store>
+        <filter>
+          remove_tag_prefix first
+        </filter>
+        type test
+        name c0
+      </store>
+      <store>
+        <filter>
+          remove_tag_prefix second
+        </filter>
+        type test
+        name c0
+      </store>
+    ]
+    d = create_driver(config)
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    d.tag = 'first.test'
+    d.emit({"a"=>1}, time)
+    d.tag = 'second.test'
+    d.emit({"a"=>2}, time)
+
+    first = d.instance.outputs.first
+    assert_equal [
+      ['test', time, {"a"=>1}],
+      ['second.test', time, {"a"=>2}],
+    ], first.emits
+
+    second = d.instance.outputs[1]
+    assert_equal [
+      ['first.test', time, {"a"=>1}],
+      ['test', time, {"a"=>2}],
+    ], second.emits
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-tagged_copy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 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_copy extension to do tagging before copy
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-tagged_copy.gemspec
+- lib/fluent/plugin/out_tagged_copy.rb
+- test/helper.rb
+- test/plugin/out_tagged_copy.rb
+homepage: https://github.com/sonots/fluent-plugin-tagged_copy
+licenses: []
+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-tagged_copy
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Fluentd out_copy extension to do tagging before copy
+test_files:
+- test/helper.rb
+- test/plugin/out_tagged_copy.rb