NestJS SDK

[mydea]

We have shipped @sentry/nestjs as Beta. However, there are some follow up tasks we want to do:

Optional

Beta Give feedback

1. Add automatic cron monitoring support to @sentry/nestjs #12770
   Package: nestjs +1
   
2. [Flaky CI]: E2E nestjs Cron job triggers send of in_progress envelope #13216
   Type: Tests +1
   
3. Instrument NestJS event listeners #13167
   Package: nestjs +1
4. Facilitate graphql monitoring with playground on Nest.js #13133
   Package: nestjs +1
5. Upstream automatic instrumentation to open telemetry repo
6. Instrument NestJS CQRS Command Handler #13169
   Package: nestjs +1
7. Add Queue module support to @sentry/nestjs #12823
   Package: nestjs +1
8. Instrumentation of NestJS functional middleware #13287
   Package: nestjs +1
9. E2E tests for nestjs with GraphQL #13516
   Package: nestjs Type: Tests +2
   
10. Add automatic instrumentation to @sentry/nestjs where @Injectable is not used #13517
    Package: nestjs Type: Improvement +2
11. Rename submodule export from setup #13589
    Package: nestjs Type: Improvement +2
12. Remove SentryService from SentryModule #13590
    Package: nestjs +1

ARCHIVE - All of this is already done

We do have support for Nest.js through @sentry/node today: https://docs.sentry.io/platforms/javascript/guides/nestjs/

However, there are some limitations to this, which we could overcome and improve upon if we had a dedicated package for Nest support.

Must do

Beta Give feedback

1. Implement basic package as wrapper on top of @sentry/node feat(nestjs): Add @sentry/nestjs #12613
2. Improve @sentry/nestjs error instrumentation #12768
   Package: nestjs +1
   
3. Filter expected errors feat(nestjs): Filter 4xx errors #12695 Nestjs integration reports 404 errors to sentry #12523

Should do (Enhancements)

Beta Give feedback

1. SentryTraced() decorator to get spans for arbitrary functions #12752
   +0
   
2. Instrumentation of NestJS middleware #12769
   Package: nestjs +1
   
3. Filter all HttpExceptions in @sentry/nestjs #13064
   Package: nestjs +1
   
4. Instrumentation of NestJS guards #13078
   Package: nestjs +1
   
5. Instrumentation of NestJS pipes #13121
   Package: nestjs +1
   
6. Filter all RpcExceptions in @sentry/nestjs #13190
   Package: nestjs Type: Improvement +2
   
7. Instrumentation of NestJS exception filters #13157
   Package: nestjs +1
   
8. Instrumentation of NestJS interceptors #13033
   Package: nestjs +1
   
9. Instrument @nestjs/cache-manager in @sentry/nestjs #12824
   Package: nestjs +1

Docs

Beta Give feedback

1. Initial update of docs to reference new SDK docs(nestjs): Update nestjs documentation to refer to new sdk sentry-docs#10514
2. Add @SentryTraced feature page to @sentry/nestjs docs #12819
   Package: nestjs +1
   
3. Add @SentryCron feature page to @sentry/nestjs docs #12820
   Package: nestjs +1
   

Post-release/GTM Tasks

Beta Give feedback

1. Update docs according to the new package/structure docs(nestjs): Update nestjs documentation to refer to new sdk sentry-docs#10514
2. Update the in-product onboarding to the new package/structure (feat: Update NestJS onboarding sentry#73577)
3. Update static pages https://github.com/getsentry/static-sites/pull/2649
4. Changelog post

Nest.js bugs

Beta Give feedback

1. NestJs - setupNestErrorHandler causes exceptions filters to not being called, therefore errors are not being handled #12351
   Package: nestjs Package: node Type: Bug +3
   
2. NestJs Prisma and Graphql transactions not recorded as intended #12530
   Integration: graphql Integration: nest.js Package: node +3
3. NestErrorHandler reports error wrongly #12745
   Package: node Type: Bug +2
   
4. Traces created by startSpan are not logged when using @sentry/nestjs #12771
   Package: nestjs Type: Bug +2
5. [NestJS] Sentry Error filter doesn't work in GraphQL context #13473
   Package: nestjs +1
   
6. Sentry treats all Injectable's with use function as middleware #13507
   Package: nestjs +1
   

[rubiin]

Few things I would like to add

• SentryModule.forRoot() should take option
• Also add SentryModule.forRootAsync that would allow working with config service

CC: https://github.com/ntegral/nestjs-sentry

[lforst]

@rubiin care to elaborate a bit? What kind of options should it take?

[rubiin]

we are using a separate file for initializing sentry. The module should take all the options required and do that initializing inside the module itself.

Here we are using instrument.js for that https://docs.sentry.io/platforms/javascript/guides/nestjs/
This would allow the support for .forRootAsync which is currently missing.

For reference you could look at the library https://github.com/ntegral/nestjs-sentry. Since this is the most used integration for nestjs and sentry, if the official integration made the implementation similar, the migration would be easier and also make future enhancements easy

import { Module } from '@nestjs-common';
import { SentryModule } from '@ntegral/nestjs-sentry';

@Module({
  imports: [
    SentryModule.forRoot({
      dsn: 'sentry_io_dsn',
      debug: true | false,
      environment: 'dev' | 'production' | 'some_environment',
      release: 'some_release', | null, // must create a release in sentry.io dashboard
      logLevels: ['debug'] //based on sentry.io loglevel //
    }),
  ],
})
export class AppModule {}

[lforst]

Hi, unfortunately, this approach will run into many many problems which I will not outline in detail here but TLDR in order to be able to automatically instrument a bunch of things Sentry needs to run as soon as possible. This is not possible with such an API. @ntegral/nestjs-sentry is depending on a very old SDK version that doesn't do a lot of the automatic magic that requires the SDK to run early.

In the end it comes down to aesthetic preference for you, and aesthetics isn't really what we're after with the SDK. But I still respect and appreciate the feedback! 🙏

[rubiin]

@lforst thats okay . Main concern was rather dependency injection of config service, the aesthetics don't matter rn
Will try to cookup an example , perhaps that can be included on the docs