Tag upstream API errors at error level with service/upstreamStatus/at…#848
Open
swdpcomputing wants to merge 4 commits intomainfrom
Open
Tag upstream API errors at error level with service/upstreamStatus/at…#848swdpcomputing wants to merge 4 commits intomainfrom
swdpcomputing wants to merge 4 commits intomainfrom
Conversation
swdpcomputing
force-pushed
the
bugfix/TGC-1057-logging-be-502-to-fe-500
branch
from
d9ccd63 to
d83cbce
Compare
swdpcomputing
force-pushed
the
bugfix/TGC-1057-logging-be-502-to-fe-500
branch
from
b3d601a to
09908b6
Compare
swdpcomputing
force-pushed
the
bugfix/TGC-1057-logging-be-502-to-fe-500
branch
from
09908b6 to
28a12bc
Compare
|
| return apiResponse | ||
| } catch (error) { | ||
| debug(LogCodes.SYSTEM.EXTERNAL_API_ERROR, { endpoint: 'agreements', errorMessage: error.message }, request) | ||
| logAgreementsUpstreamError(request, error) |
Contributor
There was a problem hiding this comment.
I'm not sure about this one 😂 clearly trying to get around the ESLint rule by encapsulating the log in another function. Let's discuss this with @alanplatt, as it might be wrong to wholly deny log in catch blocks.
Contributor
Author
There was a problem hiding this comment.
Not dodging the rule! log/logger are already on the exclude list in eslint.config.js. Pulled it into a helper because the payload got chunky. Same shape as handleVerificationError in verify-token.js. Happy to inline it, or chat with Alan.
This file contains hidden or 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
2 participants
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.
When grants-ui-backend goes down (like the failed deployment in dev that returned 502s), grants-ui in front of it returns a 500. The logs say "the BE is the cause" and are emitted at debug level and don't include the upstream HTTP status or which service had failed, so they were filtered out by default and nobody knew why grants-ui was 500ing.
This PR:
Tags every outgoing-call error with structured felds. Every call to grants-ui-backend, GAS, agreements, or consolidated-view now logs service, upstreamStatus, and (on retry-exhaustion) attempts.
Promotes those logs from debug to error level. The previous debug() wrapper forced everything down to debug regardless of declared level. This swaps to log() which respects the declared level.
So now an alert query like level=error AND service=grants-ui-backend AND upstreamStatus>=500 now matches the next time the BE fails, so we hear about it. User-facing behaviour is unchanged, the 500 page still renders. The alerting-channel investigation (second half of the ticket) is a separate config task.