Add additional explanations around discovery.zen.ping_timeout (#27231)

Makes it clearer that this setting should only be changed with extra care.
This commit is contained in:
Yannick Welsch 2017-11-02 16:52:10 +01:00 committed by GitHub
parent b294250aba
commit 7791e72626
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 3 deletions

View File

@ -56,9 +56,15 @@ The unicast discovery uses the <<modules-transport,transport>> module to perform
As part of the ping process a master of the cluster is either As part of the ping process a master of the cluster is either
elected or joined to. This is done automatically. The elected or joined to. This is done automatically. The
`discovery.zen.ping_timeout` (which defaults to `3s`) allows for the `discovery.zen.ping_timeout` (which defaults to `3s`) determines how long the node
tweaking of election time to handle cases of slow or congested networks will wait before deciding on starting an election or joining an existing cluster.
(higher values assure less chance of failure). Once a node joins, it Three pings will be sent over this timeout interval. In case where no decision can be
reached after the timeout, the pinging process restarts.
In slow or congested networks, three seconds might not be enough for a node to become
aware of the other nodes in its environment before making an election decision.
Increasing the timeout should be done with care in that case, as it will slow down the
election process.
Once a node decides to join an existing formed cluster, it
will send a join request to the master (`discovery.zen.join_timeout`) will send a join request to the master (`discovery.zen.join_timeout`)
with a timeout defaulting at 20 times the ping timeout. with a timeout defaulting at 20 times the ping timeout.