Add Official Sentry NestJS SDK/Integration

[AbhiPrasad]

Update:

---

Improved NestJS support was delivered as part of JS SDK v8.x. But we decided to not stop there, our official @sentry/nestjs SDK is already under development. Follow along here and let us hear your feedback!

@ntegral has done some great work on a community supported SDK for the NestJS framework: https://github.com/ntegral/nestjs-sentry

We can probably build on top of that and release an officially supported NestJS SDK/Integration. Not sure if it should be it's own SDK, or a standalone integration atm - we'll see when we investigate further.

We'll need to make sure we have:

• Error monitoring and crash reporting OOB
• Performance monitoring support
• Automatic cron monitoring support
• Trace propogation of sentry-trace/baggage
• Release health support + Automatic sourcemaps uploading

All powered by our Node JS SDK - @sentry/node.

Please comment/react to this post if you would like to see this - that helps us prioritize this work.

[thenbe]

An official sdk would be great, especially since https://github.com/ntegral/nestjs-sentry seems to have been abandoned.

[ghost]

Yeah, an official SDK it's really necessary, maybe work with the nestjs team and do something like they have done with @nestjs/typeorm & @nestjs/mongoose...

My use case:
Nestjs + Prisma(Mysql) + Mongoose + Redis
I check health with @nestjs/terminus
I have a module called authz (where I verify the JWT), will be nice to have some service or something like, that can be called inside this service and give me the option to insert information about that request, like, userID, email, token, etc)

Any eta for that?

[AbhiPrasad]

Hey, thanks for your interest! No timeline on this, but the team is aware! In the mean time, any PRs are welcome if someone want's to take a look at this.

[Martinprobu]

What about trying to transfer ntegral/nestjs-sentry to nestjs org first and to let the community drive the change first? Then if sentry team has the bandwidth later, sentry team could also chime in.

[AbhiPrasad]

That sounds like a great idea! I would talk to the NestJS team about it, since we don’t have control over their org, but happy to help in any way we can.

[JVMartin]

This would be really great. Just want to chime in that currently, none of the Sentry tracing (APM) integrations work when running from a NestJS app.

Example:

Sentry.init({
  dsn: '<redacted>',

  tracesSampleRate: 1.0,
  integrations: [
    new Tracing.Integrations.Express({ app: app.getHttpAdapter().getInstance() }),
    new Tracing.Integrations.Apollo(),
    new Tracing.Integrations.Prisma({ client: app.get(PrismaService) }),
  ],
});

^ Running in a NestJS application where app is the Nest application resolving Express + Prisma, we get 0 traces.. no traces from Express, no traces from Apollo, and no traces from Prisma.

[AbhiPrasad]

@szymon-eukid-io we'll have nestjs support as part of v8 of our SDK. We only have an alpha release out, so things dont work perfectly yet.

sentry-javascript/packages/node-experimental/src/integrations/tracing/nest.ts

Line 11 in 492f115

instrumentations: [new NestInstrumentation({})],

Alpha: https://www.npmjs.com/package/@sentry/node/v/8.0.0-alpha.4

Migration docs: https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md

Once v8 is out you should just be able to use @sentry/node and have everything work out of the box :)

[vini-se]

@AbhiPrasad Sorry for the bother, but do you have any expected release date for v8?

[AbhiPrasad]

@vini-se beta comes out this week! Can't say a hard date for official release because it depends on what comes out of the beta, but hopefully 1-2 weeks after that?

[BlakeGardner]

@AbhiPrasad This is great news, looking forward to testing NestJS integration

[AbhiPrasad]

We had some more breaking changes so we couldn't release a beta, but another alpha came out: https://github.com/getsentry/sentry-javascript/releases/tag/8.0.0-alpha.9

Here is an example of how to use the Sentry Node SDK with a nest.js app https://github.com/getsentry/sentry-javascript/tree/8.0.0-alpha.9/dev-packages/e2e-tests/test-applications/node-nestjs-app/src

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

// initialize Sentry before importing `nestjs` code so we can instrument `nestjs` properly.
Sentry.init({
  dsn: process.env.SENTRY_DSN,
  // nestjs performance monitoring + distributed tracing works automatically
  tracesSampleRate: 1,
  tracePropagationTargets: ['http://localhost:3030', '/external-allowed'],
});

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

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  // selectively enable error handling for each app module you use.
  Sentry.setupNestErrorHandler(app);

  await app.listen(3000);
}

bootstrap();

[HarrySky]

Tried 8.0.0-beta.4 and wanted to add here that currently if setupNestErrorHandler is used - it catches all 4XX exceptions (UnauthorizedException, ForbiddenException, etc.), which are emitted by auth guards and are handled by Nest properly, which makes current version of this integration unusable

[dawidvdh]

Yeah I am not getting this working properly with 8.0.0-beta.5, I have the following init code:

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const configService = app.get(ConfigService);

  const port = configService.get<number>('app.port');
  const node_env = configService.get<string>('app.environment');
  const dsn = configService.get<string>('sentry.dsn');

  Sentry.init({
    environment: node_env,
    dsn,
    debug: true,
  });

  console.log(node_env, dsn); // this logs out correctly

  app.enableCors();
  app.getHttpAdapter().getInstance().disable('x-powered-by');

  Sentry.setupNestErrorHandler(app);

  console.log(`application starting on port ${port}`);
  await app.listen(port);
}

And it looks like Sentry starts up correctly however whenever there is an error the request just hangs and I get the following debug message:

Sentry Logger [warn]: Isolation scope is still the default isolation scope, skipping setting transactionName.

Which likely has nothing to do with the fact that the api hangs and does not respond with an error. As soon as I remove Sentry.setupNestErrorHandler(app); everything works perfectly again and the api will respond with the handled error.

[sgarner]

I observe the same result.

@AbhiPrasad I think the SentryNestExceptionFilter is not implemented correctly?

sentry-javascript/packages/node/src/integrations/tracing/nest.ts

Lines 43 to 47 in 7e6c23e

	const SentryNestExceptionFilter = {
	catch(exception: unknown) {
	captureException(exception);
	},
	};

An exception filter needs to produce a response. So Sentry's filter should be extended from Nest.js's BaseExceptionFilter class, and call super.catch() after capturing the exception. Otherwise there is no code to send a response, leading to the request hanging.

[mydea]

Hello,

thanks for much for raising this, you are right, sorry, our implementation was too naive!

I've updated this so that you now have to pass an exception filter instance in - which is a bit more involved but more correct! See:
#11874

this will go out in the next release (beta.6).

[sgarner]

That's a good solution, thanks @mydea 👍

[BlakeGardner]

Is GraphQL supported? I am testing version 8.0.0-beta.5 and I get an error about route issues when I throw an error from a resolver.

{
    "errors": [
        {
            "message": "Cannot read properties of undefined (reading 'route')",
            "locations": [
                {
                    "line": 2,
                    "column": 5
                }
            ],
            "path": [
                "me"
            ],
            "extensions": {
                "code": "INTERNAL_SERVER_ERROR",
                "stacktrace": [
                    "TypeError: Cannot read properties of undefined (reading 'route')",
                    "    at Object.intercept (/workspaces/project/node_modules/@sentry/src/integrations/tracing/nest.ts:61:15)",
                    "    at nextFn (/workspaces/project/node_modules/@nestjs/core/interceptors/interceptors-consumer.js:23:36)",
                    "    at /workspaces/project/node_modules/@nestjs/core/interceptors/interceptors-consumer.js:25:40",
                    "    at Observable._subscribe (/workspaces/project/node_modules/rxjs/src/internal/observable/defer.ts:55:15)",
                    "    at Observable._trySubscribe (/workspaces/project/node_modules/rxjs/src/internal/Observable.ts:244:19)",
                    "    at /workspaces/project/node_modules/rxjs/src/internal/Observable.ts:234:18",
                    "    at Object.errorContext (/workspaces/project/node_modules/rxjs/src/internal/util/errorContext.ts:29:5)",
                    "    at Observable.subscribe (/workspaces/project/node_modules/rxjs/src/internal/Observable.ts:220:5)",
                    "    at Object.mergeInternals (/workspaces/project/node_modules/rxjs/src/internal/operators/mergeInternals.ts:136:10)",
                    "    at /workspaces/project/node_modules/rxjs/src/internal/operators/mergeMap.ts:95:42"
                ]
            }
        }
    ],
    "data": {
        "me": null
    }
}

