Enhancing Error Logging in NestJS with a Custom Sentry Logger

npm install @sentry/node

import { ConsoleLogger } from "@nestjs/common";

import * as Sentry from "@sentry/node";



export class SentryLogger extends ConsoleLogger {

  error(message: any, ...optionalParams: any[]): void {

    const errorMessage = message.toString();

    let stack: string | object = "";

    let logContext = "";



    if (optionalParams.length === 1) {

      logContext = optionalParams[0];

    } else if (optionalParams.length === 2) {

      [stack, logContext] = optionalParams;

    }



    const formattedMessage = logContext

      ? `${logContext}: ${errorMessage}`

      : errorMessage;



    Sentry.withScope((scope) => {

      scope.setExtra("message", errorMessage);

      scope.setExtra("context", logContext);

      scope.setExtra("stack", stack);

      Sentry.captureMessage(formattedMessage, "error");

    });



    super.error(errorMessage, ...optionalParams);

  }



  verbose(message: any, ...optionalParams: any[]): void {

    const verboseMessage = message ? message.toString() : "";

    const logContext = optionalParams.shift() || "";

    const extra = optionalParams;



    const formattedMessage = logContext

      ? `${logContext}: ${verboseMessage}`

      : verboseMessage;



    Sentry.withScope((scope) => {

      scope.setExtra("message", verboseMessage);

      scope.setExtra("context", logContext);

      scope.setExtra("extra", extra);

      Sentry.captureMessage(formattedMessage, "info");

    });



    super.verbose(verboseMessage, ...extra);

  }

}

import { Logger } from "@nestjs/common";

import { ConfigService } from "@nestjs/config";

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

import { NestExpressApplication } from "@nestjs/platform-express";

import * as Sentry from "@sentry/node";

import { nodeProfilingIntegration } from "@sentry/profiling-node";

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

import { SentryLogger } from "./utility/logger/sentry.logger";



const logger = new Logger("MyApp");



async function bootstrap() {

  const app = await NestFactory.create<NestExpressApplication>(AppModule);

  const cfg = app.get(ConfigService);



  Sentry.init({

    dsn: cfg.get<string>("SENTRY_DNS", ""),

    environment: cfg.get<string>("NODE_ENV", "development"),

    tracesSampleRate: 1.0,

    profilesSampleRate: 1.0,

    normalizeDepth: 5,

    integrations: [nodeProfilingIntegration()],

  });



  app.useLogger(new SentryLogger());



  await app.listen(3000);

}



bootstrap()

  .then(() => logger.log("Server is running"))

  .catch((err) => logger.error("Bootstrap failed", err));