Why Logging interceptor in NestJS? - Purpose & Use Cases

The Big Idea

Discover how one simple interceptor can save hours of debugging pain!

The Scenario

Imagine you have a NestJS app where you want to see what requests come in and what responses go out. You add console.log statements in every controller method manually.

The Problem

This manual logging is slow and boring. You might forget to add logs in some places. Logs become messy and inconsistent. Debugging becomes harder because logs are scattered everywhere.

The Solution

A logging interceptor automatically catches every request and response. It logs important info in one place, cleanly and consistently, without changing each controller method.

Before vs After

✗ Before

console.log('Request to get user');
const result = this.userService.findUser(id);
console.log('Response sent');
return result;

✓ After

intercept(context, next) {
  console.log('Incoming request');
  return next.handle().pipe(tap(() => console.log('Response sent')));
}

What It Enables

You get clear, consistent logs for every request and response automatically, making debugging and monitoring easy.

Real Life Example

In a real app, a logging interceptor helps track API usage and errors without cluttering your business logic with logging code.

Key Takeaways

Manual logging is error-prone and scattered.

Logging interceptor centralizes and automates logging.

It improves debugging and monitoring effortlessly.

Practice

1. What is the main purpose of a LoggingInterceptor in a NestJS application?

easy

A. To manage user authentication and authorization

B. To handle database connections automatically

C. To log details about incoming requests and outgoing responses

D. To serve static files like images and CSS

Solution

1. Step 1: Understand the role of interceptors

   Interceptors in NestJS run code before and after request handlers, often used for logging or modifying requests/responses.

2. Step 2: Identify the purpose of LoggingInterceptor

   A LoggingInterceptor specifically tracks and logs request and response details for debugging and monitoring.

3. Final Answer:

   To log details about incoming requests and outgoing responses -> Option C

4. Quick Check:

   LoggingInterceptor = logs requests/responses [OK]

Hint: LoggingInterceptor logs request and response info [OK]

Common Mistakes:

• Confusing interceptors with middleware
• Thinking interceptors handle authentication
• Assuming interceptors serve static files

2. Which of the following is the correct way to implement the intercept method in a NestJS LoggingInterceptor?

easy

A. intercept(context, next) { return next.handle(); }

B. intercept(context, next) { next.handle(); }

C. intercept(context) { return next.handle(); }

D. intercept(next) { return context.handle(); }

Solution

1. Step 1: Recall the intercept method signature

   The intercept method receives two parameters: context and next. It must return next.handle() to continue the request lifecycle.

2. Step 2: Check each option for correct syntax

   intercept(context, next) { return next.handle(); } correctly uses both parameters and returns next.handle(). Options A, C, and D either miss parameters or do not return the observable.

3. Final Answer:

   intercept(context, next) { return next.handle(); } -> Option A

4. Quick Check:

   intercept(context, next) returns next.handle() [OK]

Hint: intercept always returns next.handle() with both parameters [OK]

Common Mistakes:

• Omitting return statement
• Missing one of the parameters
• Calling handle on wrong object

3. Given this LoggingInterceptor code snippet, what will be logged when a request is handled?

intercept(context, next) {
  const now = Date.now();
  return next.handle().pipe(
    tap(() => console.log(`Request took ${Date.now() - now}ms`))
  );
}

medium

A. Logs the time taken to process the request in milliseconds

B. Logs the request URL only

C. Logs the response body content

D. Logs an error message if the request fails

Solution

1. Step 1: Analyze the timing logic

   The code records the current time before the request is handled, then logs the difference after the response is sent.

2. Step 2: Understand the logged message

   The console.log outputs "Request took Xms" where X is the elapsed time in milliseconds.

3. Final Answer:

   Logs the time taken to process the request in milliseconds -> Option A

4. Quick Check:

   LoggingInterceptor measures request duration [OK]

Hint: Look for Date.now() difference to find elapsed time [OK]

Common Mistakes:

• Assuming it logs request URL or body
• Thinking it logs errors only
• Ignoring the timing calculation

4. Identify the error in this LoggingInterceptor code:

intercept(context, next) {
  const now = Date.now();
  next.handle().pipe(
    tap(() => console.log(`Request took ${Date.now() - now}ms`))
  );
}

medium

A. tap operator is not imported

B. Incorrect use of Date.now()

C. Missing context parameter

D. Missing return statement before next.handle()

Solution

1. Step 1: Check the intercept method return

   The intercept method must return the observable from next.handle() to continue the request lifecycle.

2. Step 2: Identify missing return

   The code calls next.handle().pipe(...) but does not return it, so the request will not proceed properly.

3. Final Answer:

   Missing return statement before next.handle() -> Option D

4. Quick Check:

   intercept must return next.handle() observable [OK]

Hint: Always return next.handle() in intercept method [OK]

Common Mistakes:

• Forgetting to return the observable
• Misusing Date.now() for timing
• Ignoring required parameters

5. You want to create a LoggingInterceptor that logs the request method, URL, and the time taken for each request. Which code snippet correctly implements this behavior?

hard

A. intercept(context, next) {
const req = context.getRequest();
const now = Date.now();
next.handle().pipe(
tap(() => console.log(`${req.method} ${req.url} - ${Date.now() - now}ms`))
);
}

B. intercept(context, next) {
const req = context.switchToHttp().getRequest();
const now = Date.now();
return next.handle().pipe(
tap(() => console.log(`${req.method} ${req.url} - ${Date.now() - now}ms`))
);
}

C. intercept(context, next) {
const req = context.switchToHttp().getRequest();
const now = Date.now();
return next.handle().pipe(
map(() => console.log(`${req.method} ${req.url} - ${Date.now() - now}ms`))
);
}

D. intercept(context, next) {
const req = context.switchToHttp().getRequest();
const now = Date.now();
return next.handle().pipe(
tap(() => console.error(`${req.method} ${req.url} - ${Date.now() - now}ms`))
);
}

Solution

1. Step 1: Access request object correctly

   Use context.switchToHttp().getRequest() to get the HTTP request object in NestJS interceptors.

2. Step 2: Use tap operator for side effects

   The tap operator is used to perform logging without altering the response stream. Using map or console.error is incorrect here.

3. Final Answer:

   intercept(context, next) { const req = context.switchToHttp().getRequest(); const now = Date.now(); return next.handle().pipe( tap(() => console.log(`${req.method} ${req.url} - ${Date.now() - now}ms`)) ); } -> Option B

4. Quick Check:

   Use switchToHttp(), tap, and return next.handle() [OK]

Hint: Use switchToHttp().getRequest() and tap for logging [OK]

Common Mistakes:

• Not returning next.handle()
• Using map instead of tap
• Using console.error instead of console.log
• Incorrect request object access