fix(logging): circular JSON errors in Winston logs by summarizing HTTP/Axios objects #1389
+61
−8
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
After the recent logging changes in PR #1340, Winston started throwing
Converting circular structure to JSONerrors when logging HTTP requests/responses or Axios errors. This was caused byreq,res, andconfigobjects containing circular references that cannot be stringified directly.Changes made
sanitizeMetaWinston format to safely summarize log metadata.req→ only logs{ method, url, requestId, correlationId }res→ only logs{ statusCode }config(Axios request config) → only logs{ method, url, headers['X-Api-Key'] }request/responsealiases are replaced with"[request omitted]"/"[response omitted]"when noreq/resexist.Log examples
Before this fix:
After this fix: