Add structured, correlation-ID request logging middleware

[meshackyaro]

Description

Every service across the backend logs via NestJS's built-in Logger with free-form string messages (e.g. this.logger.log(\Migration ${name} (${run.runId}) completed`)insrc/migration/migration-runner.service.ts, similar patterns throughout src/gig/, src/dispute/, src/event-ingestion/) — there is no request-scoped correlation/trace ID generated anywhere, and no structured (JSON) log output. src/common/filters/sentry-exception.filter.ts` captures unhandled 5xx errors to Sentry, but there's no way to correlate a given Sentry event with the specific application log lines emitted while handling that same request, since neither carries a shared identifier. In production, tracing a single request's full lifecycle (auth → rate limit → controller → service → webhook dispatch) across logs currently requires guessing based on timestamps and content alone.

Component

Backend

Difficulty

🔴 Hard

Tasks

• Add middleware that generates (or propagates an inbound X-Request-Id header as) a correlation ID for every request, attaching it to the request object
• Thread the correlation ID into the Logger context (e.g. via NestJS's AsyncLocalStorage or a request-scoped logger) so every log line emitted while handling a request includes it
• Attach the same ID as a Sentry tag in SentryExceptionFilter (src/common/filters/sentry-exception.filter.ts) so Sentry events can be cross-referenced with application logs
• Add a test asserting the correlation ID appears consistently across a sample request's log output and any resulting Sentry capture

Acceptance Criteria

• Every log line emitted during a single request's handling shares a common correlation/request ID
• The same ID is attached to any Sentry event captured during that request
• A test covers ID propagation end to end

Estimated Time

1-2 days

[marimuthusanthosh]

Hi @meshackyaro, I’ve implemented and tested the changes for #247 – Add structured, correlation-ID request logging middleware.

The implementation covers:

• Request ID generation/propagation via X-Request-Id
• Request ID attachment to the request object and response headers
• AsyncLocalStorage-based propagation across async request handling
• Request-scoped logger correlation so logs include the same request ID
• Sentry request_id / correlation_id tags for cross-referencing logs and Sentry events
• End-to-end regression test verifying consistent ID propagation

I’ve also mapped the implementation to the requirements and acceptance criteria in the PR description.

PR: #258

Could you please assign #247 to me, review the PR, and approve it if everything looks good? If any changes or improvements are needed, please let me know and I’ll address them.

Thank you!

[paulddeveloper-droid]

@paulddeveloper-droid has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I’d like to work on this issue. I’ve reviewed the requirements and understand the expected changes. I’ll follow the existing project patterns, add the required tests, and keep the implementation within the stated scope. I’m ready to start.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @paulddeveloper-droid to this issue.

[habnark]

@habnark has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

hello can i work on this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @habnark to this issue.

[OlaGreat]

@OlaGreat has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I'd like to take this on. I'm a software engineer with experience in blockchain, backend systems, and open-source contribution. I've reviewed the issue and I'm confident I can deliver a clean implementation with tests covering the acceptance criteria. Happy to follow the project's existing conventions.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @OlaGreat to this issue.

[veracindarella]

@veracindarella has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hi maintainer, please assign

ℹ️ Repo Maintainers: To accept this application, review their application or assign @veracindarella to this issue.

[CollinsKRO]

@CollinsKRO has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hi, I can fix this kindly assign.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @CollinsKRO to this issue.

[chiomailekuba]

@chiomailekuba has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Gm

Please i am a blockchain developer

please i would love to work on this issue

i would be honoured to be a contributor to this great project

ℹ️ Repo Maintainers: To accept this application, review their application or assign @chiomailekuba to this issue.

[Muyideen-js]

@Muyideen-js has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hi, I can fix this

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Muyideen-js to this issue.