fluent-plugin-record-reformer 0.2.7 → 0.2.8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.8 (2014/04/12)
+
+Changes:
+
+* Deprecate `output_tag` option. Use `tag` option instead.
+
 ## 0.2.7 (2014/03/26)
 
 Fixes:

data/README.md

@@ -20,7 +20,7 @@ Example:
       renew_record false
       enable_ruby false
       
-      output_tag reformed.${tag}
+      tag reformed.${tag}
       <record>
         hostname ${hostname}
         input_tag ${tag}
@@ -58,7 +58,7 @@ Example:
       remove_keys remove_me
       renew_record false
       enable_ruby false
-      output_tag reformed.${tag}
+      tag reformed.${tag}
       
       hostname ${hostname}
       input_tag ${tag}
@@ -69,9 +69,13 @@ This results in same, but please note that following option parameters are reser
 
 ## Option Parameters
 
-- output_tag
+- output_tag (obsolete)
 
-    The output tag name
+    The output tag name. This option is deprecated. Use `tag` option instead
+
+- tag
+
+    The output tag name. 
 
 - remove_keys
 

data/fluent-plugin-record-reformer.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name        = "fluent-plugin-record-reformer"
-  gem.version     = "0.2.7"
+  gem.version     = "0.2.8"
   gem.authors     = ["Naotoshi Seo"]
   gem.email       = "sonots@gmail.com"
   gem.homepage    = "https://github.com/sonots/fluent-plugin-record-reformer"

data/lib/fluent/plugin/out_record_reformer.rb

@@ -9,12 +9,13 @@ module Fluent
       super
     end
 
-    config_param :output_tag, :string
+    config_param :output_tag, :string, :default => nil # obsolete
+    config_param :tag, :string, :default => nil
     config_param :remove_keys, :string, :default => nil
     config_param :renew_record, :bool, :default => false
     config_param :enable_ruby, :bool, :default => true # true for lower version compatibility
 
-    BUILTIN_CONFIGURATIONS = %W(type output_tag remove_keys renew_record enable_ruby)
+    BUILTIN_CONFIGURATIONS = %W(type tag output_tag remove_keys renew_record enable_ruby)
 
     # To support log_level option implemented by Fluentd v0.10.43
     unless method_defined?(:log)
@@ -42,6 +43,14 @@ module Fluent
         @remove_keys = @remove_keys.split(',')
       end
 
+      if @output_tag and @tag.nil? # for lower version compatibility
+        log.warn "out_record_reformer: `output_tag` is deprecated. Use `tag` option instead."
+        @tag = @output_tag
+      end
+      if @tag.nil?
+        raise Fluent::ConfigError, "out_record_reformer: `tag` must be specified"
+      end
+
       @placeholder_expander =
         if @enable_ruby
           # require utilities which would be used in ruby placeholders
@@ -71,20 +80,20 @@ module Fluent
       last_record = nil
       es.each {|time, record|
         last_record = record # for debug log
-        new_tag, new_record = reform(@output_tag, time, record, placeholders)
+        new_tag, new_record = reform(@tag, time, record, placeholders)
         Engine.emit(new_tag, time, new_record)
       }
       chain.next
     rescue => e
       log.warn "record_reformer: #{e.class} #{e.message} #{e.backtrace.first}"
-      log.debug "record_reformer: output_tag:#{@output_tag} map:#{@map} record:#{last_record} placeholders:#{placeholders}"
+      log.debug "record_reformer: tag:#{@tag} map:#{@map} record:#{last_record} placeholders:#{placeholders}"
     end
 
     private
 
-    def reform(output_tag, time, record, opts)
+    def reform(tag, time, record, opts)
       @placeholder_expander.prepare_placeholders(time, record, opts)
-      new_tag = @placeholder_expander.expand(output_tag)
+      new_tag = @placeholder_expander.expand(tag)
 
       new_record = @renew_record ? {} : record.dup
       @map.each_pair { |k, v| new_record[k] = @placeholder_expander.expand(v) }

data/spec/out_record_reformer_spec.rb

@@ -4,11 +4,10 @@ require_relative 'spec_helper'
 describe Fluent::RecordReformerOutput do
   before { Fluent::Test.setup }
   CONFIG = %[
-    type reformed
-    output_tag reformed.${tag}
+    tag reformed.${tag}
 
     hostname ${hostname}
-    tag ${tag}
+    input_tag ${tag}
     time ${time.strftime('%S')}
     message ${hostname} ${tag_parts.last} ${URI.escape(message)}
   ]
