-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[DOCS] Clarify Recovery Settings for Shard Relocation #40329
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
fdf8abd
Clarify that peer recovery settings apply to shard relocation
jrodewig 82e01b3
Fix awkward wording of 1st sentence
jrodewig d09877e
[DOCS] Remove snapshot recovery reference.
jrodewig cc55584
Merge remote-tracking branch 'elasticsearch/master' into recovery-rew…
jrodewig File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,39 @@ | ||
| [[recovery]] | ||
| === Indices Recovery | ||
|
|
||
| <<cat-recovery,Peer recovery>> is the process used to build a new copy of a | ||
| shard on a node by copying data from the primary. {es} uses this peer recovery | ||
| process to rebuild shard copies that were lost if a node has failed, and uses | ||
| the same process when migrating a shard copy between nodes to rebalance the | ||
| cluster or to honor any changes to the <<modules-cluster,shard allocation | ||
| settings>>. | ||
| <<cat-recovery, Peer recovery>> syncs data from a primary shard to a new or | ||
| existing shard copy. | ||
|
|
||
| The following _expert_ setting can be set to manage the resources consumed by | ||
| peer recoveries: | ||
| Peer recovery automatically occurs when {es}: | ||
|
|
||
| * Recreates a shard lost during node failure | ||
| * Relocates a shard to another node due to a cluster rebalance or changes to the | ||
| <<modules-cluster, shard allocation settings>> | ||
| * Restores a <<modules-snapshots, snapshot>> | ||
|
|
||
| [float] | ||
| ==== Peer recovery settings | ||
| You can use the following _expert_ settings to manage resources for peer | ||
|
||
| recoveries. These settings apply to all peer recoveries, including | ||
| those related to shard relocation or snapshot restoration. | ||
|
|
||
| `indices.recovery.max_bytes_per_sec`:: | ||
| Limits the total inbound and outbound peer recovery traffic on each node. | ||
| Since this limit applies on each node, but there may be many nodes | ||
| performing peer recoveries concurrently, the total amount of peer recovery | ||
| traffic within a cluster may be much higher than this limit. If you set | ||
| this limit too high then there is a risk that ongoing peer recoveries will | ||
| consume an excess of bandwidth (or other resources) which could destabilize | ||
| the cluster. Defaults to `40mb`. | ||
| Limits total inbound and outbound recovery traffic for each node. | ||
| Defaults to `40mb`. | ||
| + | ||
| This limit applies to nodes only. If multiple nodes in a cluster perform | ||
| recoveries at the same time, the cluster's total recovery traffic may exceed | ||
| this limit. | ||
| + | ||
| If this limit is too high, ongoing recoveries may consume an excess | ||
| of bandwidth and other resources, which can destabilize the cluster. | ||
|
|
||
| `indices.recovery.max_concurrent_file_chunks`:: | ||
| Controls the number of file chunk requests that can be sent in parallel per recovery. | ||
| As multiple recoveries are already running in parallel (controlled by | ||
| cluster.routing.allocation.node_concurrent_recoveries), increasing this expert-level | ||
| setting might only help in situations where peer recovery of a single shard is not | ||
| reaching the total inbound and outbound peer recovery traffic as configured by | ||
| indices.recovery.max_bytes_per_sec, but is CPU-bound instead, typically when using | ||
| transport-level security or compression. Defaults to `2`. | ||
| Number of file chunk requests sent in parallel for each recovery. Defaults to | ||
| `2`. | ||
| + | ||
| You can increase the value of this setting when the recovery of a single shard | ||
| is not reaching the traffic limit set by `indices.recovery.max_bytes_per_sec`. | ||
|
|
||
| This setting can be dynamically updated on a live cluster with the | ||
| <<cluster-update-settings,cluster-update-settings>> API. | ||
| You can use the <<cluster-update-settings, Cluster Update Settings>> API to | ||
| view and change these settings for a live cluster. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
recovery from snapshot is different to peer recovery and has different settings. Let's leave it out here.