Provides an sentry.io client to provide enterprise logging nestjs modules
npm install nestjs-sentry
nestjs-sentry
Provides an injectable sentry.io client to provide enterprise logging nestjs modules
- About
- License
nestjs-sentry implements a module, SentryModule, which when imported into
your nestjs project provides a Sentry.io client to any class that injects it. This
lets Sentry.io be worked into your dependency injection workflow without having to
do any extra work outside of the initial setup.
``bash
npm install --save nestjs-sentry
`
The simplest way to use nestjs-sentry is to use SentryModule.forRoot
`typescript
import { Module } from '@nestjs-common';
import { SentryModule } from '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
logLevel: LogLevel.Debug //based on sentry.io loglevel //
}),
],
})
export class AppModule {}
`
You can then use Sentry interceptor
`typescript
import { Module } from '@nestjs/common';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { SentryInterceptor, SentryModule } from 'nestjs-sentry';
@Module({
imports: [
SentryModule.forRoot({ dsn: Environment.get('API_SHOP_SENTRY_DSN') }),
],
controllers: [AppController],
providers: [
{
provide: APP_INTERCEPTOR,
useClass: SentryInterceptor,
},
],
})
export class AppModule {}
`
I would greatly appreciate any contributions to make this project better. Please
make sure to follow the below guidelines before getting your hands dirty.
1. Fork the repository
2. Create your branch (git checkout -b my-branch)
3. Commit any changes to your branch
4. Push your changes to your remote branch
5. Open a pull request
Distributed under the ISC License. See LICENSE` for more information.
- nestjs
Copyright © 2019 Adias Tech.