Deprecates option in favor of silence_errors_in_log

[andsel]

Release notes

Deprecates failure_type_logging_whitelist setting renaming it silence_errors_in_log

What does this PR do?

Introduce a new setting named silence_errors_in_log with exact same behavior of failure_type_logging_whitelist. It print a deprecation log message if failure_type_logging_whitelist is used.

Why is it important/What is the impact to the user?

Rename a setting that's generally confusing the user to a more meaningful name.

Checklist

• My code follows the style guidelines of this project
• [ ] I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• [ ] I have made corresponding change to the default configuration files (and/or docker env variables)
• I have added tests that prove my fix is effective or that my feature works

Author's Checklist

• Run against a real ES instance

How to test this PR locally

• launch an ES instance, for example docker-compose -f es_and_kb.yml up
  es_and_kb.txt
• from http://localhost:5601 Kibana UI (credential: elastic, changeme) create and index and put into read only:

PUT /test_index
PUT test_index/_settings 
{ 
  "index.blocks.read_only" : true 
}

• configure a pipeline to write into:

input {
	generator {
		message => '{"name": "John", "surname": "Doe"}'
		count => 1
		codec => json
	}
}

output {
	elasticsearch {
               # failure_type_logging_whitelist => ["cluster_block_exception"]
	       # silence_errors_in_log => ["cluster_block_exception"]
		index => "test_index"
		hosts => "http://localhost:9200"
		user => "elastic"
		password => "changeme"
		dlq_custom_codes => [403]
	}
}	

• enable the failure_type_logging_whitelist and check that a deprecation log is present in logs/logstash-deprecation.log. After the deprecation log the work as expected and doesn't log the content of the 403 responses from Elasticsearch
• comment failure_type_logging_whitelist and decomment the silence_errors_in_log and verify the feature work as expected (no log of error responses)

Related issues

• Relates [Meta, 8.4, 8.5] Logstash DLQ Improvements for 8.x elastic/logstash#10493

Use cases

Screenshots

Logs

[kaisecheng]

The original name failure_type_logging_whitelist is not too bad and is widely adopted. I am not sure whether the rename gives a better value to users. The bottom line is it is a better name

[kaisecheng]

It is a bit hard for me to understand log_silenced_errors means not to log xxx error. Maybe silence_error_in_log?

[andsel]

Sound better, maybe silenced_errors_in_log ?

[kaisecheng]

sounds better. let's see how @karenzone judge on silence_errors_in_log or silenced_errors_in_log

[kaisecheng]

LGTM. Glad to see the example in doc and thanks for changing the name

[karenzone]

Should be in alphabetical order

[karenzone]

Use correct deprecation format throughout

[karenzone]

Use correct deprecation format

[karenzone]

Use deprecation format

[karenzone]

@kilfoyle and I will make these changes and create a PR as part of a knowledge share exercise. @andsel, we'll tag you for review when we're ready.