From 50f61e581a156be8b543a7264de2eeeb8df0e015 Mon Sep 17 00:00:00 2001 From: Tanguy Leroux Date: Mon, 9 Oct 2023 11:44:14 +0200 Subject: [PATCH 1/2] [Docs] Link to AWS SDK documentation for requests logging --- docs/reference/snapshot-restore/repository-s3.asciidoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/reference/snapshot-restore/repository-s3.asciidoc b/docs/reference/snapshot-restore/repository-s3.asciidoc index 16171e2e71631..277ba4386c3b3 100644 --- a/docs/reference/snapshot-restore/repository-s3.asciidoc +++ b/docs/reference/snapshot-restore/repository-s3.asciidoc @@ -235,7 +235,10 @@ does not complete successfully, or indicates poor performance, then your storage system is not fully compatible with AWS S3 and therefore unsuitable for use as a snapshot repository. However, these checks do not guarantee full compatibility. Incompatible error codes and consistency or performance issues -may be rare and hard to reproduce. +may be rare and hard to reproduce. Their resolution often require to analyze +the requests and responses exchanged between Elasticsearch and the S3-compatible +service, which can be done by enabling low-level logging in the +https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-logging.html[AWS Java SDK]. [[repository-s3-repository]] ==== Repository settings From ec4a5c2ef00f3382bb0ae91c760ff262283fb4e1 Mon Sep 17 00:00:00 2001 From: Tanguy Leroux Date: Mon, 9 Oct 2023 13:37:36 +0200 Subject: [PATCH 2/2] feedback --- .../snapshot-restore/repository-s3.asciidoc | 29 +++++++++++++++---- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/reference/snapshot-restore/repository-s3.asciidoc b/docs/reference/snapshot-restore/repository-s3.asciidoc index 277ba4386c3b3..1b8c1c3b36339 100644 --- a/docs/reference/snapshot-restore/repository-s3.asciidoc +++ b/docs/reference/snapshot-restore/repository-s3.asciidoc @@ -234,11 +234,30 @@ using the {ref}/repo-analysis-api.html[repository analysis API]. If this API does not complete successfully, or indicates poor performance, then your storage system is not fully compatible with AWS S3 and therefore unsuitable for use as a snapshot repository. However, these checks do not guarantee full -compatibility. Incompatible error codes and consistency or performance issues -may be rare and hard to reproduce. Their resolution often require to analyze -the requests and responses exchanged between Elasticsearch and the S3-compatible -service, which can be done by enabling low-level logging in the -https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-logging.html[AWS Java SDK]. +compatibility. + +Most storage systems can be configured to log the details of their interaction +with {es}. If you are investigating a suspected incompatibility with AWS S3, it +is usually simplest to collect these logs and provide them to the supplier of +your storage system for further analysis. If the incompatibility is not clear +from the logs emitted by the storage system, configure {es} to log every +request it makes to the S3 API by <> of the `com.amazonaws.request` logger to `DEBUG`: + +[source,console] +---- +PUT /_cluster/settings +{ + "persistent": { + "logger.com.amazonaws.request": "DEBUG" + } +} +---- +// TEST[skip:we don't really want to change this logger] + +The supplier of your storage system will be able to analyse these logs to determine the problem. See +the https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-logging.html[AWS Java SDK] +documentation for further information. [[repository-s3-repository]] ==== Repository settings