Skip to content

Commit 7791e72

Browse files
authored
Add additional explanations around discovery.zen.ping_timeout (#27231)
Makes it clearer that this setting should only be changed with extra care.
1 parent b294250 commit 7791e72

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/reference/modules/discovery/zen.asciidoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,15 @@ The unicast discovery uses the <<modules-transport,transport>> module to perform
5656

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

0 commit comments

Comments
 (0)