fluent-plugin-record-modifier 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 438ccea5164c0e705dff68f7482312e20b1c84a3
-  data.tar.gz: 9a2b5a6893a56928e71cddd0bab98eb8f015b833
+  metadata.gz: d387097d02bdd7a23188147b637a43f66fe55698
+  data.tar.gz: 8e77cfa13ed400aba3ea7b6a974a71443a599742
 SHA512:
-  metadata.gz: 88dfb45817738a35242e9eb08ca66511d80056a4744513222654251b762fe901c86b63e7bc5780d83e8d1370f74c375d109ca4dc7c6c6d1cad27a102ae310b71
-  data.tar.gz: 12069d1234c29caa145f8f32943c842b029b462e747a4c2c18df28d31d28df7cc66948587f32878a80560ab56e7ff9cc03ebf288dfe55231fd8a08766a254903
+  metadata.gz: 2b52745de9ae3a6a22d8cee708a2def04b70a96d61cc2221a99156031b9f6d849d2b49a561bdecc30807a3f027f77c6818bc3a784c9bd6836b8a31e8cfcaf944
+  data.tar.gz: '08a27b0a0475c8af1f6804318a22ec816a3084a30ac5047afed1dbf97c30c297f4d2f5d648cc112dc9f8d2eb06e9019bc8a9db75c79d0db912d67692ac85a2c7'

data/ChangeLog

@@ -1,3 +1,8 @@
+Release 0.6.2 - 2017/12/27
+
+  * Add prepare_value parameter
+  * Fix non-string object handling
+
 Release 0.6.1 - 2017/12/12
 
   * Drop fluentd v0.10 support

data/README.md

@@ -55,6 +55,20 @@ But unlike `record_transformer`, `record_modifier` doesn't support following fea
 - tag_suffix and tag_prefix
 - dynamic key placeholder
 
+### prepare_value
+
+Prepare values for filtering. This ruby code is evaluated in `configure` phase and prepared values can be used in `<record>`. Here is an example:
+
+    <filter pattern>
+      @type record_modifier
+      prepare_value require 'foo'; @foo = Foo.new
+      <record>
+        key ${@foo.method1}
+      </record>
+    </filter>
+
+This feature is useful for using external library.
+
 ### char_encoding
 
 Fluentd including some plugins treats logs as a BINARY by default to forward.

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.6.2

data/lib/fluent/plugin/filter_record_modifier.rb

@@ -4,6 +4,11 @@ module Fluent
   class RecordModifierFilter < Filter
     Fluent::Plugin.register_filter('record_modifier', self)
 
+    config_param :prepare_value, :string, default: nil,
+                 desc: <<-DESC
+Prepare values for filtering in configure phase. Prepared values can be used in <record>.
+You can write any ruby code.
+DESC
     config_param :char_encoding, :string, default: nil,
                  desc: <<-DESC
 Fluentd including some plugins treats the logs as a BINARY by default to forward.
@@ -26,7 +31,7 @@ Modified events will have only specified keys (if exist in original events).
 This option is exclusive with `remove_keys`.
 DESC
 
-    BUILTIN_CONFIGURATIONS = %W(type @type log_level @log_level id @id char_encoding remove_keys whitelist_keys)
+    BUILTIN_CONFIGURATIONS = %W(type @type log_level @log_level id @id char_encoding remove_keys whitelist_keys prepare_value)
 
     def configure(conf)
       super
@@ -67,7 +72,7 @@ DESC
           check_config_placeholders(k, v)
           element.has_key?(k) # to suppress unread configuration warning
           @has_tag_parts = true if v.include?('tag_parts')
-          @map[k] = DynamicExpander.new(k, v)
+          @map[k] = DynamicExpander.new(k, v, @prepare_value)
         end
       end
 
@@ -117,7 +122,7 @@ DESC
         value.force_encoding(@from_enc)
       elsif value.is_a?(Hash)
         value.each_pair { |k, v|
-          if v.frozen?
+          if v.frozen? && v.is_a?(String)
             value[k] = set_encoding(v.dup)
           else
             set_encoding(v)
@@ -125,6 +130,8 @@ DESC
         }
       elsif value.is_a?(Array)
         value.each { |v| set_encoding(v) }