main.ts

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

async function bootstrap() {
  Sentry.init({
    environment: process.env.NODE_ENV,
    dsn: process.env.SENTRY_DSN,
    debug: true,
  });
  const app = await NestFactory.create(AppModule, {});
  Sentry.setupNestErrorHandler(app);
  await app.listen(3000);
}
bootstrap();

user.resolver.ts

  @Query(() => UserEntity, { nullable: true })
  @UseGuards(AuthGuard)
  me(@CurrentUser() user: User): User {
    throw new Error('My error');
    return user;
  }

[sgarner]

I've reported a bug: #11877

[BlakeGardner]

Incredible, thanks @sgarner

[mydea]

FWIW this should be working in 8.0.0-beta.6 - LMK if you encounter any further problems with the nest instrumentation! 🙏

[jtomaszewski]

Will it support tracing? And will it give tracing & error handling to packages such as https://docs.bullmq.io/guide/nestjs as well?

[BlakeGardner]

I'm testing 8.0.0-rc.2 and I am not quite sure what to pass into the second parameter of Sentry.setupNestErrorHandler(). I get An argument for 'baseFilter' was not provided..

[onurtemizkan]

Hi @BlakeGardner, you can pass an instance of BaseExceptionFilter as described in #11874

[jsprw]

Also, it doesn't seem to work when using Fastify with NestJS. https://docs.nestjs.com/techniques/performance

const app = await NestFactory.create<NestFastifyApplication>(module, new FastifyAdapter({ logger: true }));
Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(app.getHttpAdapter()));

Argument of type 'NestFastifyApplication<RawServerDefault>' is not assignable to parameter of type 'MinimalNestJsApp'.
  Types of property 'useGlobalInterceptors' are incompatible.
    Type '(...interceptors: NestInterceptor<any, any>[]) => NestFastifyApplication<RawServerDefault>' is not assignable to type '(interceptor: { intercept: (context: MinimalNestJsExecutionContext, next: { handle: () => void; }) => void; }) => void'.
      Types of parameters 'interceptors' and 'interceptor' are incompatible.
        Type '{ intercept: (context: MinimalNestJsExecutionContext, next: { handle: () => void; }) => void; }' is not assignable to type 'NestInterceptor<any, any>'.
          The types returned by 'intercept(...)' are incompatible between these types.
            Type 'void' is not assignable to type 'Observable<any> | Promise<Observable<any>>'.

[Blargel]

I'm getting this issue as well but I'm not using Fastify so I don't think it's related. Perhaps something within Nest changed since the last time this was brought up?

const app = await NestFactory.create(AppModule)
Sentry.setupNestErrorHandler(
  app,
  new BaseExceptionFilter(app.getHttpAdapter()),
)

Same type error as above:

Argument of type 'INestApplication<any>' is not assignable to parameter of type 'MinimalNestJsApp'.
  Types of property 'useGlobalInterceptors' are incompatible.
    Type '(...interceptors: NestInterceptor<any, any>[]) => INestApplication<any>' is not assignable to type '(interceptor: { intercept: (context: MinimalNestJsExecutionContext, next: { handle: () => void; }) => void; }) => void'.
      Types of parameters 'interceptors' and 'interceptor' are incompatible.
        Type '{ intercept: (context: MinimalNestJsExecutionContext, next: { handle: () => void; }) => void; }' is not assignable to type 'NestInterceptor<any, any>'.
          The types returned by 'intercept(...)' are incompatible between these types.
            Type 'void' is not assignable to type 'Observable<any> | Promise<Observable<any>>'.

