fluent-plugin-record-modifier 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 290bea3c616897ac2b1125aabcebb421b3099863
-  data.tar.gz: f81e3ec261a75b79fd0ea5bac81698ffc6d9f357
+SHA256:
+  metadata.gz: 3b44157dfddde7eefc70b4798674e499834fad6f52fafc8da7289696944ec9ca
+  data.tar.gz: faa3f952b7bb41eaa46719494d3aed58bf8f59ed0d7fa476ff2491c700c5ff73
 SHA512:
-  metadata.gz: 64ae991840fb9cb6eab3bc2be79ccbe3c368fd59110a400fa4329dcffa14b852e7c4df18e816458f0c3308bf3937ef679e1f2939e067e2dc354900383e9e7a64
-  data.tar.gz: e82a147fa6b1408bf49f21853d888a3b616df5bf474d675952767aeb003bcc58f3761f9a60a8d3f74a007abab6604fbe7725da85de3123d90a5ac70a4593a332
+  metadata.gz: 0e69f8b91068b1998c60a41449d97471aca548fd7eb002bf8e26048895b95af6cd64c17c771d4a85ef1bcecf63138d404bc1a56ed6a6c052047f5d85db57820f
+  data.tar.gz: b47c9e3a4f054a663e96b7b7ac548ba2877edc941cfcc2e123a7d832239ae1be136baf8a330cdebed391523b92f2b737a68ceb6187211b79ec15e3f17843471f

data/ChangeLog

@@ -1,3 +1,8 @@
+Release 1.1.0 - 2017/06/01
+
+  * Add `replace` config sections
+    https://github.com/repeatedly/fluent-plugin-record-modifier/pull/33
+
 Release 1.0.2 - 2017/12/27
 
   * Add prepare_value parameter

data/README.md

@@ -148,6 +148,48 @@ then you got new record like below:
 {"key1":"hoge", "key2":"foo"}
 ```
 
+### replace_keys_value
+
+If you want to replace specific value for keys you can use `replace` section.
+
+```conf
+<filter pattern>
+  @type record_modifier
+
+  # replace key key1
+  <replace>
+    # your key name
+    key key1
+    # your regexp
+    expression /^(?<start>.+).{2}(?<end>.+)$/
+    # replace string
+    replace \\k<start>ors\\k<end>
+  </replace>
+  # replace key key2
+  <replace>
+    # your key name
+    key key2
+    # your regexp
+    expression /^(.{1}).{2}(.{1})$/
+    # replace string
+    replace \\1ors\\2
+  </replace>
+</filter>
+```
+
+If following record is passed:
+
+```js
+{"key1":"hoge", "key2":"hoge", "key3":"bar"}
+```
+
+then you got new record like below:
+
+```js
+{"key1":"horse", "key2":"horse", "key3":"bar"}
+```
+
+
 ### Ruby code trick for complex logic
 
 If you need own complex logic in filter, writing filter plugin is better. But if you don't want to write new plugin, you can use temporal key trick like below:
@@ -174,12 +216,6 @@ In v0.10, you can use `record_modifier` output to emulate filter. `record_modifi
       foo bar
     </match>
 
-## TODO
-
-* Adding following features if needed
-
-    * Replace record value
-
 ## Copyright
 
 <table>

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/fluent-plugin-record-modifier.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |gem|
   gem.version     = File.read("VERSION").strip
   gem.authors     = ["Masahiro Nakagawa"]
   gem.email       = "repeatedly@gmail.com"
-  gem.has_rdoc    = false
   #gem.platform    = Gem::Platform::RUBY
   gem.license     = 'MIT'
   gem.files       = `git ls-files`.split("\n")

data/lib/fluent/plugin/filter_record_modifier.rb

@@ -31,6 +31,22 @@ Modified events will have only specified keys (if exist in original events).
 This option is exclusive with `remove_keys`.
 DESC
 
+    config_section :replace, param_name: :replaces, multi: true do
+      desc "The field name to which the regular expression is applied"
+      config_param :key, :string
+      desc "The regular expression"
+      config_param :expression do |value|
+        if value.start_with?("/") && value.end_with?("/")
+          Regexp.compile(value[1..-2])
+        else
+          $log.warn "You should use \"pattern /#{value}/\" instead of \"pattern #{value}\""
+          Regexp.compile(value)
+        end
+      end
+      desc "The replacement string"
+      config_param :replace, :string
+    end
+
     def configure(conf)
       super
 
@@ -97,6 +113,15 @@ DESC
         record = modified
       end
 
+      unless @replaces.empty?
+        @replaces.each { |replace|
+          target_key = replace.key
+          if record.include?(target_key) && replace.expression.match(record[target_key])
+            record[target_key] = record[target_key].gsub(replace.expression, replace.replace)
+          end
+        }
+      end
+
       record = change_encoding(record) if @char_encoding
       record
     end

data/test/test_filter_record_modifier.rb

@@ -141,6 +141,43 @@ class RecordModifierFilterTest < Test::Unit::TestCase
     assert_equal [{"k1" => 'v', "test_key" => 'foo'}], d.filtered.map(&:last)
   end
 
+  def test_replace_values
+    d = create_driver %[
+        <replace>
+          key k1
+          expression /^(?<start>.+).{2}(?<end>.+)$/
+          replace \\k<start>ors\\k<end>
+        </replace>
+        <replace>
+          key k2
+          expression /^(.{1}).{2}(.{1})$/
+          replace \\1ors\\2
+        </replace>
+    ]
+
+    d.run(default_tag: @tag) do
+      d.feed("k1" => 'hoge', "k2" => 'hoge', "k3" => 'bar')
+    end
+
+    assert_equal [{"k1" => 'horse', "k2" => 'horse', "k3" => 'bar'}], d.filtered.map(&:last)
+  end
+
+  def test_does_not_replace
+    d = create_driver %[
+        <replace>
+          key k1
+          expression /^(?<start>.+).{2}(?<end>.+)$/
+          replace \\k<start>ors\\k<end>
+        </replace>
+    ]
+
+    d.run(default_tag: @tag) do
+      d.feed("k1" => 'hog')
+    end
+
+    assert_equal [{"k1" => 'hog'}], d.filtered.map(&:last)
+  end
+
   sub_test_case 'frozen check' do
     def test_set_char_encoding
       d = create_driver %[

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-record-modifier
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Masahiro Nakagawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-28 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Filter plugin for modifying event record