[Issue #2521] Have the error response always return an internal request ID #2523
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
mdragon
reviewed
Oct 22, 2024
| data = { | ||
| "request.id": request.headers.get("x-amzn-requestid", ""), | ||
| "request.method": request.method, | ||
| "request.path": request.path, | ||
| "request.url_rule": str(request.url_rule), | ||
| # A backup ID in case the x-amzn-requestid isn't passed in |
There was a problem hiding this comment.
We should make sure we don't lose track of this, either using the X-amzn one in place of this or as an additional identifier (when it's present, and falling back to one we generate when it's missing). But we don't have to change that in this PR, if we want to just open a ticket to follow up in near future Sprint.
There was a problem hiding this comment.
We'll have to see whether the x-amzn-requestid field is even populated, that might have been something specific to the past project that this originally came from. I just left that one until we have a chance to dig into it more
mdragon
approved these changes
Oct 22, 2024
|
👀 ! |
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.
Summary
Fixes #2521
Time to review: 3 mins
Changes proposed
Return the internal request ID in all error responses
Context for reviewers
A follow-up from a discussion we had yesterday. This can aid in debugging as a user can just give us the ID and we can easily look up the corresponding logs.
Note
gin Flask is a request-local global context (ie. each request has their own separateg) which we use for storing a few other logging related things already safely. https://flask.palletsprojects.com/en/3.0.x/appcontext/#storing-dataAdditional information
An example of the logs that show the internal ID - note I trimmed out the full error message as it's a very long stack trace.
