Repository navigation
feat: structured JSON logging with request id tracing - #255
Open
Nwapu-TrustJah wants to merge 1 commit into
Open
Nwapu-TrustJah wants to merge 1 commit into
Nwapu-TrustJah wants to merge 1 commit into
Conversation
|
@Nwapu-TrustJah 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 branch has not been deployed
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.
Overview
This PR replaces interpolated
console.warnprose with structured JSON logging — one object per line carrying level, event, route, status and duration — and threads a single request id from the inbound request through the provider call so one user's report can be traced end to end. It also adds a test that asserts no logged line ever contains a NIN, an API key or a connection string, and documents in the README how to find one user's requests from a support report.Related Issue
Changes
🧱 Structured Logger
[ADD]
src/logger.tslevel,event,route,statusanddurationMs.[ADD]
src/middleware/requestId.ts[MODIFY]
src/index.tsconsole.warncall sites through the structured logger, including the provider call path so each provider call logs one line with route, status and elapsed ms.[ADD]
src/__tests__/logger.test.tsVerification Results
route,status,durationMssrc/__tests__/logger.test.tsasserts redaction across captured linesCloses #240