fluent-plugin-route 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28b027ad4681954b9a1dcf70606fb8ef5d1d7fbf
-  data.tar.gz: c188b4c04cc03713a510a43ade56f28b883dc1d7
+  metadata.gz: 2be56e0033b180819f2229b3c61e6124d4422cbf
+  data.tar.gz: 27bdc280417b08b926ca3c5bb5939d2f8e0aca95
 SHA512:
-  metadata.gz: 6d6fecf7cadba4e6bbafd40d4f3efd56b7042325fbee3bbb937356aa063162209138fa5527c531e363225fddf3af0a566dfff1963add108ee5055f87596b918f
-  data.tar.gz: 3e59efff70c9bbdbd8ebc5c4f3ceaec77fc7e1ceb9ff4903d67e5ce856e0ba2d3a832ba4c0f7b4f52734da17254b0aa422e7612add54ca9bae177bfc6308cf1f
+  metadata.gz: 64b121f1fe16c1b2d23be44bc5dcc6acc17b9db331c50e272f0886e9153311fe56a936f832c5988d567b05753ab33d953a1fd74d5895f20e6231be497574a770
+  data.tar.gz: aca7e79d483a1d2799649410724beee7616d56fb090c9a7502d3985bfb66d2fa51da8b6aee9d688b807e17008b86b22ef727f6962e30f94d279ddd69650cead6

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.1

data/README.md

@@ -4,14 +4,14 @@
 
 ## Configuration
 
-Configuration example:
+### Example 1: Use only tag
 
     <match worker.**>
-      type route
+      @type route
       remove_tag_prefix worker
       <route **>
         add_tag_prefix metrics.event
-        copy
+        copy # For fall-through. Without copy, routing is stopped here. 
       </route>
       <route **>
         add_tag_prefix backup
@@ -20,14 +20,40 @@ Configuration example:
     </match>
 
     <match metrics.event.**>
-      type stdout
+      @type stdout
     </match>
 
     <match backup.**>
-      type file
+      @type file
       path /var/log/fluent/bakcup
     </match>
 
+### Example 2: Use label
+
+    <match worker.**>
+      @type route
+      remove_tag_prefix worker
+      add_tag_prefix metrics.event
+      <route **>
+        copy
+      </route>
+      <route **>
+        copy
+        @label @BACKUP
+      </route>
+    </match>
+
+    <match metrics.event.**>
+      @type stdout
+    </match>
+
+    <label @BACKUP>
+      <match metrics.event.**>
+        @type file
+        path /var/log/fluent/bakcup
+      </match>
+    </label>
+
 ## TODO
 
 * tests

data/Rakefile

@@ -1,2 +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-route.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-route"
-  gem.version       = "0.1.3"
+  gem.version       = "0.1.4"
   gem.authors       = ["TAGOMORI Satoshi", "FURUHASHI Sadayuki"]
   gem.email         = ["tagomoris@gmail.com", "frsyuki@gmail.com"]
   gem.summary       = %q{Fluentd plugin to route messages in fluentd processes}
@@ -15,5 +15,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency "fluentd"
-  gem.add_runtime_dependency "fluent-mixin-config-placeholders", ">= 0.3.0"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "test-unit"
 end

data/lib/fluent/plugin/out_route.rb

@@ -15,42 +15,99 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 #
-require 'fluent/mixin/config_placeholders'
+require 'fluent/output'
 
 module Fluent
+  class RouteOutput < MultiOutput
+    Plugin.register_output('route', self)
 
+    class Route
+      include Configurable
 
-class RouteOutput < MultiOutput
-  Plugin.register_output('route', self)
+      config_param :remove_tag_prefix, :string, :default => nil
+      config_param :add_tag_prefix, :string, :default => nil
+      # TODO tag_transform regexp
+      attr_accessor :copy
 
