logstash-filter-mutate 3.5.1 → 3.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eff46dce19ce289664364fdb1d47dbb79ce30b62a55646c9210fad216f1f0bb
-  data.tar.gz: 6e4944bef0a9b9da0ab0cf985148b9866884753f53d14b408b770cf8e97b6ad6
+  metadata.gz: 53853b61a143395ded602ed7b065eba14dac85d4135b2135c1c0db541062c6a8
+  data.tar.gz: 6a48ec84da666bcc11bef8613f6e8340306c27e39dc4204f2c50cc993c5a2a70
 SHA512:
-  metadata.gz: 2b0d285df7cdd66b59173c690e2105af45074a38db77fa7bf564bcb8f827285f5b2547e79f41fc86473b09e9460143a91d23bb42ab637d227a63402a6bbd2cc3
-  data.tar.gz: 9361cc2a7f9e51c22f0dfe21bf944989dc19b8a31ecfd22e69e5b6907137626a70738d52d32fb9588d8bcdea8d3b55cb8597e3444cc8576bb4093ad79fc736a1
+  metadata.gz: f5e4abc14b42d8a8370ed66541c79c27f94a0e26458e70d70c3fb944d4d12f97aeb9d7cb0ad60e6aa2771fe548f473077b9670ab3fdfec4a370654b2624f89ca
+  data.tar.gz: cd46fb549dcefc6b00cc51ca19f17ff19dd6ef86a10d26466a637ed1257ba40e93290a12a1afcca129b980286237fee82203c3b009b6df38e7d4b16fdd446995

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 3.5.5
+ - Fix: removed code and documentation for already removed 'remove' option. [#161](https://github.com/logstash-plugins/logstash-filter-mutate/pull/161)
+
+## 3.5.4
+ - DOC: In 'replace' documentation, mention 'add' behavior [#155](https://github.com/logstash-plugins/logstash-filter-mutate/pull/155)
+ - DOC: Add warning about #27 [#101](https://github.com/logstash-plugins/logstash-filter-mutate/pull/101)
+
+## 3.5.3
+ - DOC: Expand description and behaviors for `rename` option [#156](https://github.com/logstash-plugins/logstash-filter-mutate/pull/156)
+
+## 3.5.2
+ - Fix: ensure that when an error occurs during registration, we use the correct i18n key to propagate the error message in a useful manner [#154](https://github.com/logstash-plugins/logstash-filter-mutate/pull/154)
+
 ## 3.5.1
  - Fix: removed a minor optimization in case-conversion helpers that could result in a race condition in very rare and specific situations [#151](https://github.com/logstash-plugins/logstash-filter-mutate/pull/151)
 

data/docs/index.asciidoc

@@ -21,7 +21,7 @@ include::{include_path}/plugin_header.asciidoc[]
 ==== Description
 
 The mutate filter allows you to perform general mutations on fields. You
-can rename, remove, replace, and modify fields in your events.
+can rename, replace, and modify fields in your events.
 
 [id="plugins-{type}s-{plugin}-proc_order"]
 ===== Processing order
@@ -38,13 +38,12 @@ Mutations in a config file are executed in this order:
 * capitalize
 * lowercase
 * strip
-* remove
 * split
 * join
 * merge
 * copy
 
-You can control the order by using separate mutate blocks.
+IMPORTANT: Each mutation must be in its own code block if the sequence of operations needs to be preserved.
 
 Example:
 [source,ruby]
@@ -56,7 +55,7 @@ filter {
     }
 
     mutate {    
-        rename => ["shortHostname", "hostname" ]
+        rename => {"shortHostname" => "hostname"}
     }
 }
 -----
@@ -265,6 +264,13 @@ Example:
 
 Rename one or more fields.
 
+If the destination field already exists, its value is replaced.
+
+If one of the source fields doesn't exist, no action is performed for that field.
+(This is not considered an error; the `tag_on_failure` tag is not applied.)
+
+When renaming multiple fields, the order of operations is not guaranteed.
+
 Example:
 [source,ruby]
     filter {
@@ -280,7 +286,8 @@ Example:
   * Value type is <<hash,hash>>
   * There is no default value for this setting.
 
-Replace the value of a field with a new value. The new value can include `%{foo}` strings
+Replace the value of a field with a new value, or add the field if it
+doesn't already exist. The new value can include `%{foo}` strings
 to help you build a new value from other parts of the event.
 
 Example:

data/lib/logstash/filters/mutate.rb

@@ -3,7 +3,7 @@ require "logstash/filters/base"
 require "logstash/namespace"
 
 # The mutate filter allows you to perform general mutations on fields. You
-# can rename, remove, replace, and modify fields in your events.
+# can rename, replace, and modify fields in your events.
 class LogStash::Filters::Mutate < LogStash::Filters::Base
   config_name "mutate"
 
@@ -220,7 +220,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
     @convert.nil? or @convert.each do |field, type|
       if !valid_conversions.include?(type)
         raise LogStash::ConfigurationError, I18n.t(
-          "logstash.agent.configuration.invalid_plugin_register",
+          "logstash.runner.configuration.invalid_plugin_register",
           :plugin => "filter",
           :type => "mutate",
           :error => "Invalid conversion type '#{type}', expected one of '#{valid_conversions.join(',')}'"
@@ -232,7 +232,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
     @gsub.nil? or @gsub.each_slice(3) do |field, needle, replacement|
       if [field, needle, replacement].any? {|n| n.nil?}
         raise LogStash::ConfigurationError, I18n.t(
-          "logstash.agent.configuration.invalid_plugin_register",
+          "logstash.runner.configuration.invalid_plugin_register",
           :plugin => "filter",
           :type => "mutate",
           :error => "Invalid gsub configuration #{[field, needle, replacement]}. gsub requires 3 non-nil elements per config entry"
@@ -258,7 +258,6 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
     capitalize(event) if @capitalize
     lowercase(event) if @lowercase
     strip(event) if @strip
-    remove(event) if @remove
     split(event) if @split
     join(event) if @join
     merge(event) if @merge

data/logstash-filter-mutate.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-mutate'
-  s.version         = '3.5.1'
+  s.version         = '3.5.5'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Performs mutations on fields"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/filters/mutate_spec.rb

@@ -321,7 +321,7 @@ describe LogStash::Filters::Mutate do
       CONFIG
 
       sample "not_really_important" do
-        expect {subject}.to raise_error LogStash::ConfigurationError
+        expect {subject}.to raise_error(LogStash::ConfigurationError, /Invalid conversion type/)
       end
     end
     describe "invalid gsub triad should raise a configuration error" do
@@ -334,7 +334,7 @@ describe LogStash::Filters::Mutate do
       CONFIG
 
       sample "not_really_important" do
-        expect {subject}.to raise_error LogStash::ConfigurationError
+        expect {subject}.to raise_error(LogStash::ConfigurationError, /Invalid gsub configuration/)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mutate
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -126,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Performs mutations on fields