Skip to content

Commit 7a89e67

Browse files
authored
[Docs] Link to AWS SDK documentation for requests logging (elastic#100491) (elastic#100749)
Co-authored-by: David Turner [email protected]
1 parent b4a62ac commit 7a89e67

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

docs/reference/snapshot-restore/repository-s3.asciidoc

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,8 +234,30 @@ using the {ref}/repo-analysis-api.html[repository analysis API]. If this API
234234
does not complete successfully, or indicates poor performance, then your
235235
storage system is not fully compatible with AWS S3 and therefore unsuitable for
236236
use as a snapshot repository. However, these checks do not guarantee full
237-
compatibility. Incompatible error codes and consistency or performance issues
238-
may be rare and hard to reproduce.
237+
compatibility.
238+
239+
Most storage systems can be configured to log the details of their interaction
240+
with {es}. If you are investigating a suspected incompatibility with AWS S3, it
241+
is usually simplest to collect these logs and provide them to the supplier of
242+
your storage system for further analysis. If the incompatibility is not clear
243+
from the logs emitted by the storage system, configure {es} to log every
244+
request it makes to the S3 API by <<configuring-logging-levels,setting the
245+
logging level>> of the `com.amazonaws.request` logger to `DEBUG`:
246+
247+
[source,console]
248+
----
249+
PUT /_cluster/settings
250+
{
251+
"persistent": {
252+
"logger.com.amazonaws.request": "DEBUG"
253+
}
254+
}
255+
----
256+
// TEST[skip:we don't really want to change this logger]
257+
258+
The supplier of your storage system will be able to analyse these logs to determine the problem. See
259+
the https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-logging.html[AWS Java SDK]
260+
documentation for further information.
239261

240262
[[repository-s3-repository]]
241263
==== Repository settings

0 commit comments

Comments
 (0)