-
Notifications
You must be signed in to change notification settings - Fork 18
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.
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
Enhance Flint error handling with detailed exception messages #348
Draft
dai-chen
wants to merge
9
commits into
opensearch-project:main
Choose a base branch
from
dai-chen:improve-error-handling
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Chen Dai <daichen@amazon.com>
Signed-off-by: Chen Dai <daichen@amazon.com>
Signed-off-by: Chen Dai <daichen@amazon.com>
Signed-off-by: Chen Dai <daichen@amazon.com>
Signed-off-by: Chen Dai <daichen@amazon.com>
dai-chen
commented
May 22, 2024
} catch { | ||
case e: Exception => | ||
// Extract and add root cause message to final error message | ||
val rootCauseMessage = extractRootCause(e) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to confirm whether any underlying error messages should be hidden from users for security reasons.
- If confirmed, we will hide these messages.
- Alternatively, we extract only the root cause message for known exceptions, such as those from OpenSearch or our own Flint exceptions (custom exception class).
Signed-off-by: Chen Dai <daichen@amazon.com>
Signed-off-by: Chen Dai <daichen@amazon.com>
Signed-off-by: Chen Dai <daichen@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR enhances the error handling capabilities of the FlintSpark class by improving the exceptions thrown during transaction operations. The new error handling approach includes root cause information, making it easier to diagnose and resolve issues.
Changes
withTransaction
method to centralize logging and exception handling across different operations withinFlintSpark
. This method standardizes transaction control and error reporting, reducing code redundancy and enhancing readability.withTransaction
method to include detailed root cause information in exceptions. When an operation fails, the catch block now enriches the thrown exceptions with clear, actionable error messages that explain why the operation failed.Testing
Index state doesn't satisfy the precondition
Tested index state exception for #201:
OpenSearch exception
Tested OpenSearch exception for #252:
Issues Resolved
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.