fluent-plugin-rewrite-tag-filter 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4e1ce31eba327c311153c8eb2e96b8aef667bca6b92f9695c7b5a3fb11e7d58
-  data.tar.gz: fc5e7682a7476dffcfdef523f06401508dcb888d3b4cff39edab742950bf9506
+  metadata.gz: a12e8f6567cd07462a236f0cda38e98bac14b921a2c7b762e9851cb04e5bf119
+  data.tar.gz: b198b1e6b8a48d386f7cc62521f358cdff745754edc8dda753ac176ced1e3e67
 SHA512:
-  metadata.gz: '018336a8cf161d92674c7845fc021f4b01a11ce0762ff555067707345671b7d7b40d63f84ce308493beb36ce90ed581c90788905bdb0c14dc62125349ebcdc31'
-  data.tar.gz: ecbd7f9591d477aba1fa776a58648e04ac085f442ec685aefbd0dc7d48160c3ca2cd819fc79bc3a59910aa8c5663d595c0339f8e7ab14f32b2d7f542667add00
+  metadata.gz: cc556895e92c3f53ca3c41af6866072e48ac53b6b170cfe163f1563d04310c8b89cc802cabefd957dab95da29362ff76164621f0a83d806619d67df521e866b6
+  data.tar.gz: 1777b76d00afe128f20da230ca26d0c30d4f62e60f4800efec6b59450040e54de7b861ee7913ed82af8f91b9f3cf5e11344b5ec5b08e57af97d611a0060d0ddf

data/README.md

@@ -52,6 +52,7 @@ For more details, see [Plugin Management](https://docs.fluentd.org/deployment/pl
   `/regexp/` is preferred because `/regexp/` style can support character classes such as `/[a-z]/`.
   The pattern without slashes will cause errors if you use patterns start with character classes.
 * **tag** (string) (required): New tag
+* **label** (string) (optional): New label. If specified, label can be changed per-rule.
 * **invert** (bool) (optional): If true, rewrite tag when unmatch pattern
   * Default value: `false`
 
@@ -300,6 +301,35 @@ It's a sample to rewrite a tag with placeholder.
 </match>
 ```
 
+### Altering Labels
+
+In addition to changing tags, you can also change event's route by setting
+ the label for the re-emitted event.
+
+For example, given this configuration:
+
+```
+<match apache.access>
+  @type rewrite_tag_filter
+  <rule>
+    key     domain
+    pattern ^www\.example\.com$
+    tag     web.${tag}
+  </rule>
+  <rule>
+    key     domain
+    pattern ^(.*)\.example\.com$
+    tag     other.$1
+    label   other
+  </rule>
+</match>
+```
+
+message: `{"domain": "www.example.com"}` will get its tag changed to 
+`web.apache.access`, while message 
+`{"domain": "api.example.com"}` will get its tag changed to `other.api` and
+ be sent to label `other`
+
 ## Example
 
 - Example1: how to analyze response_time, response_code and user_agent for each virtual domain websites.  

data/fluent-plugin-rewrite-tag-filter.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-rewrite-tag-filter"
-  s.version     = "2.3.0"
+  s.version     = "2.4.0"
   s.license     = "Apache-2.0"
   s.authors     = ["Kentaro Yoshida"]
   s.email       = ["y.ken.studio@gmail.com"]

data/lib/fluent/plugin/out_rewrite_tag_filter.rb

@@ -24,6 +24,8 @@ class Fluent::Plugin::RewriteTagFilterOutput < Fluent::Plugin::Output
     config_param :pattern, :regexp
     desc "New tag"
     config_param :tag, :string
+    desc "New label. If specified, label can be changed per-rule."
+    config_param :label, :string, default: nil
     desc "If true, rewrite tag when unmatch pattern"
     config_param :invert, :bool, default: false
   end
@@ -43,7 +45,7 @@ class Fluent::Plugin::RewriteTagFilterOutput < Fluent::Plugin::Output
       end
 
       invert = rule.invert ? MATCH_OPERATOR_EXCLUDE : ""
-      @rewriterules.push([record_accessor_create(rule.key), rule.pattern, invert, rule.tag])
+      @rewriterules.push([record_accessor_create(rule.key), rule.pattern, invert, rule.tag, rule.label])
       rewriterule_names.push(rule.key + invert + rule.pattern.to_s)
       log.info "adding rewrite_tag_filter rule: #{rule.key} #{@rewriterules.last}"
     end
@@ -75,35 +77,45 @@ class Fluent::Plugin::RewriteTagFilterOutput < Fluent::Plugin::Output
     true
   end
 
+  def get_router(tgt_label)
+    label_router = if tgt_label.nil? || tgt_label.empty?
+        router
+    else
+        event_emitter_router(tgt_label)
+    end
+    #log.trace "Got router for #{tgt_label}: #{!label_router.nil?}"
+    return label_router
+  end
+
   def process(tag, es)
     placeholder = get_placeholder(tag)
-    if @batch_mode
-      new_event_streams = Hash.new {|h, k| h[k] = Fluent::MultiEventStream.new }
-      es.each do |time, record|
-        rewrited_tag = rewrite_tag(tag, record, placeholder)
-        if rewrited_tag.nil? || tag == rewrited_tag
-          log.trace("rewrite_tag_filter: tag has not been rewritten", record)
-          next
-        end
-        new_event_streams[rewrited_tag].add(time, record)
+    new_event_streams =  Hash.new {|hh, kk| hh[kk] = Hash.new {|h, k| h[k] = Fluent::MultiEventStream.new }}if @batch_mode
+
+    es.each do |time, record|
+      rewrited_tag, rewrited_label  = rewrite_tag(tag, record, placeholder)
+      if (rewrited_tag.nil? || tag == rewrited_tag) && rewrited_label.nil?
+        log.trace("rewrite_tag_filter: tag has not been rewritten", record)
+        next
       end
-      new_event_streams.each do |rewrited_tag, new_es|
-        router.emit_stream(rewrited_tag, new_es)
+      rewrited_tag = tag if rewrited_tag.nil?
+      if new_event_streams.nil?
+        get_router(rewrited_label).emit(rewrited_tag, time, record)
+      else
+        new_event_streams[rewrited_label][rewrited_tag].add(time, record)
       end
-    else
-      es.each do |time, record|
-        rewrited_tag = rewrite_tag(tag, record, placeholder)
-        if rewrited_tag.nil? || tag == rewrited_tag
-          log.trace("rewrite_tag_filter: tag has not been rewritten", record)
-          next
+    end
+    if !new_event_streams.nil?
+      new_event_streams.each do |rewrited_label, label_event_streams |
+        labeled_router = get_router(rewrited_label)
+        label_event_streams.each do |rewrited_tag, new_es|
+            labeled_router.emit_stream(rewrited_tag, new_es)
         end
-        router.emit(rewrited_tag, time, record)
       end
     end
   end
 
   def rewrite_tag(tag, record, placeholder)
-    @rewriterules.each do |record_accessor, regexp, match_operator, rewritetag|
+    @rewriterules.each do |record_accessor, regexp, match_operator, rewritetag, rewritelabel|
       rewritevalue = record_accessor.call(record).to_s
       next if rewritevalue.empty? && match_operator != MATCH_OPERATOR_EXCLUDE
       last_match = regexp_last_match(regexp, rewritevalue)
@@ -119,9 +131,9 @@ class Fluent::Plugin::RewriteTagFilterOutput < Fluent::Plugin::Output
         log.warn "rewrite_tag_filter: unknown placeholder found. :placeholder=>#{$1} :tag=>#{tag} :rewritetag=>#{rewritetag}" unless placeholder.include?($1)
         placeholder[$1]
       end
-      return rewritetag
+      return rewritetag, rewritelabel
     end
-    return nil
+    return nil, nil
   end
 
   def regexp_last_match(regexp, rewritevalue)

data/test/plugin/test_out_rewrite_tag_filter.rb

@@ -346,6 +346,77 @@ class RewriteTagFilterOutputTest < Test::Unit::TestCase
       assert_equal "com.example", events[0][0]
     end
 
+    test "get_router" do
+      conf = %[
+        <rule>
+          key key
+          pattern /^(odd|even)$/
+          tag $1
+          label new_label
+        </rule>
+        <rule>
+          key key
+          pattern /^(.*)$/
+          tag $1
+        </rule>
+      ]
+      time = event_time
+      d = create_driver(conf)
+      assert_equal(d.instance.router, d.instance.get_router(nil))
+      assert_equal(d.instance.router, d.instance.get_router(""))
+      new_label_router = d.instance.get_router("new_label")
+      refute_equal(d.instance.router, new_label_router)
+    end
+
+    test "relabel" do
+      conf = %[
+          emit_mode record
+          <rule>
+            key key
+            pattern /^(odd)$/
+            tag $1
+            label odd_label
+          </rule>
+          <rule>
+            key key
+            pattern /^(even)$/
+            tag ${tag}
+            label even_label
+          </rule>
+          <rule>
+            key key
+            pattern /^(.*)$/
+            tag $1
+          </rule>
+        ]
+      time = event_time
+      d = create_driver(conf)
+      # Router only called for default label
+      mock.proxy(d.instance.router).emit(anything, anything, anything).times(2)
+      mock.proxy(d.instance).get_router("odd_label").times(2)
+      mock.proxy(d.instance).get_router("even_label").times(2)
+      mock.proxy(d.instance).get_router(nil).times(2)
+      mock.proxy(d.instance.router).emit_stream(anything, anything).times(0)
+      d.run(default_tag: "input") do
+        d.feed([[time, { "key" => "odd", "message" => "message-1" }],
+                [time, { "key" => "even", "message" => "message-2" }],
+                [time, { "key" => "zero", "message" => "message-3" }],
+                [time, { "key" => "odd", "message" => "message-4" }],
+                [time, { "key" => "even", "message" => "message-5" }],
+                [time, { "key" => "zero", "message" => "message-6" }]])
+      end
+      events = d.events
+      expected_events = [
+        ["odd", time, { "key" => "odd", "message" => "message-1" }],
+        ["input", time, { "key" => "even", "message" => "message-2" }],
+        ["zero", time, { "key" => "zero", "message" => "message-3" }],
+        ["odd", time, { "key" => "odd", "message" => "message-4" }],
+        ["input", time, { "key" => "even", "message" => "message-5" }],
+        ["zero", time, { "key" => "zero", "message" => "message-6" }],
+      ]
+      assert_equal(events, expected_events)
+    end
+
     sub_test_case "emit_mode" do
       test "record" do
         conf = %[

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-rewrite-tag-filter
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Kentaro Yoshida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-05 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Fluentd Output filter plugin. It has designed to rewrite tag like mod_rewrite.