Logging errors in a structured format PoC, log-when-encountered approach #870
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of change
With this approach of error reporting we closely follow the existing logging approach, with which we log S3 request errors as soon as we encounter them in the
mountpoint-s3-client
.The perk of this approach is the simplicity of implementation as it does not require passing error type encoded by
s3_crt_client::S3RequestError
enum to the fs layer.For instance, information about an error type
S3RequestError::Forbidden
is inaccessible from theSuperblockInner::remote_lookup as the generic implementation of
SuperblockInner
only knows that the value returned byhead_object
isClientError
(as a part ofObjectClientResult<HeadObjectResult, HeadObjectError, Self::ClientError>
) which istype ClientError: std::error::Error + Send + Sync + 'static
. Next in theS3Filesystem::open
example,ClientError
is converted toInodeError::ClientError(#[source] anyhow::Error)
. EnumInodeError
will also require changes to propagate information with the required granularity to the S3FileSystem::open.The critical downside of this approach is that using it we will report errors even if they were retried by the fs layer and didn't make it to the user application.
Sample output (note transient
ClientError(IncorrectRegion(..))
being reported:PoC with reporting
Forbidden
from theS3Filesystem
follows in the next alternative PR.Relevant issues: #721
Does this change impact existing behavior?
The change in this form does not impact any of the existing behaviour.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the Developer Certificate of Origin (DCO).