Request ID for tracing in Express - Step-by-Step Execution

Concept Flow - Request ID for tracing

Incoming HTTP Request

↓

Middleware: Check for existing Request ID

↓

Use existing

↓

Attach Request ID to request object

↓

Pass request to next middleware/handler

↓

Use Request ID in logs and responses

↓

Send response back to client

When a request comes in, middleware checks if it has a Request ID. If not, it creates one, attaches it to the request, and passes it along for consistent tracing.

Execution Sample

Express

import express from 'express';
import { v4 as uuidv4 } from 'uuid';

const app = express();

app.use((req, res, next) => {
  req.id = req.headers['x-request-id'] || uuidv4();
  next();
});

This middleware assigns a unique Request ID to each incoming request, either from the header or by generating a new UUID.

Execution Table

Step	Action	Request Headers	Request ID Present?	Request ID Assigned	Next Called
1	Incoming request received	{ }	No	Generated new UUID e.g. '123e4567-e89b-12d3-a456-426614174000'	No
2	Middleware checks for 'x-request-id' header	{ }	No	Assign new UUID to req.id	No
3	Middleware calls next()	{ }	No	req.id set	Yes
4	Request handled downstream	{ }	No	req.id accessible for logging	N/A
5	Response sent with Request ID header	{ }	No	Request ID included in response headers	N/A
6	Incoming request with existing ID	{'x-request-id': 'abc-123'}	Yes	Use existing 'abc-123' as req.id	No
7	Middleware calls next()	{'x-request-id': 'abc-123'}	Yes	req.id set to 'abc-123'	Yes
8	Request handled downstream	{'x-request-id': 'abc-123'}	Yes	req.id accessible for logging	N/A
9	Response sent with Request ID header	{'x-request-id': 'abc-123'}	Yes	Request ID included in response headers	N/A

💡 Middleware finishes by calling next(), passing request with Request ID set for tracing.

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
req.headers['x-request-id']	undefined or value	undefined or 'abc-123'	undefined or 'abc-123'	undefined or 'abc-123'	unchanged
req.id	undefined	undefined	new UUID or existing header value	same as assigned	same as assigned

Key Moments - 3 Insights

Why do we check for an existing 'x-request-id' header before generating a new one?

Because if the client or upstream service already provides a Request ID, we reuse it to maintain consistent tracing across services, as shown in execution_table rows 6-9.

What happens if we forget to call next() in the middleware?

The request will hang and never reach the next middleware or route handler, stopping the flow as next() triggers continuation (see execution_table steps 3 and 7).

How is the Request ID used after being assigned to req.id?

It is used for logging and included in response headers to help trace the request end-to-end, as shown in execution_table steps 4, 5, 8, and 9.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of req.id after step 2 when no 'x-request-id' header is present?

A undefined

B A newly generated UUID string

C The string 'abc-123'

D null

💡 Hint

Check execution_table row 2 under 'Request ID Assigned' column.

At which step does the middleware call next() to continue processing the request?

A Step 1

B Step 2

C Step 3

D Step 5

💡 Hint

Look at the 'Next Called' column in execution_table rows 3 and 7.

If the client sends a request with header 'x-request-id' set, what will req.id be set to?

A The value from the 'x-request-id' header

B A new UUID generated by the server

C undefined

D null

💡 Hint

Refer to execution_table rows 6 and 7 under 'Request ID Assigned'.

Concept Snapshot

Request ID for tracing in Express:
- Middleware checks for 'x-request-id' header.
- If missing, generates a new UUID.
- Attaches ID to req.id for consistent tracing.
- Calls next() to continue request flow.
- Use req.id in logs and response headers.

Full Transcript

This visual trace shows how Express middleware assigns a Request ID to each incoming HTTP request. When a request arrives, the middleware first checks if the client sent an 'x-request-id' header. If yes, it uses that value as the request's ID. If not, it generates a new unique ID using a UUID function. This ID is attached to the request object as req.id. The middleware then calls next() to pass control to the next handler. Downstream, the request ID can be used for logging and included in response headers to help trace the request through the system. This process ensures every request has a unique or consistent ID for debugging and monitoring.