-  include Fluent::Mixin::ConfigPlaceholders
+      def initialize(pattern, router)
+        super()
+        if !pattern || pattern.empty?
+          pattern = '**'
+        end
+        @router = router
+        @pattern = MatchPattern.create(pattern)
+        @tag_cache = {}
+      end
+
+      def match?(tag)
+        @pattern.match(tag)
+      end
+
+      def configure(conf)
+        super
+        if conf['copy']
+          @copy = true
+        else
+          @copy = false
+        end
+        if label_name = conf['@label']
+          label = Fluent::Engine.root_agent.find_label(label_name)
+          @router = label.event_router
+        end
+        if @remove_tag_prefix
+          @prefix_match = /^#{Regexp.escape(@remove_tag_prefix)}\.?/
+        else
+          @prefix_match = //
+        end
+        if @add_tag_prefix
+          @tag_prefix = "#{@add_tag_prefix}."
+        else
+          @tag_prefix = ""
+        end
+      end
+
+      def copy?
+        @copy
+      end
+
+      def emit(tag, es)
+        ntag = @tag_cache[tag]
+        unless ntag
+          ntag = tag.sub(@prefix_match, @tag_prefix)
+          if @tag_cache.size < 1024  # TODO size limit
+            @tag_cache[tag] = ntag
+          end
+        end
+        @router.emit_stream(ntag, es)
+      end
+    end
 
-  class Route
-    include Configurable
+    def initialize
+      super
+      @routes = []
+      @tag_cache = {}
+      @match_cache = {}
+    end
 
     config_param :remove_tag_prefix, :string, :default => nil
     config_param :add_tag_prefix, :string, :default => nil
     # TODO tag_transform regexp
-    attr_accessor :copy
 
-    def initialize(pattern)
-      super()
-      if !pattern || pattern.empty?
-        pattern = '**'
-      end
-      @pattern = MatchPattern.create(pattern)
-      @tag_cache = {}
+    attr_reader :routes
+
+    # Define `log` method for v0.10.42 or earlier
+    unless method_defined?(:log)
+      define_method("log") { $log }
     end
 
-    def match?(tag)
-      @pattern.match(tag)
+    # Define `router` method of v0.12 to support v0.10 or earlier
+    unless method_defined?(:router)
+      define_method("router") { ::Fluent::Engine }
     end
 
     def configure(conf)
       super
-      if conf['copy']
-        @copy = true
-      end
+
       if @remove_tag_prefix
         @prefix_match = /^#{Regexp.escape(@remove_tag_prefix)}\.?/
       else
@@ -61,103 +118,51 @@ class RouteOutput < MultiOutput
       else
         @tag_prefix = ""
       end
-    end
 
-    def copy?
-      @copy
+      conf.elements.select {|e|
+        e.name == 'route'
+      }.each {|e|
+        route = Route.new(e.arg, router)
+        route.configure(e)
+        @routes << route
+      }
     end
 
-    def emit(tag, es)
-      ntag = @tag_cache[tag]
-      unless ntag
+    def emit(tag, es, chain)
+      ntag, targets = @match_cache[tag]
+      unless targets
         ntag = tag.sub(@prefix_match, @tag_prefix)
-        if @tag_cache.size < 1024  # TODO size limit
-          @tag_cache[tag] = ntag
+        targets = []
+        @routes.each {|r|
+          if r.match?(ntag)
+            targets << r
+            break unless r.copy?
+          end
+        }
+        if @match_cache.size < 1024  # TODO size limit
+          @match_cache[tag] = [ntag, targets]
         end
       end
-      Engine.emit_stream(ntag, es)
-    end
-  end
-
-  def initialize
-    super
-    @routes = []
-    @tag_cache = {}
-    @match_cache = {}
-  end
-
-  config_param :remove_tag_prefix, :string, :default => nil
-  config_param :add_tag_prefix, :string, :default => nil
-  # TODO tag_transform regexp
-
-  attr_reader :routes
-
-  # Define `log` method for v0.10.42 or earlier
-  unless method_defined?(:log)
-    define_method("log") { $log }
-  end
-
-  def configure(conf)
-    super
-
-    if @remove_tag_prefix
-      @prefix_match = /^#{Regexp.escape(@remove_tag_prefix)}\.?/
-    else
-      @prefix_match = //
-    end
-    if @add_tag_prefix
-      @tag_prefix = "#{@add_tag_prefix}."
-    else
-      @tag_prefix = ""
-    end
 
