fullstack.org.ua

Logging Interceptor · fullstack.org.ua

Середній12 хв· Fullstack Team

Logging Interceptor

Реалізуєте interceptor для журналювання методу, маршруту, тривалості та результату HTTP-запиту.

Що таке logging interceptor

Interceptor у NestJS може виконувати код:

до виклику методу контролера;
після успішного завершення методу;
під час обробки помилки.

Для журналювання HTTP-запиту interceptor зручно використовувати, щоб централізовано отримувати:

HTTP-метод;
маршрут або URL;
тривалість виконання;
статус відповіді;
результат: успішне завершення або помилка.

На відміну від додавання Logger.log() у кожен метод контролера, interceptor працює для багатьох маршрутів одразу.

Структура interceptor

Interceptor реалізує інтерфейс NestInterceptor. Його основний метод — intercept():

typescript

intercept(
  context: ExecutionContext,
  next: CallHandler,
): Observable<unknown> {
  return next.handle();
}

typescript

import {
  CallHandler,
  ExecutionContext,
  Injectable,
  Logger,
  NestInterceptor,
} from '@nestjs/common';
import { Observable, tap } from 'rxjs';

type HttpRequest = {
  method: string;
  originalUrl?: string;
  url?: string;
  route?: {
    path?: string;
  };
};

type HttpResponse = {
  statusCode: number;
};

@Injectable()
export class LoggingInterceptor implements NestInterceptor {
  private readonly logger = new Logger(LoggingInterceptor.name);

  intercept(
    context: ExecutionContext,
    next: CallHandler,
  ): Observable<unknown> {
    const httpContext = context.switchToHttp();

    const request = httpContext.getRequest<HttpRequest>();
    const response = httpContext.getResponse<HttpResponse>();

    const method = request.method;
    const route = request.route?.path ?? request.originalUrl ?? request.url ?? '';
    const startedAt = Date.now();

    return next.handle().pipe(
      tap({
        next: () => {
          const duration = Date.now() - startedAt;

          this.logger.log(
            `${method} ${route} ${response.statusCode} - успішно - ${duration} мс`,
          );
        },
        error: (error: unknown) => {
          const duration = Date.now() - startedAt;
          const errorMessage =
            error instanceof Error ? error.message : String(error);

          this.logger.error(
            `${method} ${route} ${response.statusCode} - помилка - ${duration} мс - ${errorMessage}`,
          );
        },
      }),
    );
  }
}

typescript

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { LoggingInterceptor } from './logging.interceptor';

async function bootstrap(): Promise<void> {
  const app = await NestFactory.create(AppModule);

  // Підключаємо журналювання для всіх HTTP-запитів
  app.useGlobalInterceptors(new LoggingInterceptor());

  await app.listen(3000);
}

void bootstrap();

typescript

import {
  Controller,
  Get,
  UseInterceptors,
} from '@nestjs/common';
import { LoggingInterceptor } from './logging.interceptor';

@Controller('orders')
@UseInterceptors(LoggingInterceptor)
export class OrdersController {
  @Get()
  findAll(): { items: string[] } {
    return {
      items: ['order-1', 'order-2'],
    };
  }
}

typescript

import {
  Controller,
  Get,
  UseInterceptors,
} from '@nestjs/common';
import { LoggingInterceptor } from './logging.interceptor';

@Controller('reports')
export class ReportsController {
  @Get()
  @UseInterceptors(LoggingInterceptor)
  getReport(): { generated: boolean } {
    return {
      generated: true,
    };
  }
}

typescript

import { Module } from '@nestjs/common';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { LoggingInterceptor } from './logging.interceptor';

@Module({
  providers: [
    {
      provide: APP_INTERCEPTOR,
      useClass: LoggingInterceptor,
    },
  ],
})
export class AppModule {}

typescript

return next.handle().pipe(
  tap((result: unknown) => {
    this.logger.log(
      `${request.method} ${route} завершено зі значенням типу ${typeof result}`,
    );
  }),
);

typescript

intercept(
  context: ExecutionContext,
  next: CallHandler,
): Observable<unknown> {
  // Помилка: виконання запиту не передається далі
  return new Observable();
}