Skip to content

docs(nestjs): Point README to SDK documentation #24618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicohrubec merged 2 commits into from
Sep 23, 2026
+8 −144
Merged

docs(nestjs): Point README to SDK documentation #24618

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10fef3b
docs(nestjs): Point README to SDK documentation
nicohrubec Sep 23, 2026
08cca4c
docs(nestjs): Generalize SDK description
nicohrubec Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 8 additions & 144 deletions packages/nestjs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,151 +10,15 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/nestjs.svg)](https://www.npmjs.com/package/@sentry/nestjs)
[![npm dt](https://img.shields.io/npm/dt/@sentry/nestjs.svg)](https://www.npmjs.com/package/@sentry/nestjs)

## Installation
The official Sentry SDK for monitoring NestJS applications.

```bash
npm install @sentry/nestjs
## Documentation

# Or yarn
yarn add @sentry/nestjs
```
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/nestjs/)
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/nestjs/configuration/)
- [NestJS-specific features](https://docs.sentry.io/platforms/javascript/guides/nestjs/features/)

@nicohrubec nicohrubec Sep 23, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kept this simple for now but we can also add more links


## Usage
## Support

Add an `instrument.ts` file:

```typescript
import * as Sentry from '@sentry/nestjs';

Sentry.init({
dsn: '__DSN__',
// ...
});
```

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

```typescript
// Import this first!
import './instrument';

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

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

bootstrap();
```

Afterwards, add the `SentryModule` as a root module to your main module:

```typescript
import { Module } from '@nestjs/common';
import { SentryModule } from '@sentry/nestjs/setup';

@Module({
imports: [
SentryModule.forRoot(),
// ...other modules
],
})
export class AppModule {}
```

In case you are using a global catch-all exception filter (which is either a filter registered with
`app.useGlobalFilters()` or a filter registered in your app module providers annotated with an empty `@Catch()`
decorator), add a `@SentryExceptionCaptured()` decorator to the `catch()` method of this global error filter. This
decorator will report all unexpected errors that are received by your global error filter to Sentry:

```typescript
import { Catch, ExceptionFilter } from '@nestjs/common';
import { SentryExceptionCaptured } from '@sentry/nestjs';

@Catch()
export class YourCatchAllExceptionFilter implements ExceptionFilter {
@SentryExceptionCaptured()
catch(exception, host): void {
// your implementation here
}
}
```

In case you do not have a global catch-all exception filter, add the `SentryGlobalFilter` to the providers of your main
module. This filter will report all unhandled errors that are not caught by any other error filter to Sentry.
**Important:** The `SentryGlobalFilter` needs to be registered before any other exception filters.

```typescript
import { Module } from '@nestjs/common';
import { APP_FILTER } from '@nestjs/core';
import { SentryGlobalFilter } from '@sentry/nestjs/setup';

@Module({
providers: [
{
provide: APP_FILTER,
useClass: SentryGlobalFilter,
},
// ..other providers
],
})
export class AppModule {}
```

**Note:** In NestJS + GraphQL applications replace the `SentryGlobalFilter` with the `SentryGlobalGraphQLFilter`.

## SentryTraced

Use the `@SentryTraced()` decorator to gain additional performance insights for any function within your NestJS
applications.

```typescript
import { Injectable } from '@nestjs/common';
import { SentryTraced } from '@sentry/nestjs';

@Injectable()
export class ExampleService {
@SentryTraced('example function')
async performTask() {
// Your business logic here
}
}
```

## SentryCron

Use the `@SentryCron()` decorator to augment the native NestJS `@Cron` decorator to send check-ins to Sentry before and
after each cron job run.

```typescript
import { Cron } from '@nestjs/schedule';
import { SentryCron } from '@sentry/nestjs';
import type { MonitorConfig } from '@sentry/core';

const monitorConfig: MonitorConfig = {
schedule: {
type: 'crontab',
value: '* * * * *',
},
checkinMargin: 2, // In minutes. Optional.
maxRuntime: 10, // In minutes. Optional.
timezone: 'America/Los_Angeles', // Optional.
};

export class MyCronService {
@Cron('* * * * *')
@SentryCron('my-monitor-slug', monitorConfig)
handleCron() {
// Your cron job logic here
}
}
```

## Links

- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nestjs/)
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
Loading