-    conf.elements.select {|e|
-      e.name == 'route'
-    }.each {|e|
-      route = Route.new(e.arg)
-      route.configure(e)
-      @routes << route
-    }
-  end
-
-  def emit(tag, es, chain)
-    ntag, targets = @match_cache[tag]
-    unless targets
-      ntag = tag.sub(@prefix_match, @tag_prefix)
-      targets = []
-      @routes.each {|r|
-        if r.match?(ntag)
-          targets << r
-          break unless r.copy?
+      case targets.size
+      when 0
+        return
+      when 1
+        targets.first.emit(ntag, es)
+        chain.next
+      else
+        unless es.repeatable?
+          m = MultiEventStream.new
+          es.each {|time,record|
+            m.add(time, record)
+          }
+          es = m
         end
-      }
-      if @match_cache.size < 1024  # TODO size limit
-        @match_cache[tag] = [ntag, targets]
-      end
-    end
-
-    case targets.size
-    when 0
-      return
-    when 1
-      targets.first.emit(ntag, es)
-      chain.next
-    else
-      unless es.repeatable?
-        m = MultiEventStream.new
-        es.each {|time,record|
-          m.add(time, record)
+        targets.each {|t|
+          t.emit(ntag, es)
         }
-        es = m
+        chain.next
       end
-      targets.each {|t|
-        t.emit(ntag, es)
-      }
-      chain.next
     end
   end
 end
-
-
-end
-

data/test/plugin/test_out_route.rb

@@ -0,0 +1,91 @@
+require 'fluent/test'
+require 'fluent/plugin/out_route'
+
+class RouteOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    remove_tag_prefix t
+    <route t1.*>
+      remove_tag_prefix t1
+      add_tag_prefix yay
+    </route>
+    <route t2.*>
+      remove_tag_prefix t2
+      add_tag_prefix foo
+    </route>
+    <route **>
+      @label @primary
+      copy
+    </route>
+    <route **>
+      @label @backup
+    </route>
+  ]
+
+  def create_driver(conf, tag)
+    d = Fluent::Test::OutputTestDriver.new(Fluent::RouteOutput, tag)
+    Fluent::Engine.root_agent.define_singleton_method(:find_label) do |label_name|
+      obj = Object.new
+      obj.define_singleton_method(:event_router){ d.instance.router } # for test...
+      obj
+    end
+    d.configure(conf, true)
+  end
+
+  def test_configure
+    # TODO: write
+  end
+
+  def test_emit_t1
+    d = create_driver(CONFIG, "t.t1.test")
+
+    time = Time.parse("2011-11-11 11:11:11 UTC").to_i
+    d.run do
+      d.emit({"a" => 1}, time)
+      d.emit({"a" => 2}, time)
+    end
+
+    emits = d.emits
+    assert_equal 2, emits.size
+
+    assert_equal ["yay.test", time, {"a" => 1}], emits[0]
+    assert_equal ["yay.test", time, {"a" => 2}], emits[1]
+  end
+
+  def test_emit_t2
+    d = create_driver(CONFIG, "t.t2.test")
+
+    time = Time.parse("2011-11-11 11:11:11 UTC").to_i
+    d.run do
+      d.emit({"a" => 1}, time)
+      d.emit({"a" => 2}, time)
+    end
+
+    emits = d.emits
+    assert_equal 2, emits.size
+
+    assert_equal ["foo.test", time, {"a" => 1}], emits[0]
+    assert_equal ["foo.test", time, {"a" => 2}], emits[1]
+  end
+
+  def test_emit_others
+    d = create_driver(CONFIG, "t.t3.test")
+
+    time = Time.parse("2011-11-11 11:11:11 UTC").to_i
+    d.run do
+      d.emit({"a" => 1}, time)
+      d.emit({"a" => 2}, time)
+    end
+
+    emits = d.emits
+    assert_equal 4, emits.size
+
+    assert_equal ["t3.test", time, {"a" => 1}], emits[0]
+    assert_equal ["t3.test", time, {"a" => 1}], emits[1]
+    assert_equal ["t3.test", time, {"a" => 2}], emits[2]
+    assert_equal ["t3.test", time, {"a" => 2}], emits[3]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-route
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - TAGOMORI Satoshi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -26,19 +26,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fluent-mixin-config-placeholders
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        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'
 description: This is copy of out_route.rb originally written by frsyuki
 email:
 - tagomoris@gmail.com
@@ -48,12 +62,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - fluent-plugin-route.gemspec
 - lib/fluent/plugin/out_route.rb
+- test/plugin/test_out_route.rb
 homepage: https://github.com/tagomoris/fluent-plugin-route
 licenses:
 - APLv2
@@ -74,9 +90,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Fluentd plugin to route messages in fluentd processes
-test_files: []
+test_files:
+- test/plugin/test_out_route.rb
 has_rdoc: