-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Document backoff options #6903
Document backoff options #6903
Conversation
f5b22af
to
b16c10e
Compare
@urso I hope I got the details right this time. Right now we're ordering the options by how commonly they are used (with related options appearing next to each other). Not sure that's the best approach, but for now, I've added the options to an arbitrary location because I'm not sure how common it is for users to turn these knobs. |
libbeat/_meta/config.reference.yml
Outdated
#backoff.init: 1s | ||
|
||
# The maximum number of seconds to wait before attempting to connect to | ||
# Elasticsearch after a connection error. The default is 60s. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some more clarification:
backoff.init
is applied on an network error. If connection was active, but connection gets lost or some other protocol/network error occurs, beats will disconnect and use backoff.init
. After backoff.init
, beats try to reconnect. If the reconnect fails, the backoff is increased exponentially up to backoff.max
. After successful reconnect, the backoff timer is reset. On next network error, backoff will start with again with backoff.init
.
A (initial) connection error is just one potential error among others.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@urso I'm trying to get all these details into the paragraph without making it too long. Does this work?
The number of seconds to wait before trying to reconnect to Elasticsearch after
a network error. After waiting `backoff.init` seconds, {beatname_uc} tries to
reconnect. If the attempt fails, the backoff timer is increased exponentially up
to `backoff.max`. After a successful connection, the backoff timer is reset. The
default is 1s.
I've left the following sentence out because it restates the previous sentence: "On next network error, backoff will start with again with backoff.init."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dedemorton SGTM
a7a272a
to
4032597
Compare
@urso This PR is ready for a final review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
@dedemorton The PR breaks the build. |
4032597
to
9128e23
Compare
@urso I had to rebase and then run |
Adds backoff options for LS and ES outputs (closes elastic#5419)
Adds backoff options for LS and ES outputs (closes #5419)
Adds backoff options for LS and ES outputs (closes elastic#5419)
Adds backup options for LS and ES outputs (closes #5419)
NOTE: I wasn't sure quite where to add the options in the yaml file.
Do we want to say anything about the backoff factor used here? Probably not since it's not configurable?