@@ -60,23 +60,41 @@ measure the performance characteristics of your storage system.
60
60
The default values for the parameters to this API are deliberately low to reduce
61
61
the impact of running an analysis inadvertently and to provide a sensible
62
62
starting point for your investigations. Run your first analysis with the default
63
- parameter values to check for simple problems. If successful, run a sequence of
64
- increasingly large analyses until you encounter a failure or you reach a
65
- `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a
66
- `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at
67
- least `100`. Always specify a generous timeout, possibly `1h` or longer, to
68
- allow time for each analysis to run to completion. Perform the analyses using a
69
- multi-node cluster of a similar size to your production cluster so that it can
70
- detect any problems that only arise when the repository is accessed by many
71
- nodes at once.
63
+ parameter values to check for simple problems. Some repositories may behave
64
+ correctly when lightly loaded but incorrectly under production-like workloads.
65
+ If the first analysis is successful, run a sequence of increasingly large
66
+ analyses until you encounter a failure or you reach a `blob_count` of at least
67
+ `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least
68
+ `1tb`, and a `register_operation_count` of at least `100`. Always specify a
69
+ generous timeout, possibly `1h` or longer, to allow time for each analysis to
70
+ run to completion. Some repositories may behave correctly when accessed by a
71
+ small number of {es} nodes but incorrectly when accessed concurrently by a
72
+ production-scale cluster. Perform the analyses using a multi-node cluster of a
73
+ similar size to your production cluster so that it can detect any problems that
74
+ only arise when the repository is accessed by many nodes at once.
72
75
73
76
If the analysis fails then {es} detected that your repository behaved
74
- unexpectedly. This usually means you are using a third-party storage system
75
- with an incorrect or incompatible implementation of the API it claims to
76
- support. If so, this storage system is not suitable for use as a snapshot
77
- repository. You will need to work with the supplier of your storage system to
78
- address the incompatibilities that {es} detects. See
79
- <<self-managed-repo-types>> for more information.
77
+ unexpectedly. This usually means you are using a third-party storage system with
78
+ an incorrect or incompatible implementation of the API it claims to support. If
79
+ so, this storage system is not suitable for use as a snapshot repository.
80
+ Repository analysis triggers conditions that occur only rarely when taking
81
+ snapshots in a production system. Snapshotting to unsuitable storage may appear
82
+ to work correctly most of the time despite repository analysis failures. However
83
+ your snapshot data is at risk if you store it in a snapshot repository that does
84
+ not reliably pass repository analysis. You can demonstrate that the analysis
85
+ failure is due to an incompatible storage implementation by verifying that
86
+ Elasticsearch does not detect the same problem when analysing the reference
87
+ implementation of the storage protocol you are using. For instance, if you are
88
+ using storage that offers an API which the supplier claims to be compatible with
89
+ AWS S3, verify that repositories in AWS S3 do not fail repository analysis. This
90
+ allows you to demonstrate to your storage supplier that a repository analysis
91
+ failure must only be caused by an incompatibility with AWS S3 and cannot be
92
+ attributed to a problem in Elasticsearch. Please do not report Elasticsearch
93
+ issues involving third-party storage systems unless you can demonstrate that the
94
+ same issue exists when analysing a repository that uses the reference
95
+ implementation of the same storage protocol. You will need to work with the
96
+ supplier of your storage system to address the incompatibilities that {es}
97
+ detects. See <<self-managed-repo-types>> for more information.
80
98
81
99
If the analysis is successful this API returns details of the testing process,
82
100
optionally including how long each operation took. You can use this information
0 commit comments