From b2cd9a58ca7cbaf183f82b78a58071bf8f4726be Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Thu, 18 Apr 2024 02:50:56 -0600 Subject: [PATCH] docs(outputs.kafka): Add metadata options to docs (#15182) --- plugins/outputs/kafka/README.md | 19 +++++++++++++++++++ plugins/outputs/kafka/sample.conf | 19 +++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/plugins/outputs/kafka/README.md b/plugins/outputs/kafka/README.md index 16b1d3b60..8dd3778db 100644 --- a/plugins/outputs/kafka/README.md +++ b/plugins/outputs/kafka/README.md @@ -170,6 +170,25 @@ to use them. # Disable Kafka metadata full fetch # metadata_full = false + ## Maximum number of retries for metadata operations including + ## connecting. Sets Sarama library's Metadata.Retry.Max config value. If 0 or + ## unset, use the Sarama default of 3, + # metadata_retry_max = 0 + + ## Type of retry backoff. Valid options: "constant", "exponential" + # metadata_retry_type = "constant" + + ## Amount of time to wait before retrying. When metadata_retry_type is + ## "constant", each retry is delayed this amount. When "exponential", the + ## first retry is delayed this amount, and subsequent delays are doubled. If 0 + ## or unset, use the Sarama default of 250 ms + # metadata_retry_backoff = 0 + + ## Maximum amount of time to wait before retrying when metadata_retry_type is + ## "exponential". Ignored for other retry types. If 0, there is no backoff + ## limit. + # metadata_retry_max_duration = 0 + ## Data format to output. ## Each data format has its own unique set of configuration options, read ## more about them here: diff --git a/plugins/outputs/kafka/sample.conf b/plugins/outputs/kafka/sample.conf index ee08f2db2..cf905ea60 100644 --- a/plugins/outputs/kafka/sample.conf +++ b/plugins/outputs/kafka/sample.conf @@ -130,6 +130,25 @@ # Disable Kafka metadata full fetch # metadata_full = false + ## Maximum number of retries for metadata operations including + ## connecting. Sets Sarama library's Metadata.Retry.Max config value. If 0 or + ## unset, use the Sarama default of 3, + # metadata_retry_max = 0 + + ## Type of retry backoff. Valid options: "constant", "exponential" + # metadata_retry_type = "constant" + + ## Amount of time to wait before retrying. When metadata_retry_type is + ## "constant", each retry is delayed this amount. When "exponential", the + ## first retry is delayed this amount, and subsequent delays are doubled. If 0 + ## or unset, use the Sarama default of 250 ms + # metadata_retry_backoff = 0 + + ## Maximum amount of time to wait before retrying when metadata_retry_type is + ## "exponential". Ignored for other retry types. If 0, there is no backoff + ## limit. + # metadata_retry_max_duration = 0 + ## Data format to output. ## Each data format has its own unique set of configuration options, read ## more about them here: