API with NestJS #166. Logging with the Drizzle ORM

September 16, 2024

This entry is part 166 of 174 in the API with NestJS

Debugging is a great way to find issues when running an application locally. Unfortunately, we don’t have this option in a deployed application. Because of that, implementing logging functionality is necessary to track down and investigate any potential problems. In this article, we learn how to use the logger built into NestJS and integrate it with the Drizzle ORM.

Logger built into NestJS

NestJS conveniently offers built-in logging functionalities that we can use. Each message that we log needs to have a level. Here is a breakdown of all log levels, sorted by severity:

fatal
error
warn
log
debug
verbose

NestJS added the “fatal” log level some time last year.

To create logs, we should use the Logger class. One way to do that is to import it from @nestjs/common.

articles.service.ts

import { Injectable, NotFoundException, Logger } from '@nestjs/common';

import { DrizzleService } from '../database/drizzle.service';

import { databaseSchema } from '../database/database-schema';

import { eq } from 'drizzle-orm';

@Injectable()

export class ArticlesService {

constructor(private readonly drizzleService: DrizzleService) {}

async getById(id: number) {

const articles = await this.drizzleService.db

.select()

.from(databaseSchema.articles)

.where(eq(databaseSchema.articles.id, id));

const article = articles.pop();

if (!article) {

Logger.warn('Tried to get an article that does not exist');

throw new NotFoundException();

}

return article;

}

// ...

}

Although the above approach does the job, the official documentation recommends creating an instance of the logger inside each class that uses it.

articles.service.ts

import { Injectable, NotFoundException, Logger } from '@nestjs/common';

import { DrizzleService } from '../database/drizzle.service';

import { databaseSchema } from '../database/database-schema';

import { eq } from 'drizzle-orm';

@Injectable()

export class ArticlesService {

private readonly logger = new Logger(ArticlesService.name);

constructor(private readonly drizzleService: DrizzleService) {}

async getById(id: number) {

const articles = await this.drizzleService.db

.select()

.from(databaseSchema.articles)

.where(eq(databaseSchema.articles.id, id));

const article = articles.pop();

if (!article) {

this.logger.warn('Tried to get an article that does not exist');

throw new NotFoundException();

}

return article;

}

// ...

}

With this adjustment, NestJS can include the name of our service in the log, which makes it easier to read.

Working with log levels

The higher the level of our log is, the higher the severity. For instance, if a user attempts to access an article that does not exist, it likely shouldn’t cause an alarm in the middle of the night. Because of that, in our example above, we used warn instead of error. The higher the log, the more concerned we should be.

To avoid cluttering our logs, we can filter some of them out.

main.ts

import { NestFactory } from '@nestjs/core';

import { AppModule } from './app.module';

import { LogLevel, ValidationPipe } from '@nestjs/common';

async function bootstrap() {

const isProduction = process.env.NODE_ENV === 'production';

const logLevels: LogLevel[] = isProduction

? ['fatal', 'error', 'warn', 'log']

: ['fatal', 'error', 'warn', 'log', 'debug', 'verbose'];

const app = await NestFactory.create(AppModule, {

logger: logLevels,

});

app.useGlobalPipes(new ValidationPipe({ whitelist: true }));

await app.listen(3000);

}

bootstrap();

A surprising thing is that providing just ['verbose'] turns on all log levels. When we take a look at the isLogLevelEnabled function under the hood of NestJS, we can see that searches for the looks for the highest severity included in our array and turns on the logs with the lower severity as well. However, we provide the complete array for readability.

Logging SQL queries with the Drizzle ORM

Logging SQL queries allows us to investigate how Drizzle ORM interacts with our database and notice potential issues.

The most straightforward way to start logging our SQL queries is to pass an additional parameter to the drizzle function.

drizzle.service.ts

import { Inject, Injectable } from '@nestjs/common';

import { Pool } from 'pg';

import { CONNECTION_POOL } from './database.module-definition';

import { drizzle, NodePgDatabase } from 'drizzle-orm/node-postgres';

import { databaseSchema } from './database-schema';

@Injectable()

