fluent-mixin-rewrite-tag-name 0.0.3 → 0.1.0

data/README.md

@@ -20,8 +20,7 @@ For example with `td.apache.access` tag, it will get `td` by `${tag_parts[0]}` a
 
 **Note** 
 
-* To support upcase placeholder, set `enable_placeholder_upcase true` in configuration.
-* Currently, range expression ```${tag_parts[0..2]}``` is not supported.
+* range expression ```${tag_parts[0..2]}``` is also supported. see [unit test](https://github.com/y-ken/fluent-mixin-rewrite-tag-name/blob/master/test/mixin/test_rewrite_tag_name.rb#L97).
 
 #### Placeholder Option
 
@@ -183,9 +182,6 @@ These cool plugins are using this mixin!
 
 ## TODO
 
-* switchable tag template variable like 'tag', 'tag_format'
-* support range tag_parts like [fluent-plugin-forest](https://github.com/tagomoris/fluent-plugin-forest/compare/v0.2.2...master)
-* support tag_prefix and tag_suffix placeholder like [fluent-plugin-record-reformer](https://github.com/sonots/fluent-plugin-record-reformer)
 * merge into [fluentd/lib/fluent/mixin.rb](https://github.com/fluent/fluentd/blob/master/lib/fluent/mixin.rb) as RewriteTagNameMixin module.
 
 Pull requests are very welcome!!

data/fluent-mixin-rewrite-tag-name.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-mixin-rewrite-tag-name"
-  spec.version       = "0.0.3"
+  spec.version       = "0.1.0"
   spec.authors       = ["Kentaro Yoshida"]
   spec.email         = ["y.ken.studio@gmail.com"]
   spec.summary       = %q{Fluentd mixin plugin to provides placeholder function for rewriting tag for your any plugins as like fluent-plugin-rewrite-tag-filter. It will let you get easy to implement tag placeholder for your own plugins.}

data/lib/fluent/mixin/rewrite_tag_name.rb

@@ -3,7 +3,6 @@ module Fluent
     module RewriteTagName
       include RecordFilterMixin
       attr_accessor :tag, :hostname_command
-      attr_accessor :enable_placeholder_upcase
 
       DEFAULT_HOSTNAME_COMMAND = 'hostname'
 
@@ -11,14 +10,6 @@ module Fluent
         super
 
         @placeholder_expander = PlaceholderExpander.new
-
-        if enable_upcase = conf['enable_placeholder_upcase']
-          @enable_placeholder_upcase = enable_upcase
-        end
-        if @enable_placeholder_upcase
-          @placeholder_expander.enable_placeholder_upcase
-        end
-
         hostname_command = @hostname_command || DEFAULT_HOSTNAME_COMMAND
         hostname = `#{hostname_command}`.chomp
         @placeholder_expander.set_hostname(hostname)
@@ -32,57 +23,74 @@ module Fluent
       end
 
       def rewrite_tag!(tag)
-
         @placeholder_expander.set_tag(tag)
         emit_tag = @placeholder_expander.expand(@tag)
-        tag.gsub!(tag, emit_tag)
+        tag.sub!(tag, emit_tag)
       end
 
       class PlaceholderExpander
         # referenced https://github.com/fluent/fluent-plugin-rewrite-tag-filter, thanks!
         # referenced https://github.com/sonots/fluent-plugin-record-reformer, thanks!
+        # referenced https://github.com/tagomoris/fluent-plugin-forest, thanks!
         attr_reader :placeholders
 
         def initialize
+          @tag = ''
           @placeholders = {}
-          @enable_options = {
-            :upcase => false,
-          }
         end
 
         def expand(str)
-          str.gsub(/(\${[a-z_]+(\[-?[0-9]+\])?}|__[A-Z_]+(\[-?[0-9]+\])?__)/) {
-            $log.warn "RewriteTagNameMixin: unknown placeholder `#{$1}` found" unless @placeholders.include?($1)
-            @placeholders[$1]
-          }
+          str = str.gsub(/(\${(tag|hostname)}|__(TAG|HOSTNAME)__)/) do |name|
+            $log.warn "RewriteTagNameMixin: unknown placeholder `#{name}` found" unless @placeholders.include?(name)
+            @placeholders[name]
+          end
+          str = str.gsub(/__TAG_PARTS\[-?[0-9]+(?:\.\.\.?-?[0-9]+)?\]__|\$\{tag_parts\[-?[0-9]+(?:\.\.\.?-?[0-9]+)?\]\}/) do |tag_parts_offset|
+            expand_tag_parts(tag_parts_offset)
+          end
         end
 
-        def enable_placeholder_upcase
-          @enable_options[:upcase] = true
+        def expand_tag_parts(tag_parts_offset)
+          begin
+            position = /\[(?<first>-?[0-9]+)(?<range_part>(?<range_type>\.\.\.?)(?<last>-?[0-9]+))?\]/.match(tag_parts_offset)
+            raise "failed to parse offset even though matching tag_parts" unless position
+            tag_parts = @tag.split('.')
+            if position[:range_part]
+              extract_tag_part_range(tag_parts, position)
+            else
+              extract_tag_part_index(tag_parts, position)
+            end
+          rescue StandardError => e
+            $log.warn "RewriteTagNameMixin: failed to expand tag_parts. :message=>#{e.message} tag:#{@tag} placeholder:#{tag_parts_matched}"
+            nil
+          end
+        end
+
+        def extract_tag_part_index(tag_parts, position)
+          index = position[:first].to_i
+          raise "missing placeholder." unless tag_parts[index]
+          tag_parts[index]
+        end
+
+        def extract_tag_part_range(tag_parts, position)
+          exclude_end = (position[:range_type] == '...')
+          range = Range.new(position[:first].to_i, position[:last].to_i, exclude_end)
+          raise "missing placeholder." unless tag_parts[range]
+          tag_parts[range].join('.')
         end
 
         def set_tag(value)
+          @tag = value
           set_placeholder('tag', value)
-          set_tag_parts(value)
         end
 
         def set_hostname(value)
           set_placeholder('hostname', value)
         end
 
-        def set_tag_parts(tag)
-          tag_parts = tag.split('.') 
-          size = tag_parts.size
-          tag_parts.each_with_index { |t, idx|
-            set_placeholder("tag_parts[#{idx}]", t)
-            set_placeholder("tag_parts[#{idx-size}]", t) # support tag_parts[-1]
-          }
-        end
-
         private
         def set_placeholder(key, value)
           @placeholders.store("${#{key.downcase}}", value)
-          @placeholders.store("__#{key.upcase}__", value) if @enable_options[:upcase]
+          @placeholders.store("__#{key.upcase}__", value)
         end
       end
     end

data/test/mixin/test_rewrite_tag_name.rb

@@ -32,7 +32,6 @@ class RewriteTagNameMixinTest < Test::Unit::TestCase
     end
     emits = d1.emits
     assert_equal 1, emits.length
-    p emits[0]
     assert_equal 'rewrited.input.access', emits[0][0] # tag
     assert_equal 'foo', emits[0][2]['message']
   end
@@ -41,14 +40,12 @@ class RewriteTagNameMixinTest < Test::Unit::TestCase
     d1 = create_driver(%[
       tag                rewrited.__TAG__
       remove_tag_prefix  input.
-      enable_placeholder_upcase true
     ], 'input.access')
     d1.run do
       d1.emit({'message' => 'foo'})
     end
     emits = d1.emits
     assert_equal 1, emits.length
-    p emits[0]
     assert_equal 'rewrited.access', emits[0][0] # tag
     assert_equal 'foo', emits[0][2]['message']
   end
@@ -63,52 +60,10 @@ class RewriteTagNameMixinTest < Test::Unit::TestCase
     end
     emits = d1.emits
     assert_equal 1, emits.length
-    p emits[0]
     assert_equal 'rewrited.access', emits[0][0] # tag
     assert_equal 'foo', emits[0][2]['message']
   end
 
-  def test_emit_tag_parts
-    d1 = create_driver(%[
-      tag                rewrited.${tag_parts[1]}
-    ], 'input.access.foo.bar')
-    d1.run do
-      d1.emit({'message' => 'foo'})
-    end
-    emits = d1.emits
-    assert_equal 1, emits.length
-    p emits[0]
-    assert_equal 'rewrited.access', emits[0][0] # tag
-  end
-
-  def test_emit_tag_parts_negative
-    d1 = create_driver(%[
-      tag                rewrited.${tag_parts[-1]}
-    ], 'input.access.foo.bar')
-    d1.run do
-      d1.emit({'message' => 'foo'})
-    end
-    emits = d1.emits
-    assert_equal 1, emits.length
-    p emits[0]
-    assert_equal 'rewrited.bar', emits[0][0] # tag
-    assert_equal 'foo', emits[0][2]['message']
-  end
-
-  def test_emit_tag_parts_negative2
-    d1 = create_driver(%[
-      tag                rewrited.${tag_parts[-2]}
-    ], 'input.access.foo.bar')
-    d1.run do
-      d1.emit({'message' => 'foo'})
-    end
-    emits = d1.emits
-    assert_equal 1, emits.length
-    p emits[0]
-    assert_equal 'rewrited.foo', emits[0][0] # tag
-    assert_equal 'foo', emits[0][2]['message']
-  end
-
   def test_emit_hostname
     d1 = create_driver(%[
       tag                rewrited.${hostname}
@@ -118,7 +73,6 @@ class RewriteTagNameMixinTest < Test::Unit::TestCase
     end
     emits = d1.emits
     assert_equal 1, emits.length
-    p emits[0]
     hostname = `hostname`.chomp
     assert_equal "rewrited.#{hostname}", emits[0][0] # tag
     assert_equal 'foo', emits[0][2]['message']
@@ -134,10 +88,34 @@ class RewriteTagNameMixinTest < Test::Unit::TestCase
     end
     emits = d1.emits
     assert_equal 1, emits.length
-    p emits[0]
     hostname_command = d1.instance.config['hostname_command']
     hostname = `#{hostname_command}`.chomp
     assert_equal "rewrited.#{hostname}", emits[0][0] # tag
     assert_equal 'foo', emits[0][2]['message']
   end
+
+  def test_emit_tag_parts
+    tag = '0.1.2.3.4'
+    rules = [
+      {:conf=>'tag rewrited.${tag_parts[0]}',       :expect_tag => 'rewrited.0'},
+      {:conf=>'tag rewrited.${tag_parts[1]}',       :expect_tag => 'rewrited.1'},
+      {:conf=>'tag rewrited.${tag_parts[-1]}',      :expect_tag => 'rewrited.4'},
+      {:conf=>'tag rewrited.${tag_parts[-2]}',      :expect_tag => 'rewrited.3'},
+      {:conf=>'tag rewrited.${tag_parts[1..1000]}', :expect_tag => 'rewrited.1.2.3.4'},
+      {:conf=>'tag rewrited.${tag_parts[0..2]}',    :expect_tag => 'rewrited.0.1.2'},
+      {:conf=>'tag rewrited.${tag_parts[0..-3]}',   :expect_tag => 'rewrited.0.1.2'},
+      {:conf=>'tag rewrited.${tag_parts[1..-2]}',   :expect_tag => 'rewrited.1.2.3'},
+      {:conf=>'tag rewrited.${tag_parts[-2..-1]}',  :expect_tag => 'rewrited.3.4'},
+    ]
+    rules.each do |rule|
+      d = create_driver(rule[:conf], tag)
+      d.run do
+        d.emit({'message' => 'foo'})
+      end
+      emits = d.emits
+      assert_equal 1, emits.length
+      assert_equal rule[:expect_tag], emits[0][0] # tag
+      assert_equal 'foo', emits[0][2]['message']
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-mixin-rewrite-tag-name
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler