nest-raven
Advanced tools
Changelog
v10.0.1 (2023-12-03)
<!-- Release notes generated using configuration in .github/release.yml at master -->Full Changelog: https://github.com/mentos1386/nest-raven/compare/v10.0.0...v10.0.1
Full Changelog: https://github.com/mentos1386/nest-raven/compare/v9.2.0...v10.0.0
Readme
Sentry Module for Nest framework
This is a sentry module for Nest.
This package is no longer based on deprecated raven module, but rather on new stable @sentry/node module.
$ npm i --save nest-raven
For Module to work you need to setup Sentry SDK yourself,
this should be done in your main.ts file where you initialize the NestJS application.
app.module.ts
@Module({
imports: [RavenModule],
})
export class ApplicationModule implements NestModule {}
app.controller.ts
@UseInterceptors(new RavenInterceptor())
@Get('/some/route')
public async someRoute() {
...
}
With this setup, sentry will pick up all exceptions (even 400 types).
If you want to set up interceptor as global, you have to follow Nest instructions here. Something like this. This only works for Controllers not for Gateways (limitation by NestJS):
app.module.ts
import { APP_INTERCEPTOR } from '@nestjs/core';
@Module({
imports: [RavenModule],
providers: [
{
provide: APP_INTERCEPTOR,
useValue: new RavenInterceptor(),
},
],
})
export class ApplicationModule {}
Sometimes we don't want to catch all exceptions but only 500 or those that we didn't handle properly. For that we can add filters on interceptor to filter out good exceptions.
app.controller.ts
@UseInterceptors(new RavenInterceptor({
filters: [
// Filter exceptions of type HttpException. Ignore those that
// have status code of less than 500
{ type: HttpException, filter: (exception: HttpException) => 500 > exception.getStatus() }
],
}))
@Get('/some/route')
public async someRoute() {
...
}
It may be useful to add some extra data to the Sentry's context before sending the payload. Adding some request-related properties for instance. To achieve this we can add scope transformers on interceptor to injecte some data dynamically.
app.controller.ts
@UseInterceptors(new RavenInterceptor({
transformers: [
// Add an extra property to Sentry's scope
(scope: Scope, context: ExecutionContext) => {
const req = context.switchToHttp().getRequest<Request>();
scope.addExtra('important query', req.query.important_query)
scope.addExtra('important key', 'useful value');
}
],
}))
@Get('/some/route')
public async someRoute() {
...
}
Interceptor automatically adds req and req.user (as user) to additional data.
Other additional data can be added for each interceptor.
app.controller.ts
import { Severity } from '@sentry/node';
@UseInterceptors(new RavenInterceptor({
tags: {
type: 'fileUpload',
},
level: Severity.Warning,
}))
@Get('/some/route')
public async someRoute()
...
}
Note: Websockets ignore Global interceptors.
It will add ws_client and ws_data extras.
app.gateway.ts
@UseInterceptors(new RavenInterceptor())
@SubscribeMessage('message_name')
public someMessage(client, data: string): string {
...
}
It will add fieldName and args extras.
app.gateway.ts
@Mutation()
@UseInterceptors(new RavenInterceptor())
async upvotePost(@Args('postId') postId: number) {
...
}
FAQs
Sentry Raven Module for Nest Framework
We found that nest-raven demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.