When I try to run it anyway just to see, this type error occurs when I purposely trigger a different error that I expect Sentry to report:

TypeError: response.status is not a function
    at ExpressAdapter.reply (~/platform-api/node_modules/@nestjs/platform-express/adapters/express-adapter.js:28:22)
    at BaseExceptionFilter.handleUnknownError (~/platform-api/node_modules/@nestjs/core/exceptions/base-exception-filter.js:46:28)
    at BaseExceptionFilter.catch (~/platform-api/node_modules/@nestjs/core/exceptions/base-exception-filter.js:17:25)
    at Proxy.<anonymous> (~/platform-api/node_modules/@sentry/src/integrations/tracing/nest.ts:80:51)
    at ExternalExceptionsHandler.invokeCustomFilters (~/platform-api/node_modules/@nestjs/core/exceptions/external-exceptions-handler.js:31:32)
    at ExternalExceptionsHandler.next (~/platform-api/node_modules/@nestjs/core/exceptions/external-exceptions-handler.js:14:29)
    at ~/platform-api/node_modules/@nestjs/core/helpers/external-proxy.js:14:42
    at processTicksAndRejections (node:internal/process/task_queues:95:5)

[mydea]

Hey, sorry about that, we also noticed this. We have broadened the type further in https://github.com/getsentry/sentry-javascript/releases/tag/8.2.1. Could you give that a try?

[mydea]

Also if you are still getting errors there, I'd ask you to please open an issue - Nest.js is "officially" supported now, so anything that doesn't work there for you we def. want to fix, and opening an issue ensures this can't fall between the cracks too easily ;)

[jarPotato]

I recently switched from ntegral/nestjs-sentry to official sentry node sdk with NestJs support. I have done that minimal configuration of instrument file and setupNestErrorHandler, the error reporting seems to work fine but the Performance tab is completely empty now.

Is there anything else to be done to enable performance monitoring apart from changes in those two files?

[mydea]

Could you share what you see when you boot your app and have debug: true set in your Sentry init? Or even better, could you create an issue with this information and as much info about your setup as possible, that will make it easier for us to track down what's happening there - thank you!

[jtomaszewski]

Same problem here. Nothing is reported to Performance tab.

pkg versions: @nestjs/core 10.3.1 , @sentr/node 8.5.0

[mydea]

@jtomaszewski could you share your init/setup codec - or better yet, could you open an issue for this with the details of your setup? This makes it easier for us to track this and dive in what may be going wrong.

From a first glance, it seems weird to me that there are no logs for any integrations being setup 🤔 Between "Initializing Sentry" and "Running in CommonJS mode" you should normally see logs for the integrations that have been setup, which seem to be missing here 🤔

[jtomaszewski]

The nest integration should be initialized by default, right?

That's how I initialize Sentry now:

  Sentry.init({
    enabled: true,
    environment,
    dsn: process.env.SENTRY_DSN,
    release: getSourceVersion(),
    tracesSampleRate: parseFloat(process.env.SENTRY_TRACE_SAMPLE_RATE || '1'),
    _experiments: {
      metricsAggregator: true,
    },
  });

FYI, I run it before creating the nestjs app (const app = await NestFactory.create(module)).

[mydea]

Did you follow the docs as outlined here: https://docs.sentry.io/platforms/javascript/guides/nestjs/

Which means: 1. Putting init into a separate file, 2. importing this at the very top of your app before you import anything else?

[AbhiPrasad]

There is now official Sentry Nest.js support as part of 8.x of the JavaScript SDK. You can use @sentry/node or @sentry/bun!

https://docs.sentry.io/platforms/javascript/guides/nestjs/

Closing this conversation as a result. If you experience any bugs or have feature requests, please open a new GitHub issue. Thank you to everyone who helped test this during our alpha/beta and gave us advice on how the integration should work.