feat: add structured logging for creator list timeouts#386
Merged
Conversation
|
@shadrach68 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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
Resolves #374
Previously, when the creator list endpoint timed out, a generic 500 error was surfaced to the client, but it lacked structured server-side context to debug why it timed out. This PR introduces a specific guard in the error middleware to catch timeouts on this endpoint and emit a warn-level log with the necessary context (request ID, elapsed time, and query parameters) to diagnose slow queries.
Changes Made
isCreatorListTimeouttype guard insrc/middlewares/error.middleware.tsto identify timeouts onGET /api/v1/creators.logger.warnwith structured fields:requestIdelapsedMsqueryParamsmapUnknownRouteErrorso the client still receives the expected500error envelope.src/middlewares/error.middleware.test.tsto verify the log output and response stability.Acceptance Criteria Met
Testing
jestsuccessfully.logger.warnreceives the exact structured object expected.