@@ -23,6 +22,12 @@ describe Fluent::RecordReformerOutput do
 
       context "check default" do
         let(:config) { CONFIG }
+        it { expect { subject }.not_to raise_error }
+      end
+
+      context "tag is not specified" do
+        let(:config) { %[] }
+        it { expect { subject }.to raise_error(Fluent::ConfigError) }
       end
     end
   end
@@ -30,27 +35,30 @@ describe Fluent::RecordReformerOutput do
   describe 'test emit' do
     let(:time) { Time.now }
     let(:emit) do
-      driver.run do
-        driver.emit({'foo'=>'bar', 'message' => '1'}, time.to_i)
-        driver.emit({'foo'=>'bar', 'message' => '2'}, time.to_i)
-      end
+      driver.run { driver.emit({'foo'=>'bar', 'message' => '1'}, time.to_i) }
     end
 
     context 'typical usage' do
+      let(:emit) do
+        driver.run do
+          driver.emit({'foo'=>'bar', 'message' => '1'}, time.to_i)
+          driver.emit({'foo'=>'bar', 'message' => '2'}, time.to_i)
+        end
+      end
       let(:config) { CONFIG }
       before do
         Fluent::Engine.stub(:now).and_return(time)
         Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
           'foo' => 'bar',
           'hostname' => hostname,
-          'tag' => tag,
+          'input_tag' => tag,
           'time' => time.strftime('%S'),
           'message' => "#{hostname} #{tag_parts.last} 1",
         })
         Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
           'foo' => 'bar',
           'hostname' => hostname,
-          'tag' => tag,
+          'input_tag' => tag,
           'time' => time.strftime('%S'),
           'message' => "#{hostname} #{tag_parts.last} 2",
         })
@@ -58,19 +66,15 @@ describe Fluent::RecordReformerOutput do
       it { emit }
     end
 
-    context 'support old ${tags} placeholder' do
-      let(:config) { %[
-        type reformed
+    context 'obsolete output_tag' do
+      let(:config) {%[
         output_tag reformed.${tag}
-
-        message ${tags[1]}
       ]}
-
       before do
         Fluent::Engine.stub(:now).and_return(time)
-        Fluent::Engine.should_receive(:emit).twice.with("reformed.#{tag}", time.to_i, {
+        Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
           'foo' => 'bar',
-          'message' => "#{tag_parts[1]}",
+          'message' => "1",
         })
       end
       it { emit }
@@ -78,12 +82,11 @@ describe Fluent::RecordReformerOutput do
 
     context 'record directive' do
       let(:config) {%[
-        type reformed
-        output_tag reformed.${tag}
+        tag reformed.${tag}
 
         <record>
           hostname ${hostname}
-          output_tag ${tag}
+          tag ${tag}
           time ${time.strftime('%S')}
           message ${hostname} ${tag_parts.last} ${message}
         </record>
@@ -93,17 +96,10 @@ describe Fluent::RecordReformerOutput do
         Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
           'foo' => 'bar',
           'hostname' => hostname,
-          'output_tag' => tag,
+          'tag' => tag,
           'time' => time.strftime('%S'),
           'message' => "#{hostname} #{tag_parts.last} 1",
         })
-        Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
-          'foo' => 'bar',
-          'hostname' => hostname,
-          'output_tag' => tag,
-          'time' => time.strftime('%S'),
-          'message' => "#{hostname} #{tag_parts.last} 2",
-        })
       end
       it { emit }
     end
@@ -114,12 +110,7 @@ describe Fluent::RecordReformerOutput do
         Fluent::Engine.stub(:now).and_return(time)
         Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
           'hostname' => hostname,
-          'tag' => tag,
-          'time' => time.strftime('%S'),
-        })
-        Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
-          'hostname' => hostname,
-          'tag' => tag,
+          'input_tag' => tag,
           'time' => time.strftime('%S'),
         })
       end
@@ -132,60 +123,21 @@ describe Fluent::RecordReformerOutput do
         Fluent::Engine.stub(:now).and_return(time)
         Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
           'hostname' => hostname,
-          'tag' => tag,
-          'time' => time.strftime('%S'),
-          'message' => "#{hostname} #{tag_parts.last} 1",
-        })
-        Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
-          'hostname' => hostname,
-          'tag' => tag,
+          'input_tag' => tag,
           'time' => time.strftime('%S'),
-          'message' => "#{hostname} #{tag_parts.last} 2",
-        })
-      end
-      it { emit }
-    end
-
-    context 'enable_ruby no' do
-      let(:config) {%[
-        type reformed
-        output_tag reformed.${tag}
-        enable_ruby no
-
-        hostname ${hostname}
-        tag ${tag}
-        time ${time}
-        message ${hostname} ${tag_parts[-1]} ${message}
-      ]}
-      before do
-        Fluent::Engine.stub(:now).and_return(time)
-        Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
-          'foo' => 'bar',
-          'hostname' => hostname,
-          'tag' => tag,
-          'time' => time.to_s,
           'message' => "#{hostname} #{tag_parts.last} 1",
         })
-        Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
-          'foo' => 'bar',
-          'hostname' => hostname,
-          'tag' => tag,
-          'time' => time.to_s,
-          'message' => "#{hostname} #{tag_parts.last} 2",
-        })
       end
       it { emit }
     end
 
-    context 'enable_ruby no (unknown placeholder)' do
+    context 'unknown placeholder (enable_ruby no)' do
       let(:emit) do
-        driver.run { driver.emit({'foo'=>'bar', 'message' => '1'}, time.to_i) }
+        driver.run { driver.emit({}, time.to_i) }
       end
       let(:config) {%[
-        type reformed
-        output_tag reformed.${tag}
+        tag reformed.${tag}
         enable_ruby no
-
         message ${unknown}
       ]}
       before do
@@ -193,66 +145,118 @@ describe Fluent::RecordReformerOutput do
       end
       it { emit }
     end
+  end
 
-    context '${tag_prefix[N]} and ${tag_suffix[N]}' do
-      let(:config) {%[
-        type reformed
-        output_tag ${tag_suffix[-2]}
-        enable_ruby no
+  describe 'test placeholders' do
+    let(:time) { Time.now }
+    let(:emit) do
+      driver.run { driver.emit({}, time.to_i) }
+    end
 
-        hostname ${hostname}
-        tag ${tag}
-        time ${time}
-        message ${tag_prefix[1]} ${tag_prefix[-2]} ${tag_suffix[2]} ${tag_suffix[-3]} ${message}
-      ]}
-      let(:tag) { 'prefix.test.tag.suffix' }
-      let(:tag_parts) { tag.split('.') }
-      before do
-        Fluent::Engine.stub(:now).and_return(time)
-        Fluent::Engine.should_receive(:emit).with("tag.suffix", time.to_i, {
-          'foo' => 'bar',
-          'message' => "prefix.test prefix.test.tag tag.suffix test.tag.suffix 1",
-          'hostname' => hostname,
-          'tag' => tag,
-          'time' => time.to_s,
-        })
-        Fluent::Engine.should_receive(:emit).with("tag.suffix", time.to_i, {
-          'foo' => 'bar',
-          'message' => "prefix.test prefix.test.tag tag.suffix test.tag.suffix 2",
-          'hostname' => hostname,
-          'tag' => tag,
-          'time' => time.to_s,
-        })
+    %w[yes no].each do |enable_ruby|
+      context "hostname with enble_ruby #{enable_ruby}" do
+        let(:config) {%[
+          tag tag
+          enable_ruby #{enable_ruby}
+          message ${hostname}
+        ]}
+        before do
+          Fluent::Engine.stub(:now).and_return(time)
+          Fluent::Engine.should_receive(:emit).with("tag", time.to_i, {'message' => hostname})
+        end
+        it { emit }
       end
-      it { emit }
-    end
 
-    context '${tag_prefix[N]} and ${tag_suffix[N]} with ruby enabled' do
-      let(:config) { CONFIG + %[
-        test_tag ${tag_prefix[1]} ${tag_prefix[-2]} ${tag_suffix[2]} ${tag_suffix[-3]}
-      ]}
-      let(:tag) { 'prefix.test.tag.suffix' }
-      let(:tag_parts) { tag.split('.') }
-      before do
-        Fluent::Engine.stub(:now).and_return(time)
-        Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
-          'foo' => 'bar',
-          'message' => "#{hostname} #{tag_parts.last} 1",
-          'hostname' => hostname,
-          'tag' => tag,
-          'time' => time.strftime('%S'),
-          'test_tag' => "prefix.test prefix.test.tag tag.suffix test.tag.suffix",
-        })
-        Fluent::Engine.should_receive(:emit).with("reformed.#{tag}", time.to_i, {
-          'foo' => 'bar',
-          'message' => "#{hostname} #{tag_parts.last} 2",
-          'hostname' => hostname,
-          'tag' => tag,
-          'time' => time.strftime('%S'),
-          'test_tag' => "prefix.test prefix.test.tag tag.suffix test.tag.suffix",
-        })
+      context "tag with enable_ruby #{enable_ruby}" do
+        let(:config) {%[
+          tag tag
+          enable_ruby #{enable_ruby}
+          message ${tag}
+        ]}
+        before do
+          Fluent::Engine.stub(:now).and_return(time)
+          Fluent::Engine.should_receive(:emit).with("tag", time.to_i, {'message' => tag})
+        end
+        it { emit }
+      end
+
+      context "tag_parts with enable_ruby #{enable_ruby}" do
+        let(:config) {%[
+          tag tag
+          enable_ruby #{enable_ruby}
+          message ${tag_parts[0]} ${tag_parts[-1]}
+        ]}
+        let(:expected) { "#{tag.split('.').first} #{tag.split('.').last}" }
+        before do
+          Fluent::Engine.stub(:now).and_return(time)
+          Fluent::Engine.should_receive(:emit).with("tag", time.to_i, {'message' => expected})
+        end
+        it { emit }
+      end
+
+      context "support old tags with enable_ruby #{enable_ruby}" do
+        let(:config) {%[
+          tag tag
+          enable_ruby #{enable_ruby}
+          message ${tags[0]} ${tags[-1]}
+        ]}
+        let(:expected) { "#{tag.split('.').first} #{tag.split('.').last}" }
+        before do
+          Fluent::Engine.stub(:now).and_return(time)
+          Fluent::Engine.should_receive(:emit).with("tag", time.to_i, {'message' => expected})
+        end
+        it { emit }
+      end
+
+      context "${tag_prefix[N]} and ${tag_suffix[N]} with enable_ruby #{enable_ruby}" do
+        let(:config) {%[
+          tag ${tag_suffix[-2]}
+          enable_ruby #{enable_ruby}
+          message ${tag_prefix[1]} ${tag_prefix[-2]} ${tag_suffix[2]} ${tag_suffix[-3]}
+        ]}
+        let(:tag) { 'prefix.test.tag.suffix' }
+        let(:expected) { "prefix.test prefix.test.tag tag.suffix test.tag.suffix" }
+        before do
+          Fluent::Engine.stub(:now).and_return(time)
+          Fluent::Engine.should_receive(:emit).with("tag.suffix", time.to_i, { 'message' => "prefix.test prefix.test.tag tag.suffix test.tag.suffix" })
+        end
+        it { emit }
+      end
+
+      context "time with enable_ruby #{enable_ruby}" do
+        let(:config) {%[
+          tag tag
+          enable_ruby #{enable_ruby}
+          time ${time}
+        ]}
+        before do
+          Fluent::Engine.stub(:now).and_return(time)
+          Fluent::Engine.should_receive(:emit).with("tag", time.to_i, {'time' => time.to_s})
+        end
+        it { emit }
+      end
+
+      context "record with enable_ruby #{enable_ruby}" do
+        let(:emit) do
+          driver.run do
+            driver.emit({'message' => '1'}, time.to_i)
+            driver.emit({'message' => '2'}, time.to_i)
+          end
+        end
+        let(:config) {%[
+          tag tag
+          enable_ruby #{enable_ruby}
+          message bar ${message}
+        ]}
+        let(:tag) { 'prefix.test.tag.suffix' }
+        let(:tag_parts) { tag.split('.') }
+        before do
+          Fluent::Engine.stub(:now).and_return(time)
+          Fluent::Engine.should_receive(:emit).with("tag", time.to_i, { 'message' => "bar 1", })
+          Fluent::Engine.should_receive(:emit).with("tag", time.to_i, { 'message' => "bar 2", })
+        end
+        it { emit }
       end
-      it { emit }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-record-reformer
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -125,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -974723697
+      hash: -1062048915
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -974723697
+      hash: -1062048915
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23