+      else
+        value
       end
     end
 
@@ -134,7 +141,7 @@ DESC
         value.encode!(@to_enc, @from_enc, :invalid => :replace, :undef => :replace)
       elsif value.is_a?(Hash)
         value.each_pair { |k, v|
-          if v.frozen?
+          if v.frozen? && v.is_a?(String)
             value[k] = convert_encoding(v.dup)
           else
             convert_encoding(v)
@@ -142,6 +149,8 @@ DESC
         }
       elsif value.is_a?(Array)
         value.each { |v| convert_encoding(v) }
+      else
+        value
       end
     end
 
@@ -156,7 +165,7 @@ DESC
     end
 
     class DynamicExpander
-      def initialize(param_key, param_value)
+      def initialize(param_key, param_value, prepare_value)
         if param_value.include?('${')
           __str_eval_code__ = parse_parameter(param_value)
 
@@ -172,6 +181,12 @@ DESC
           @param_value = param_value
         end
 
+        begin
+          eval prepare_value if prepare_value
+        rescue SyntaxError
+          raise ConfigError, "Pass invalid syntax parameter : key = prepare_value, value = #{prepare_value}"
+        end
+
         begin
           # check eval genarates wrong code or not
           expand(nil, nil, nil, nil)

data/test/test_filter_record_modifier.rb

@@ -126,6 +126,21 @@ class RecordModifierFilterTest < Test::Unit::TestCase
     assert_equal [{"k1" => 'v', "k2" => 'v'}], d.filtered_as_array.map(&:last)
   end
 
+  def test_prepare_values
+    d = create_driver %[
+      prepare_value @foo = 'foo'
+      <record>
+        test_key ${@foo}
+      </record>
+    ]
+
+    d.run do
+      d.emit("k1" => 'v')
+    end
+
+    assert_equal [{"k1" => 'v', "test_key" => 'foo'}], d.filtered_as_array.map(&:last)
+  end
+
   sub_test_case 'frozen check' do
     def test_set_char_encoding
       d = create_driver %[
@@ -133,13 +148,13 @@ class RecordModifierFilterTest < Test::Unit::TestCase
       ]
 
       d.run do
-        d.emit("k" => 'v'.force_encoding('BINARY').freeze)
-        d.emit("k" => {"l" => 'v'.force_encoding('BINARY').freeze})
+        d.emit("k" => 'v'.force_encoding('BINARY').freeze, 'n' => 1)
+        d.emit("k" => {"l" => 'v'.force_encoding('BINARY').freeze, 'n' => 1})
       end
 
       assert_equal [
-        {"k" => 'v'.force_encoding('UTF-8')},
-        {"k" => {"l" => 'v'.force_encoding('UTF-8')}},
+        {"k" => 'v'.force_encoding('UTF-8'), 'n' => 1},
+        {"k" => {"l" => 'v'.force_encoding('UTF-8'), 'n' => 1}},
       ], d.filtered_as_array.map { |e| e.last }
     end
 
@@ -149,13 +164,13 @@ class RecordModifierFilterTest < Test::Unit::TestCase
       ]
 
       d.run do
-        d.emit("k" => 'v'.force_encoding('utf-8').freeze)
-        d.emit("k" => {"l" => 'v'.force_encoding('utf-8').freeze})
+        d.emit("k" => 'v'.force_encoding('utf-8').freeze, 'n' => 1)
+        d.emit("k" => {"l" => 'v'.force_encoding('utf-8').freeze, 'n' => 1})
       end
 
       assert_equal [
-        {"k" => 'v'.force_encoding('cp932')},
-        {"k" => {"l" => 'v'.force_encoding('cp932')}},
+        {"k" => 'v'.force_encoding('cp932'), 'n' => 1},
+        {"k" => {"l" => 'v'.force_encoding('cp932'), 'n' => 1}},
       ], d.filtered_as_array.map { |e| e.last }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-record-modifier
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Masahiro Nakagawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2017-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd