Learn about using Sentry with Nest.js.

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

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

Sentry captures data by using an SDK within your application’s runtime.

npm install @sentry/nestjs @sentry/profiling-node --save

Sentry should be initialized as early in your app as possible. It is essential that you call Sentry.init before you require any other modules in your application—otherwise, auto-instrumentation of these modules will not work.

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

You need to create a file named instrument.js that imports and initializes Sentry:

const Sentry = require("@sentry/nestjs");
const { nodeProfilingIntegration } = require("@sentry/profiling-node");

// Ensure to call this before requiring any other modules!
  dsn: "",
  integrations: [
    // Add our Profiling integration

  // Add Tracing by setting tracesSampleRate
  // We recommend adjusting this value in production
  tracesSampleRate: 1.0,

  // Set sampling rate for profiling
  // This is relative to tracesSampleRate
  profilesSampleRate: 1.0,

Once you set a tracesSampleRate, performance instrumentation is automatically 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.

You need to require or import the instrument.js file before requiring any other modules in your application. This is necessary to ensure that Sentry can automatically instrument all modules in your application:

// Import this first!
import "./instrument";

// Now import other modules
import * as Sentry from "@sentry/nestjs";
import {
} from "@nestjs/core";
import { AppModule } from "./app.module";

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

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

  await app.listen(3000);


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.

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

  op: "test",
  name: "My First Test Span",
}, () => {
  setTimeout(() => {
    try {
    } catch (e) {
  }, 99);

Learn more about manually capturing an error or message in our Usage documentation.

To view and resolve the recorded error, log into 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.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").