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.

Practice

1. What is the main purpose of adding a request ID in an Express app?

easy

A. To encrypt the request data for security

B. To speed up the request processing time

C. To uniquely identify each request for easier tracking and debugging

D. To limit the number of requests from a user

Solution

1. Step 1: Understand the role of request ID

   A request ID is used to uniquely mark each incoming request so it can be tracked through logs and debugging.

2. Step 2: Identify the main benefit

   This helps developers trace requests easily, especially when many requests happen simultaneously.

3. Final Answer:

   To uniquely identify each request for easier tracking and debugging -> Option C

4. Quick Check:

   Request ID purpose = Unique tracking [OK]

Hint: Request ID helps track requests uniquely in logs [OK]

Common Mistakes:

• Thinking request ID speeds up processing
• Confusing request ID with encryption
• Assuming request ID limits requests

2. Which code snippet correctly adds a unique request ID to each request using the 'uuid' library in Express middleware?

easy

A. app.use((req, res, next) => { req.id = uuid.v4(); next(); });

B. app.use((req, res) => { req.id = uuid.v4(); });

C. app.use((req, res, next) => { res.id = uuid.v4(); next(); });

D. app.use((req, res, next) => { req.id = uuid(); next(); });

Solution

1. Step 1: Check middleware signature

   Express middleware must have three parameters: req, res, next to pass control.

2. Step 2: Verify correct uuid usage

   uuid.v4() generates a unique ID; assigning it to req.id is correct.

3. Final Answer:

   app.use((req, res, next) => { req.id = uuid.v4(); next(); }); -> Option A

4. Quick Check:

   Correct middleware and uuid call = app.use((req, res, next) => { req.id = uuid.v4(); next(); }); [OK]

Hint: Middleware needs (req, res, next) and uuid.v4() for ID [OK]

Common Mistakes:

• Omitting next() call in middleware
• Assigning ID to res instead of req
• Calling uuid() instead of uuid.v4()

3. Given this middleware code, what will be logged when a request is made?

const { v4: uuidv4 } = require('uuid');
app.use((req, res, next) => {
  req.id = uuidv4();
  console.log(`Request ID: ${req.id}`);
  next();
});
app.get('/', (req, res) => {
  res.send(`Your request ID is ${req.id}`);
});

medium

A. Logs 'undefined' and responds with 'Your request ID is undefined'

B. Logs a unique UUID string and responds with the same ID

C. Throws an error because req.id is not set

D. Logs a fixed string 'Request ID: 1234' every time

Solution

1. Step 1: Analyze middleware behavior

   The middleware assigns a new UUID to req.id and logs it before calling next().

2. Step 2: Check route handler response

   The route sends back the same req.id value, so the response matches the logged ID.

3. Final Answer:

   Logs a unique UUID string and responds with the same ID -> Option B

4. Quick Check:

   UUID assigned and logged = Logs a unique UUID string and responds with the same ID [OK]

Hint: Middleware sets req.id before route uses it [OK]

Common Mistakes:

• Assuming req.id is undefined in route
• Thinking the ID is fixed or static
• Expecting an error due to missing ID

4. Identify the error in this Express middleware that tries to add a request ID:

app.use((req, res, next) => {
  req.id = uuidv4;
  next();
});

medium

A. req.id should be assigned to res.id

B. Middleware is missing the next parameter

C. next() is called before assigning req.id

D. uuidv4 is assigned without calling it as a function

Solution

1. Step 1: Check uuidv4 usage

   uuidv4 is a function and must be called with parentheses to generate an ID.

2. Step 2: Confirm middleware parameters and flow

   Middleware has correct parameters and calls next() after assignment, so no issue there.

3. Final Answer:

   uuidv4 is assigned without calling it as a function -> Option D

4. Quick Check:

   Function call missing parentheses = uuidv4 is assigned without calling it as a function [OK]

Hint: Call uuidv4() with () to get ID, not just uuidv4 [OK]

Common Mistakes:

• Forgetting parentheses on function calls
• Mixing req and res objects
• Calling next() too early

5. You want to add a request ID to each request and include it in all logs and the response header. Which approach correctly achieves this in Express?

hard

A. Use middleware to assign req.id = uuidv4(), add res.set('X-Request-ID', req.id), then log req.id in all handlers

B. Assign req.id in each route handler separately without middleware

C. Generate a random number in middleware but do not pass it to response headers

D. Use middleware to assign req.id but never call next() to stop processing

Solution

1. Step 1: Assign request ID in middleware

   Middleware is the right place to assign req.id once per request using uuidv4().

2. Step 2: Add request ID to response headers and logs

   Setting res.set('X-Request-ID', req.id) sends the ID to clients; logging req.id in handlers tracks requests.

3. Final Answer:

   Use middleware to assign req.id = uuidv4(), add res.set('X-Request-ID', req.id), then log req.id in all handlers -> Option A

4. Quick Check:

   Middleware + header + logging = Use middleware to assign req.id = uuidv4(), add res.set('X-Request-ID', req.id), then log req.id in all handlers [OK]

Hint: Assign ID once in middleware, add header, log everywhere [OK]

Common Mistakes:

• Assigning ID in every route instead of middleware
• Not adding request ID to response headers
• Forgetting to call next() in middleware