export class DrizzleService {

public db: NodePgDatabase<typeof databaseSchema>;

constructor(@Inject(CONNECTION_POOL) private readonly pool: Pool) {

this.db = drizzle(this.pool, { schema: databaseSchema, logger: true });

}

The downside to this solution is that the output of the default Drizzle ORM logger looks different from that of the NestJS logger. Let’s deal with that by creating a custom Drizzle ORM logger.

custom-drizzle-logger.ts

import { Logger as NestLogger } from '@nestjs/common';

import { Logger } from 'drizzle-orm/logger';

export class CustomDrizzleLogger implements Logger {

private readonly logger = new NestLogger('SQL');

logQuery(query: string, params: unknown[]): void {

this.logger.log(`${query} | Params: ${JSON.stringify(params)}`);

}

Every time Drizzle ORM wants to log a query, it calls the logQuery function. We can take advantage of that by using the NestJS logger.

We can now use our custom logger instead of the default one built into the Drizzle ORM.

drizzle-service.ts

import { Inject, Injectable } from '@nestjs/common';

import { Pool } from 'pg';

import { CONNECTION_POOL } from './database.module-definition';

import { drizzle, NodePgDatabase } from 'drizzle-orm/node-postgres';

import { databaseSchema } from './database-schema';

import { CustomDrizzleLogger } from './custom-drizzle-logger';

@Injectable()

export class DrizzleService {

public db: NodePgDatabase<typeof databaseSchema>;

constructor(@Inject(CONNECTION_POOL) private readonly pool: Pool) {

this.db = drizzle(this.pool, {

schema: databaseSchema,

logger: new CustomDrizzleLogger(),

});

}

Thanks to this solution, our logs are a lot more consistent.

Using a logging interceptor

Manually defining logs for every case in our application might produce the best results but can be time-consuming. To automate our logs somewhat, we can write a NestJS interceptor that handles logging automatically.

Interceptors in NestJS allow us run additional logic before or after NestJS handles a particular API request.

logger.interceptor.ts

import {

Injectable,

NestInterceptor,

ExecutionContext,

CallHandler,

Logger,

} from '@nestjs/common';

import { Request, Response } from 'express';

@Injectable()

export class LoggerInterceptor implements NestInterceptor {

private readonly logger = new Logger('HTTP');

intercept(context: ExecutionContext, next: CallHandler) {

const httpContext = context.switchToHttp();

const request = httpContext.getRequest<Request>();

const response = httpContext.getResponse<Response>();

response.on('finish', () => {

const { method, originalUrl } = request;

const { statusCode, statusMessage } = response;

const message = `${method} ${originalUrl} ${statusCode} ${statusMessage}`;

if (statusCode >= 500) {

return this.logger.error(message);

}

if (statusCode >= 400) {

return this.logger.warn(message);

}

return this.logger.log(message);

});

return next.handle();

}

You can add more data into the logs such as the POST request body.

Above, we wait for the HTTP request to complete and then determine the log level based on the status code of our response.

There is more than one way to use our interceptor. For example, we can decorate a single method with it.

articles.controller.ts

import {

Controller,

Get,

Param,

ParseIntPipe,

UseInterceptors,

} from '@nestjs/common';

import { ArticlesService } from './articles.service';

import { LoggerInterceptor } from '../utilities/logger.interceptor';

@Controller('articles')

export class ArticlesController {

constructor(private readonly articlesService: ArticlesService) {}

@Get(':id')

@UseInterceptors(LoggerInterceptor)

getById(@Param('id', ParseIntPipe) id: number) {

return this.articlesService.getById(id);

}

// ...

}

Another approach is to decorate the entire controller.

articles.controller.ts

import { Controller, UseInterceptors } from '@nestjs/common';

import { LoggerInterceptor } from '../utilities/logger.interceptor';

@Controller('articles')

@UseInterceptors(LoggerInterceptor)

export class ArticlesController {

// ...

}

We can also use the useGlobalInterceptors function to apply our interceptor to all our controllers.

main.ts

import { NestFactory } from '@nestjs/core';

import { AppModule } from './app.module';

import { LogLevel, ValidationPipe } from '@nestjs/common';

import { LoggerInterceptor } from './utilities/logger.interceptor';

async function bootstrap() {

const isProduction = process.env.NODE_ENV === 'production';

const logLevels: LogLevel[] = isProduction

? ['fatal', 'error', 'warn', 'log']

: ['fatal', 'error', 'warn', 'log', 'debug', 'verbose'];

const app = await NestFactory.create(AppModule, {

logger: logLevels,

});

app.useGlobalInterceptors(new LoggerInterceptor());

app.useGlobalPipes(new ValidationPipe({ whitelist: true }));

await app.listen(3000);

}

bootstrap();

Summary

In this article, we explored how to use the built-in NestJS logger in a few different ways. Thanks to our approach, we can automatically log all SQL queries that Drizzle ORM makes and the HTTP responses our NestJS application sends. Besides that, we can also implement custom logging if necessary. To implement that, we had to create a custom interceptor that logs various messages automatically when our NestJS application sends a response. We also made a custom Drizzle ORM logger and combined it with the logger built into NestJS.

By adopting a thorough approach to logging, troubleshooting issues becomes significantly easier. It makes it a valuable thing to learn and implement in your NestJS application.

Series Navigation<< API with NestJS #165. Time intervals with the Drizzle ORM and PostgreSQLAPI with NestJS #167. Unit tests with the Drizzle ORM >>