Generalize TCP retxn docs to cover remote clusters #74732
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Today the docs on setting `tcp_retries2` only talk about intra-cluster connections, but in fact this setting is equally important to the resilience of remote cluster connections too. This commit rewords these docs to cover both cases. Relates elastic#34405
DaveCTurner
added
>docs
elasticmachine
added
Team:Distributed (Obsolete)
|
Pinging @elastic/es-distributed (Team:Distributed) |
|
Pinging @elastic/es-docs (Team:Docs) |
jrodewig
approved these changes
Jun 30, 2021
| they can react promptly by reallocating lost shards, rerouting searches and | ||
| perhaps electing a new master node. Linux users should therefore reduce the | ||
| maximum number of TCP retransmissions. | ||
| very long periods of packet loss but this default is excessive and even harmful |
There was a problem hiding this comment.
Nit: Compound sentences require a comma before the conjuction.
Suggested change
| very long periods of packet loss but this default is excessive and even harmful | |
| very long periods of packet loss, but this default is excessive and even harmful |
| perhaps electing a new master node. Linux users should therefore reduce the | ||
| maximum number of TCP retransmissions. | ||
| very long periods of packet loss but this default is excessive and even harmful | ||
| on the high quality networks used by most {es} installations. Highly-available |
There was a problem hiding this comment.
Nit: No hyphen needed.
Suggested change
| on the high quality networks used by most {es} installations. Highly-available | |
| on the high quality networks used by most {es} installations. Highly available |
| maximum number of TCP retransmissions. | ||
| very long periods of packet loss but this default is excessive and even harmful | ||
| on the high quality networks used by most {es} installations. Highly-available | ||
| clusters must be able to detect node failures promptly in order to react by |
There was a problem hiding this comment.
Nit: This sentence gets a bit long. I'd break it into two. Regardless, in order to can be shortened to to.
Suggested change
| clusters must be able to detect node failures promptly in order to react by | |
| clusters must be able to detect node failures promptly. This lets the cluster react by |
| very long periods of packet loss but this default is excessive and even harmful | ||
| on the high quality networks used by most {es} installations. Highly-available | ||
| clusters must be able to detect node failures promptly in order to react by | ||
| reallocating lost shards, rerouting searches and perhaps electing a new master |
There was a problem hiding this comment.
Nit: We tend to use an Oxford comma.
Suggested change
| reallocating lost shards, rerouting searches and perhaps electing a new master | |
| reallocating lost shards, rerouting searches, or electing a new master |
| reliability of communication with systems outside your cluster too. If your | ||
| cluster communicates with external systems over an unreliable network then you | ||
| reliability of communication with systems other than {es} clusters too. If your | ||
| clusters communicate with external systems over a low-quality network then you |
There was a problem hiding this comment.
Nit: No hyphen needed.
Suggested change
| clusters communicate with external systems over a low-quality network then you | |
| clusters communicate with external systems over a low quality network then you |
| or communication between the nodes is disrupted by a failure in the underlying | ||
| Each pair of {es} nodes communicates via a number of TCP connections which | ||
| <<long-lived-connections,remain open>> until one of the nodes shuts down or | ||
| communication between the nodes is disrupted by a failure in the underlying | ||
| infrastructure. | ||
|
|
||
| TCP provides reliable communication over occasionally-unreliable networks by |
There was a problem hiding this comment.
Nit: No hyphen is needed between an adverb and adjective.
Suggested change
| TCP provides reliable communication over occasionally-unreliable networks by | |
| TCP provides reliable communication over occasionally unreliable networks by |
DaveCTurner
added a commit
that referenced
this pull request
Jul 5, 2021
Today the docs on setting `tcp_retries2` only talk about intra-cluster connections, but in fact this setting is equally important to the resilience of remote cluster connections too. This commit rewords these docs to cover both cases. Relates #34405
DaveCTurner
added a commit
that referenced
this pull request
Jul 5, 2021
Today the docs on setting `tcp_retries2` only talk about intra-cluster connections, but in fact this setting is equally important to the resilience of remote cluster connections too. This commit rewords these docs to cover both cases. Relates #34405
DaveCTurner
added a commit
that referenced
this pull request
Jul 5, 2021
Today the docs on setting `tcp_retries2` only talk about intra-cluster connections, but in fact this setting is equally important to the resilience of remote cluster connections too. This commit rewords these docs to cover both cases. Relates #34405
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today the docs on setting
tcp_retries2only talk about intra-clusterconnections, but in fact this setting is equally important to the
resilience of remote cluster connections too. This commit rewords these
docs to cover both cases.
Relates #34405