Nest.js

This guide explains how to setup Sentry in your Nest.js application.

Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.

Install

Sentry captures data by using an SDK within your application’s runtime. This means that you have to add @sentry/node as a runtime dependency to your application:

npm install --save @sentry/node

Configure

Sentry should be initialized as early as possible in the bootstrap() function in main.ts. After initialization, add the Sentry.setupNestErrorHandler.

Once this is done, Sentry's Node SDK captures unhandled exceptions as well as tracing data for your application.

import * as Sentry from '@sentry/node';
import {BaseExceptionFilter, HttpAdapterHost, NestFactory} from '@nestjs/core';
import {AppModule} from './app.module';

async function bootstrap() {
  Sentry.init({
    dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0',

    // Add Performance Monitoring by setting tracesSampleRate
    // We recommend adjusting this value in production
    tracesSampleRate: 1.0,
  });

  const app = await NestFactory.create(AppModule);
  const {httpAdapter} = app.get(HttpAdapterHost);

  Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter));

  await app.listen(3000);
}

bootstrap();

Performance

If you set a tracesSampleRate, performance instrumentation will automatically be enabled for you. See Automatic Instrumentation to learn about all the things that the SDK automatically instruments for you.

You can also manually capture performance data - see Custom Instrumentation for details.

Add Readable Stack Traces to Errors

Depending on how you've set up your project, the stack traces in your Sentry errors probably don't look like your actual code.

To fix this, upload your source maps to Sentry. The easiest way to do this is to use the Sentry Wizard:

npx @sentry/wizard@latest -i sourcemaps

The wizard will guide you through the following steps:

• Logging into Sentry and selecting a project
• Installing the necessary Sentry packages
• Configuring your build tool to generate and upload source maps
• Configuring your CI to upload source maps

For more information on source maps or for more options to upload them, head over to our Source Maps documentation.

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.

Sentry.startSpan(
  {
    op: 'test',
    name: 'My First Test Transaction',
  },
  () => {
    setTimeout(() => {
      try {
        foo();
      } catch (e) {
        Sentry.captureException(e);
      }
    }, 99);
  }
);

To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.