Deprecates option in favor of

Author: andsel

CHANGELOG.md

@@ -1,3 +1,6 @@
+## Unreleased
+ - Feature: deprecates the `failure_type_logging_whitelist` configuration option, renaming it `log_silenced_errors` [#n](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/n)
+
 ## 11.6.0
  - Added support for `ca_trusted_fingerprint` when run on Logstash 8.3+ [#1074](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/1074)
 

docs/index.asciidoc

@@ -332,6 +332,7 @@ This plugin supports the following configuration options plus the
 | <<plugins-{type}s-{plugin}-index>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-keystore>> |a valid filesystem path|No
 | <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|No
+| <<plugins-{type}s-{plugin}-log_silenced_errors>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-manage_template>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-parameters>> |<<hash,hash>>|No
 | <<plugins-{type}s-{plugin}-parent>> |<<string,string>>|No
@@ -584,9 +585,7 @@ of this setting affects the _default_ values of:
   * Value type is <<array,array>>
   * Default value is `[]`
 
-Set the Elasticsearch errors in the whitelist that you don't want to log.
-A useful example is when you want to skip all 409 errors
-which are `document_already_exists_exception`.
+NOTE: Deprecated, refer to <<plugins-{type}s-{plugin}-log_silenced_errors>>.
 
 [id="plugins-{type}s-{plugin}-custom_headers"]
 ===== `custom_headers`
@@ -762,6 +761,25 @@ It can be either .jks or .p12
 
 Set the keystore password
 
+[id="plugins-{type}s-{plugin}-log_silenced_errors"]
+===== `log_silenced_errors`
+
+* Value type is <<array,array>>
+* Default value is `[]`
+
+Defines the list of Elasticsearch errors that you don't want to log.
+A useful example is when you want to skip all 409 errors
+which are `document_already_exists_exception`.
+
+[source,ruby]
+    output {
+      elasticsearch {
+        log_silenced_errors => ["document_already_exists_exception"]
+      }
+    }
+
+NOTE: Deprecates <<plugins-{type}s-{plugin}-failure_type_logging_whitelist>>.
+
 [id="plugins-{type}s-{plugin}-manage_template"]
 ===== `manage_template`
 

lib/logstash/outputs/elasticsearch.rb

@@ -266,6 +266,12 @@ def initialize(*params)
   end
 
   def register
+    if !failure_type_logging_whitelist.empty?
+      @deprecation_logger.deprecated "'failure_type_logging_whitelist' is deprecated and in a future version of " +
+        "Elasticsearch output plugin will be removed, please use 'log_silenced_errors' instead."
+      log_silenced_errors = log_silenced_errors | failure_type_logging_whitelist
+    end
+
     @after_successful_connection_done = Concurrent::AtomicBoolean.new(false)
     @stopping = Concurrent::AtomicBoolean.new(false)
 

lib/logstash/plugin_mixins/elasticsearch/api_configs.rb

@@ -99,10 +99,14 @@ module APIConfigs
         # a timeout occurs, the request will be retried.
         :timeout => { :validate => :number, :default => 60 },
 
-        # Set the Elasticsearch errors in the whitelist that you don't want to log.
+        # Deprecated, refer to `log_silenced_errors`.
+        :failure_type_logging_whitelist => { :validate => :array, :default => [] },
+
+        # Defines the list of Elasticsearch errors that you don't want to log.
         # A useful example is when you want to skip all 409 errors
         # which are `document_already_exists_exception`.
-        :failure_type_logging_whitelist => { :validate => :array, :default => [] },
+        # Deprecates `failure_type_logging_whitelist`.
+        :log_silenced_errors => { :validate => :array, :default => [] },
 
         # While the output tries to reuse connections efficiently we have a maximum.
         # This sets the maximum number of open connections the output will create.

lib/logstash/plugin_mixins/elasticsearch/common.rb

@@ -284,7 +284,7 @@ def submit(actions)
     end
 
     def log_failure_type?(failure)
-      !failure_type_logging_whitelist.include?(failure["type"])
+      !log_silenced_errors.include?(failure["type"])
     end
 
     # Rescue retryable errors during bulk submission