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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8253bb2b1859438ea797e1fd2046d0b18290a424b340de8a88524b9afd33388a
-  data.tar.gz: 33e91a5b0570810f2ad802885df4a7e87eb03c4816b5779d847c5004b25afb0a
+  metadata.gz: a4e1ce31eba327c311153c8eb2e96b8aef667bca6b92f9695c7b5a3fb11e7d58
+  data.tar.gz: fc5e7682a7476dffcfdef523f06401508dcb888d3b4cff39edab742950bf9506
 SHA512:
-  metadata.gz: f28d04ee233a9bfdd668f5dc114b7e9b7d5531d275d1c5318100d4a76171607ddf9e03041081b139ba2f7a55b6b73bdbf64c44cae67097df983ae80395d04e69
-  data.tar.gz: 4e6ee684e6da26e6d0e449cc0650dd482f9cbd5cd6623d540bb63b1b991e48f0ede38f9424f04ef8750e6d7f451afa62c89bda412e3bff66589b3101407414d3
+  metadata.gz: '018336a8cf161d92674c7845fc021f4b01a11ce0762ff555067707345671b7d7b40d63f84ce308493beb36ce90ed581c90788905bdb0c14dc62125349ebcdc31'
+  data.tar.gz: ecbd7f9591d477aba1fa776a58648e04ac085f442ec685aefbd0dc7d48160c3ca2cd819fc79bc3a59910aa8c5663d595c0339f8e7ab14f32b2d7f542667add00

data/.travis.yml

@@ -1,10 +1,10 @@
 language: ruby
 
 rvm:
-  - 2.4.2
-  - 2.3.5
-  - 2.2
-  - 2.1
+  - 2.7.0
+  - 2.6.5
+  - 2.5.7
+  - 2.4.9
 
 # to avoid travis-ci issue since 2015-12-25
 before_install:

data/README.md

@@ -3,7 +3,7 @@
 ## Overview
 
 Rewrite Tag Filter for [Fluentd](http://fluentd.org). It is designed to rewrite tags like mod_rewrite.  
-Re-emit the record with rewrited tag when a value matches/unmatches with a regular expression.  
+Re-emit the record with rewritten tag when a value matches/unmatches with a regular expression.  
 Also you can change a tag from Apache log by domain, status code (ex. 500 error),  
 user-agent, request-uri, regex-backreference and so on with regular expression.
 
@@ -31,7 +31,7 @@ $ sudo td-agent-gem install fluent-plugin-rewrite-tag-filter -v 1.6.0
 $ sudo td-agent-gem install fluent-plugin-rewrite-tag-filter
 ```
 
-For more details, see [Plugin Management](https://docs.fluentd.org/v0.14/articles/plugin-management)
+For more details, see [Plugin Management](https://docs.fluentd.org/deployment/plugin-management)
 
 ## Configuration
 
@@ -200,7 +200,7 @@ When original tag is `kubernetes.var.log`, this will be converted to `default.ku
 
 ### Tag placeholder
 
-It is supported these placeholder for new_tag (rewrited tag).
+It is supported these placeholder for new_tag (rewritten tag).
 
 - `${tag}`
 - `__TAG__`
@@ -214,12 +214,16 @@ For example with `td.apache.access` tag, it will get `td` by `${tag_parts[0]}` a
 
 **Note** Currently, range expression ```${tag_parts[0..2]}``` is not supported.
 
-#### Placeholder Option
+#### Placeholder Options
 
 * `remove_tag_prefix`  
 
 This option adds removing tag prefix for `${tag}` or `__TAG__` in placeholder.
 
+* `remove_tag_regexp`  
+
+This option adds removing tag regexp for `${tag}` or `__TAG__` in placeholder.
+
 * `hostname_command` 
 
 By default, execute command as `hostname` to get full hostname.  
@@ -231,45 +235,67 @@ It comes short hostname with `hostname_command hostname -s` configuration specif
 It's a sample to rewrite a tag with placeholder.
 
 ```
-# It will get "rewrited.access.ExampleMail"
+# It will get "rewritten.access.ExampleMail"
 <match apache.access>
   @type rewrite_tag_filter
   remove_tag_prefix apache
   <rule>
     key     domain
     pattern ^(mail)\.(example)\.com$
-    tag     rewrited.${tag}.$2$1
+    tag     rewritten.${tag}.$2$1
+  </rule>
+</match>
+
+# It will get "rewritten.access.ExampleMail"
+<match apache.access>
+  @type rewrite_tag_filter
+  remove_tag_regexp /^apache\./
+  <rule>
+    key     domain
+    pattern ^(mail)\.(example)\.com$
+    tag     rewritten.${tag}.$2$1
+  </rule>
+</match>
+
+# It will get "http.access.log"
+<match input.{apache,nginx}.access.log>
+  @type rewrite_tag_filter
+  remove_tag_regexp /^input\.(apache|nginx)\./
+  <rule>
+    key     domain
+    pattern ^.+$
+    tag     http.${tag}
   </rule>
 </match>
 
-# It will get "rewrited.ExampleMail.app30-124.foo.com" when hostname is "app30-124.foo.com"
+# It will get "rewritten.ExampleMail.app30-124.foo.com" when hostname is "app30-124.foo.com"
 <match apache.access>
   @type rewrite_tag_filter
   <rule>
     key     domain
     pattern ^(mail)\.(example)\.com$
-    tag     rewrited.$2$1.${hostname}
+    tag     rewritten.$2$1.${hostname}
   </rule>
 </match>
 
-# It will get "rewrited.ExampleMail.app30-124" when hostname is "app30-124.foo.com"
+# It will get "rewritten.ExampleMail.app30-124" when hostname is "app30-124.foo.com"
 <match apache.access>
   @type rewrite_tag_filter
   hostname_command hostname -s
   <rule>
     key     domain
     pattern ^(mail)\.(example)\.com$
-    tag     rewrited.$2$1.${hostname}
+    tag     rewritten.$2$1.${hostname}
   </rule>
 </match>
 
-# It will get "rewrited.game.pool"
+# It will get "rewritten.game.pool"
 <match app.game.pool.activity>
   @type rewrite_tag_filter
   <rule>
     key     domain
     pattern ^.+$
-    tag     rewrited.${tag_parts[1]}.${tag_parts[2]}
+    tag     rewritten.${tag_parts[1]}.${tag_parts[2]}
   </rule>
 </match>
 ```

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

@@ -1,9 +1,8 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-rewrite-tag-filter"
-  s.version     = "2.2.0"
+  s.version     = "2.3.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

@@ -10,6 +10,8 @@ class Fluent::Plugin::RewriteTagFilterOutput < Fluent::Plugin::Output
   config_param :capitalize_regex_backreference, :bool, :default => false
   desc 'Remove tag prefix for tag placeholder.'
   config_param :remove_tag_prefix, :string, :default => nil
+  desc "Remove tag regexp for tag placeholder."
+  config_param :remove_tag_regexp, :regexp, default: nil
   desc 'Override hostname command for placeholder.'
   config_param :hostname_command, :string, :default => 'hostname'
   desc "The emit mode. If `batch`, this plugin will emit events per rewritten tag."
@@ -58,8 +60,12 @@ class Fluent::Plugin::RewriteTagFilterOutput < Fluent::Plugin::Output
       raise Fluent::ConfigError, "duplicated rewriterules found #{@rewriterules.inspect}"
     end
 
+    if @remove_tag_prefix && @remove_tag_regexp
+      raise Fluent::ConfigError, "remove_tag_prefix and remove_tag_regexp are exclusive"
+    end
+
     unless @remove_tag_prefix.nil?
-      @remove_tag_prefix = /^#{Regexp.escape(@remove_tag_prefix)}\.?/
+      @remove_tag_regexp = /^#{Regexp.escape(@remove_tag_prefix)}\.?/
     end
 
     @batch_mode = @emit_mode == :batch
@@ -135,7 +141,7 @@ class Fluent::Plugin::RewriteTagFilterOutput < Fluent::Plugin::Output
   end
 
   def get_placeholder(tag)
-    tag = tag.sub(@remove_tag_prefix, '') if @remove_tag_prefix
+    tag = tag.sub(@remove_tag_regexp, '') if @remove_tag_regexp
 
     result = {
       '__HOSTNAME__' => @hostname,

data/test/plugin/test_out_rewrite_tag_filter.rb

@@ -41,6 +41,21 @@ class RewriteTagFilterOutputTest < Test::Unit::TestCase
       d = create_driver(conf)
       assert_equal(/.+/, d.instance.rules.first.pattern)
     end
+
+    test "remove_tag_prefix and remove_tag_regexp are exclusive" do
+      conf = %[
+        remove_tag_prefix prefix
+        remove_tag_regexp /^prefix\./
+        <rule>
+          key message
+          pattern .+
+          tag ${tag}
+        </rule>
+      ]
+      assert_raise(Fluent::ConfigError) do
+        create_driver(conf)
+      end
+    end
   end
 
   sub_test_case "section style" do
@@ -127,6 +142,30 @@ class RewriteTagFilterOutputTest < Test::Unit::TestCase
       assert_equal 'access', events[0][0] # tag
     end
 
+    sub_test_case "remove_tag_regexp" do
+      test "plain" do
+        config = %[
+          remove_tag_regexp /^input\.(apache|nginx)\./
+          <rule>
+            key domain
+            pattern ^www\.google\.com$
+            tag rewritten.${tag}
+          </rule>
+        ]
+        d = create_driver(config)
+        d.run do
+          d.feed('input.apache.access', event_time, {'domain' => 'www.google.com', 'path' => '/foo/bar?key=value', 'agent' => 'Googlebot', 'response_time' => 1000000})
+          d.feed('input.nginx.access', event_time, {'domain' => 'www.google.com', 'path' => '/foo/bar?key=value', 'agent' => 'Googlebot', 'response_time' => 1000000})
+          d.feed('input.tomcat.access', event_time, {'domain' => 'www.google.com', 'path' => '/foo/bar?key=value', 'agent' => 'Googlebot', 'response_time' => 1000000})
+        end
+        events = d.events
+        assert_equal 3, events.length
+        assert_equal 'rewritten.access', events[0][0]
+        assert_equal 'rewritten.access', events[1][0]
+        assert_equal 'rewritten.input.tomcat.access', events[2][0]
+      end
+    end
+
     test "short hostname" do
       config = %[
         remove_tag_prefix input

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-rewrite-tag-filter
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Kentaro Yoshida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2020-04-05 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.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Fluentd Output filter plugin. It has designed to rewrite tag like mod_rewrite.