Skip to content

[Docs] Link to AWS SDK documentation for requests logging #100491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tlrx merged 2 commits into from
Oct 12, 2023
Merged

[Docs] Link to AWS SDK documentation for requests logging #100491

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50f61e5
[Docs] Link to AWS SDK documentation for requests logging
tlrx Oct 9, 2023
ec4a5c2
feedback
tlrx Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions docs/reference/snapshot-restore/repository-s3.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +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.
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 <<configuring-logging-levels,setting the
logging level>> 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
Expand Down