Skip to content

Commit 379ac6d

Browse files
authored
Clarify index recovery docs (#91861) (#91923)
Mentions that we only report on recoveries for shard copies that actually exist in the cluster, so you don't see all historical data if, e.g., the shard copy relocates elsewhere.
1 parent cf624bd commit 379ac6d

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

docs/reference/indices/recovery.asciidoc

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@
44
<titleabbrev>Index recovery</titleabbrev>
55
++++
66

7-
8-
Returns information about ongoing and completed shard recoveries for one or more
9-
indices. For data streams, the API returns information for the stream's backing
10-
indices.
7+
Returns information about ongoing and completed shard recoveries for one or
8+
more indices. For data streams, the API returns information for the stream's
9+
backing indices.
1110

1211
[source,console]
1312
----
@@ -33,14 +32,14 @@ index, or alias.
3332
[[index-recovery-api-desc]]
3433
==== {api-description-title}
3534

36-
Use the index recovery API
37-
to get information about ongoing and completed shard recoveries.
35+
Use the index recovery API to get information about ongoing and completed shard
36+
recoveries.
3837

3938
// tag::shard-recovery-desc[]
40-
Shard recovery is the process
41-
of syncing a replica shard from a primary shard.
42-
Upon completion,
43-
the replica shard is available for search.
39+
Shard recovery is the process of initializing a shard copy, such as restoring a
40+
primary shard from a snapshot or syncing a replica shard from a primary shard.
41+
When a shard recovery completes, the recovered shard is available for search
42+
and indexing.
4443

4544
Recovery automatically occurs during the following processes:
4645

@@ -52,6 +51,14 @@ Recovery automatically occurs during the following processes:
5251
<<indices-split-index,split>> operation.
5352
// end::shard-recovery-desc[]
5453

54+
The index recovery API reports information about completed recoveries only for
55+
shard copies that currently exist in the cluster. It only reports the last
56+
recovery for each shard copy and does not report historical information about
57+
earlier recoveries, nor does it report information about the recoveries of
58+
shard copies that no longer exist. This means that if a shard copy completes a
59+
recovery and then {es} relocates it onto a different node then the information
60+
about the original recovery will not be shown in the recovery API.
61+
5562
[[index-recovery-api-path-params]]
5663
==== {api-path-parms-title}
5764

0 commit comments

Comments
 (0)