Skip to content
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.

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

[libbeat] Document the Kafka output backoff settings #22393

Merged
merged 1 commit into from
Nov 5, 2020
Merged
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions libbeat/outputs/kafka/docs/kafka.asciidoc
Original file line number Diff line number Diff line change
@@ -232,6 +232,19 @@ Set `max_retries` to a value less than 0 to retry until all events are published
The default is 3.
endif::[]

===== `backoff.init`

The number of seconds to wait before trying to republish to Kafka
after a network error. After waiting `backoff.init` seconds, {beatname_uc}
tries to republish. If the attempt fails, the backoff timer is increased
exponentially up to `backoff.max`. After a successful publish, the backoff
timer is reset. The default is 1s.

===== `backoff.max`

The maximum number of seconds to wait before attempting to republish to
Kafka after a network error. The default is 60s.

===== `bulk_max_size`

The maximum number of events to bulk in a single Kafka request. The default is 2048.