feat: add Exception handle #1619
Open
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
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.
Purpose of the Pull Request:
This pull request introduces support for logging HTTPException errors in a structured and consistent manner. The goal is to improve error handling and logging for HTTP exceptions that occur within our application.
How to Test:
Trigger an HTTPException: Modify a route to intentionally raise an HTTPException.
Run the Application: Start the application using the standard development server.
Send a Request: Use a tool like curl or Postman to send a request that triggers the exception.
Verify Logs: Check the application logs to ensure that the HTTPException is logged with the correct status code, message, and any additional context.
To Validate the Changes:
Check Log Format: Ensure that the log entry for the HTTPException contains the status code, message, and relevant metadata.
Review Error Handling: Confirm that the application gracefully handles the exception and returns the appropriate response to the client.
Performance Impact: Monitor the application's performance before and after the change to ensure there is no significant impact.
Expected Outcomes:
Structured Logging: All HTTPException errors are logged with a consistent format, including the status code and message.
Enhanced Debugging: Developers can quickly identify and debug issues based on the detailed logs.
User Experience: Clients receive clear and informative error messages, enhancing the overall user experience.
Have You Tested This PR?
Yes, I have tested the latest commit on this PR. I verified the functionality by triggering various HTTPException scenarios and ensuring that the logs contain the expected information.
Related Issues or PRs:
#1618: This PR addresses the need for better logging of HTTP exceptions as discussed in this issue.
Is Your PR Over 500 Lines of Code?
No, this PR includes under 500 lines of code.
Additional Context:
The performance improvement was observed in our production environment after deploying these changes. The indexing strategy was carefully designed to optimize frequently used queries without impacting write performance. In the context of this PR, we have ensured that the logging enhancements do not introduce any significant overhead while still providing valuable insights into the application's behavior.