Skip to content

Deprecate kafka options not available from 9.4.0 #6309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
khushijain21 wants to merge 3 commits into
base: main
Choose a base branch
from
+22 −11
Open

Deprecate kafka options not available from 9.4.0 #6309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1dd8644
Deprecate kafka options not available from 9.4.0
khushijain21 May 6, 2026
7a6d710
Apply technical writer review suggestions
vishaangelova May 6, 2026
634a129
Merge branch 'main' into kafka-deprecate
vishaangelova May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions reference/fleet/kafka-output-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,12 +259,12 @@ Configure timeout and buffer size values for the Kafka brokers.

**Default:** `2048`

`bulk_flush_frequency` $$$output-kafka-fleet-settings-flush_frequency-setting$$$
`bulk_flush_frequency` $$$output-kafka-fleet-settings-flush_frequency-setting$$$ {applies_to}`stack: deprecated 9.4.0+`
: (int) Duration to wait before sending bulk Kafka request. `0` is no delay.

**Default:** `0`

`channel_buffer_size` $$$output-kafka-fleet-settings-channel_buffer_size-setting$$$
`channel_buffer_size` $$$output-kafka-fleet-settings-channel_buffer_size-setting$$$ {applies_to}`stack: deprecated 9.4.0+`
: (int) Per Kafka broker number of messages buffered in output pipeline.

**Default:** `256`
Expand Down Expand Up @@ -315,16 +315,21 @@ Configure timeout and buffer size values for the Kafka brokers.
`metadata` $$$output-kafka-fleet-settings-metadata-setting$$$
: Kafka metadata update settings. The metadata contains information about brokers, topics, partition, and active leaders to use for publishing.

:::{note}
:applies_to: stack: ga 9.4.0+
Starting in 9.4.0, the Kafka client uses franz-go, so the `full`, `retry.max`, and `retry.backoff` metadata options no longer apply.
:::

**`refresh_frequency`**
: Metadata refresh interval. Defaults to 10 minutes.

**`full`**
**`full`** {applies_to}`stack: removed 9.4+`
: Strategy to use when fetching metadata. When this option is `true`, the client will maintain a full set of metadata for all the available topics. When set to `false` it will only refresh the metadata for the configured topics. The default is false.

**`retry.max`**
**`retry.max`** {applies_to}`stack: removed 9.4+`
: Total number of metadata update retries. The default is 3.

**`retry.backoff`**
**`retry.backoff`** {applies_to}`stack: removed 9.4+`
: Waiting time between retries. The default is 250ms.

`queue.mem.events` $$$output-kafka-fleet-settings-queue.mem.events-setting$$$
Expand Down
18 changes: 12 additions & 6 deletions reference/fleet/kafka-output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# Kafka output [kafka-output]


The Kafka output sends events to Apache Kafka.
The Kafka output sends events to Apache Kafka. Starting in 9.4.0, the Kafka client uses franz-go instead of Sarama, and [some options](#kafka-metadata-setting) are no longer configurable.

Check warning on line 16 in reference/fleet/kafka-output.md

View workflow job for this annotation

GitHub Actions / build / vale 

Elastic.Spelling: 'Sarama' is a possible misspelling.

**Compatibility:** This output can connect to Kafka version 0.8.2.0 and later. Older versions might work as well, but are not supported.

Expand Down Expand Up @@ -279,7 +279,7 @@

**Default:** `10` (seconds)

`bulk_flush_frequency` $$$kafka-bulk_flush_frequency-setting$$$
`bulk_flush_frequency` $$$kafka-bulk_flush_frequency-setting$$$ {applies_to}`stack: deprecated 9.4.0+`
: (int) Duration to wait before sending bulk Kafka request. `0` is no delay.

**Default:** `0`
Expand All @@ -289,7 +289,7 @@

**Default:** `2048`

`channel_buffer_size` $$$kafka-channel_buffer_size-setting$$$
`channel_buffer_size` $$$kafka-channel_buffer_size-setting$$$ {applies_to}`stack: deprecated 9.4.0+`
: (int) Per Kafka broker number of messages buffered in output pipeline.

**Default:** `256`
Expand Down Expand Up @@ -337,16 +337,22 @@

`metadata` $$$kafka-metadata-setting$$$
: Kafka metadata update settings. The metadata contains information about brokers, topics, partition, and active leaders to use for publishing.

:::{note}
:applies_to: stack: ga 9.4.0+
Starting in 9.4.0, the Kafka client uses franz-go, so the `full`, `retry.max`, and `retry.backoff` metadata options no longer apply.
:::

`refresh_frequency`
: Metadata refresh interval. Defaults to 10 minutes.

`full`
`full` {applies_to}`stack: removed 9.4+`
: Strategy to use when fetching metadata. When this option is `true`, the client will maintain a full set of metadata for all the available topics. When set to `false` it will only refresh the metadata for the configured topics. The default is false.

`retry.max`
`retry.max` {applies_to}`stack: removed 9.4+`
: Total number of metadata update retries. The default is 3.

`retry.backoff`
`retry.backoff` {applies_to}`stack: removed 9.4+`
: Waiting time between retries. The default is 250ms.

`required_acks` $$$kafka-required_acks-setting$$$
Expand Down
Loading