Phase 13 · Lesson 04

Request IDs and Structured Logging

≈ 2 min core reading · 380 source/companion words
Learning contract

What you should be able to do after this

  • Explain Request IDs and Structured Logging without relying on framework buzzwords.
  • Connect the lesson to the phase outcome: Create a stable application error model that separates expected domain/transport failures from unexpected faults and keeps diagnostics observable.
  • Reproduce the relevant behavior and verify it with evidence.
  • Diagnose at least one representative failure instead of guessing.
Figure 13.4 — TaskFlow boundary map
failure occurs
typed/application error
exception mapping
structured log
safe HTTP error
frontend recovery
This lesson belongs to Phase 13. Keep the full request/data path visible even when today's code changes only one box.
Instructor workflow: predict first → implement the smallest slice → run it → inspect evidence → break one assumption → diagnose → explain it back. Do not copy the whole code block before understanding the first failing boundary.

Request IDs & Structured Logging Use Fastify request IDs, response headers, timing, and NestJS 12 structured logger metadata

Phase 13 - Professional Error Handling Volume 04 - Professional Backend

Architecture milestone Fastify request.id

↓

interceptor

↓

x-request-id + success log

↓

exception filter for failures

Phase 13 creates one professional exception boundary and a correlation story that spans client response and server logs.

Fastify already gives every request an ID Fastify Request includes an id field. We can reuse it as the TaskFlow correlation identifier instead of inventing a separate request-context system during this phase.

import { CallHandler, ExecutionContext, Injectable, Logger, NestInterceptor, } from "@nestjs/common"; import { FastifyReply, FastifyRequest } from "fastify"; import { Observable } from "rxjs"; import { tap } from "rxjs/operators";

Code
@Injectable()
export class RequestLoggingInterceptor implements NestInterceptor {
private readonly logger = new Logger(RequestLoggingInterceptor.name);
Code
intercept(
context: ExecutionContext,
next: CallHandler,
): Observable<unknown> {
const http = context.switchToHttp();
const request = http.getRequest<FastifyRequest>();
const reply = http.getResponse<FastifyReply>();
const requestId = String(request.id);
const startedAt = performance.now();

reply.header("x-request-id", requestId);

return next.handle().pipe( tap(() => { this.logger.log("Request completed", { requestId, method: request.method, path: request.url, statusCode: reply.statusCode, durationMs: Math.round(performance.now() - startedAt), }); }), ); } }

What the interceptor owns • Read Fastify request.id.

• Return the same identifier in the x-request-id response header for successful responses.

• Measure request duration.

• Write one structured completion log after successful controller execution.

• Avoid swallowing exceptions; failures continue to the global exception filter.

Do not blindly trust caller-provided request IDs

Fastify can be configured to use an incoming request-id header, but its documentation warns that callers can then choose arbitrary values unless you validate them. TaskFlow keeps Fastify-generated IDs for now.

NestJS 12 structured logger metadata NestJS 12 treats plain objects passed after the message as structured parameters. That makes metadata such as requestId, method, path, durationMs, and statusCode easy to keep together in one log record.

this.logger.log("Request completed", { requestId, method: request.method, path: request.url, statusCode: reply.statusCode, durationMs, });

Success and failure logs have different owners The interceptor logs successful completion. The exception filter logs rejected requests and unexpected faults because it knows the final error classification and public status code. This avoids duplicate error logs for the same exception.

Figure 1 - Logging split Successful request

↓

RequestLoggingInterceptor logs completion

↓

Error request

↓

ApiExceptionFilter logs rejection/fault

One event per responsibility keeps logs readable.

Executable lesson studio · observability

Now turn the explanation into engineering skill.

Request IDs and Structured Logging matters because it changes a real boundary in TaskFlow. The goal is to understand the inputs, owner, observable output, and failure modes before adding more abstraction.

