Skip to content

Commit e37604c

Browse files
Allow missing shard stats for restarted nodes for _snapshot/_status
Adds a note explaining the change made in elasticsearch PR #128399 to reduce latency when getting stats for currently running snapshots. Relates ES-10982
1 parent 3e527a8 commit e37604c

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

specification/snapshot/status/SnapshotStatusRequest.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ import { Duration } from '@_types/Time'
3030
*
3131
* If you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots.
3232
* This usage is preferred.
33+
* Note that if a node has been restarted or has left the cluster since completing a shard snapshot the stats for that shard will be unavailable.
34+
* Loading the stats from the repository is an expensive operation (see the WARNING below), so to minimize latency for returning stats for currently
35+
* running snapshots the stats values will be zero for these shards even though the "stage" value will be "DONE". A "description" field will be set
36+
* on these shard stats instances indicating why they are empty. Note that the total stats for the index will be less than expected due to the
37+
* missing values from these shards.
3338
* If needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.
3439
*
3540
* WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.

0 commit comments

Comments
 (0)