By the end, you should be able to

  • Explain Request IDs and Structured Logging in terms of concrete inputs, ownership, outputs, and evidence.
  • Implement or reproduce the smallest TaskFlow slice that demonstrates this observability concept.
  • Diagnose one representative observability failure using observable evidence instead of trial-and-error.
Figure 13.4B — Mental model
request
correlation id
structured event
metric/trace
diagnosis
Read left-to-right while implementing. When debugging, walk right-to-left until the first observed fact differs from your prediction.
Code-along sequence

One coherent change at a time

  1. 01

    Restate the goal of “Request IDs and Structured Logging” as one observable behavior. Write the success signal before touching code.

  2. 02

    Trace the boundary map: request → correlation id → structured event → metric/trace → diagnosis. Mark the one boundary this lesson changes.

  3. 03

    Inspect the current repository state and record the exact files, route, table, or runtime involved. Avoid creating an abstraction before you can name the existing owner.

  4. 04

    Implement the smallest vertical slice. Add one coherent change, run the narrowest verification command, and read the output before continuing.

  5. 05

    Connect the slice to TaskFlow’s phase artifact: Error taxonomy + NestJS mapping layer/filters + structured error response with request IDs.. Verify behavior from the outside as a user or API client would.

  6. 06

    Create one controlled failure that is safe to reproduce. Predict the symptom first, capture evidence, locate the earliest broken boundary, then fix only that cause.

  7. 07

    Close the reference and rebuild or explain the core change from memory. Record what you would monitor or test before trusting the same change in production.

tsLog structured context, not prose-only strings
logger.error({
  requestId, route: request.url, userId: user?.id,
  errorCode: error.code, durationMs,
}, "request failed");

Do not copy this as a finished answer. Predict what each boundary does, type the smallest useful slice, run it, then compare the result with your prediction.

Verification

Prove the happy path

  1. Run the narrowest relevant command or request and require a clean exit/status.
  2. Inspect the boundary-specific evidence: terminal output, Network panel, database row/query plan, test report, container health, or deployment logs.
  3. Repeat the behavior once after the change so a one-off cached or stale result cannot masquerade as success.
Break it on purpose

Build debugging memory

  1. Logging secrets/tokens with error context
  2. Change one assumption in the observability example—identity, input, configuration, ordering, connectivity, or state—and predict the exact symptom before running it.
SymptomInvestigation path
Expected result does not appear

Return to the nearest observable boundary: input, network, process log, database, or rendered UI. Compare actual evidence with the predicted path.

A shortcut appears to fix it

Change one variable at a time and reproduce the original failure after the fix; otherwise you have correlation, not diagnosis.

Closed-reference challenge

Can you transfer the idea?

Without copying the final source, create a second small scenario that applies “Request IDs and Structured Logging” to a different TaskFlow resource or input. Write the acceptance criteria first, implement it, and provide the evidence that each criterion is satisfied.

Explain-back

Answer these without reopening the solution

  1. What problem does Request IDs and Structured Logging solve in TaskFlow, and what would be observably wrong without it?
  2. Which part of the observability boundary owns the decision, and which neighboring layer must not own it?
  3. What evidence proves the happy path instead of merely suggesting it worked?
  4. Name one realistic failure or abuse case and the first place you would inspect.
  5. If requirements doubled tomorrow, which part of this design should stay stable and which part is allowed to change?
Lesson studio

Turn the reading into skill

01

Do it

Add request/correlation IDs to responses and logs.

Use the smallest change that demonstrates this lesson. Stop after it works and capture evidence.
02

Break it safely

Logging secrets/tokens with error context

Predict the symptom before causing the failure. Then locate the earliest boundary where reality diverges from expectation.
03

Explain it back

Why does this responsibility live here, what input does it trust, what output proves success, and what would go wrong if another layer owned it?

If your explanation is vague, repeat the boundary trace before moving on.
Exit ticket

Before marking complete

Close the reference. Reproduce the core idea from memory or explain the exact request/data flow aloud. Then check your diff or notes for accidental shortcuts that bypass validation, authorization, error handling, or verification earned in earlier phases.