\n
\n Provides an injectable sentry.io client to provide enterprise logging nestjs modules\n
\n\n\n## Table Of Contents\n\n- [NestJS 8 Support](#nestjs-8-support)\n- [About](#about)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Contributing](#contributing)\n- [License](#license)\n- [Acknowledgements](#acknowledgements)\n\n## NestJS 8 Support\nVersion 3.x.x will support NestJS 8+. If you need support for NestJS 7 please continue to use Version 2.x.x. Thanks for you support!\n\n## About\n\n`@ntegral/nestjs-sentry` implements a module, `SentryModule`, which when imported into\nyour nestjs project provides a Sentry.io client to any class that injects it. This\nlets Sentry.io be worked into your dependency injection workflow without having to\ndo any extra work outside of the initial setup.\n\n## Installation\n\n```bash\nnpm install --save @ntegral/nestjs-sentry @sentry/node\n```\n\n## Github Sample Project using @ntegral/nestjs-sentry\n\nThe following project was created as a sample starter project to get you going... (if needed...).\n- [@ntegral/nestjs-sentry sample](https://github.com/ntegral/nestjs-sentry-example)\n\n## Getting Started\n\nThe simplest way to use `@ntegral/nestjs-sentry` is to use `SentryModule.forRoot`\n\n```typescript\nimport { Module } from '@nestjs-common';\nimport { SentryModule } from '@ntegral/nestjs-sentry';\n\n@Module({\n imports: [\n SentryModule.forRoot({\n dsn: 'sentry_io_dsn',\n debug: true | false,\n environment: 'dev' | 'production' | 'some_environment',\n release: 'some_release', | null, // must create a release in sentry.io dashboard\n logLevels: ['debug'] //based on sentry.io loglevel //\n }),\n ],\n})\nexport class AppModule {}\n```\n\nThe async way `@ntegral/nestjs-sentry` is to use `SentryModule.forRootAsync`\n\n```typescript\nimport { Module } from '@nestjs-common';\nimport { SentryModule } from '@ntegral/nestjs-sentry';\nimport { ConfigModule } from '@ntegral/nestjs-config';\nimport { ConfigService } from '@ntegral/nestjs-config';\n\n@Module({\n imports: [\n SentryModule.forRootAsync({\n imports: [ConfigModule],\n useFactory: async (cfg:ConfigService) => ({\n dsn: cfg.get('SENTRY_DSN'),\n debug: true | false,\n environment: 'dev' | 'production' | 'some_environment',\n release: 'some_release', | null, // must create a release in sentry.io dashboard\n logLevels: ['debug'] //based on sentry.io loglevel //\n }),\n inject: [ConfigService],\n })\n ]\n})\n\nexport class AppModule {}\n```\n\nYou can then inject the Sentry client into any of your injectables by using a\ncustom decorator\n\n```typescript\nimport { Injectable } from '@nestjs/common';\nimport { InjectSentry, SentryService } from '@ntegral/nestjs-sentry';\n\n@Injectable()\nexport class AppService {\n public constructor(@InjectSentry() private readonly client: SentryService) {\n client.instance().captureMessage(message, Sentry.Severity.Log);\n client.instance().captureException(exception);\n ... and more\n }\n}\n```\n\nYou can instruct Nest to use the SentryService as the default logger:\n\n```typescript\nasync function bootstrap() {\n const app = await NestFactory.create(AppModule, { logger: false });\n\n app.useLogger(SentryService.SentryServiceInstance());\n await app.listen(3000);\n}\nbootstrap();\n```\n\nYou can instuct use the SentryService to log non-error messages as breadcrumbs or use the native Sentry.addBreadcrumb method.\n\n```typescript\nimport { Injectable } from '@nestjs/common';\nimport { InjectSentry, SentryService } from '@ntegral/nestjs-sentry';\n\n@Injectable()\nexport class AppService {\n constructor(@InjectSentry() private readonly client: SentryService) {\n client.log('AppSevice Loaded','test', true); // creates log asBreadcrumb //\n client.instance().addBreadcrumb({level: 'debug' , message: 'How to use native breadcrumb', data: { context: 'WhatEver'}})\n client.debug('AppService Debug', 'context');\n }\n getHello(): string {\n return 'Hello World!';\n }\n}\n```\n\n## Interceptors\n\nBREAKING CHANGES: The SentryInterceptor can be used in projects that don't require GraphQL. If you will be needed GraphQL support, use the GraphqlInterceptor. Using the GraphqlInterceptor will create a dependancy for the @nestjs/graphql package.\n\n```bash\nnpm install --save @nestjs/graphql\n```\n\nUsing graphql interceptor globally\n```typescript\nimport { Module } from '@nestjs/common';\nimport { APP_INTERCEPTOR } from '@nestjs/core';\nimport { GraphqlInterceptor } from '@ntegral/nestjs-sentry';\n\n@Module({\n ....\n providers: [\n {\n provide: APP_INTERCEPTOR,\n useFactory: () => new GraphqlInterceptor(),\n },\n ],\n})\nexport class AppModule {}\n```\n\nUsing the sentry interceptor globally\n```typescript\nimport { Module } from '@nestjs/common';\nimport { APP_INTERCEPTOR } from '@nestjs/core';\nimport { SentryInterceptor } from '@ntegral/nestjs-sentry';\n\n@Module({\n ....\n providers: [\n {\n provide: APP_INTERCEPTOR,\n useFactory: () => new SentryInterceptor({\n filters: [{\n type: HttpException,\n filter: (exception: HttpException) => 500 > exception.getStatus() // Only report 500 errors\n }]\n }),\n }\n ],\n})\nexport class AppModule {}\n```\n\n## Flushing sentry\nSentry does not flush all the errors by itself, it does it in background so that it doesn't block the main thread. If \nyou kill the nestjs app forcefully some exceptions have to be flushed and logged successfully.\n\nIf you want to force that behaviour use the close flag in your options. That is handy if using nestjs as a console\nrunner. Keep in mind that you need to have ```app.enableShutdownHooks();``` enabled in order \nfor closing (flushing) to work.\n\n```typescript\nimport { Module } from '@nestjs-common';\nimport { SentryModule } from '@ntegral/nestjs-sentry';\n\n@Module({\n imports: [\n SentryModule.forRoot({\n dsn: 'sentry_io_dsn',\n debug: true | false,\n environment: 'dev' | 'production' | 'some_environment',\n release: 'some_release', | null, // must create a release in sentry.io dashboard\n logLevels: ['debug'] //based on sentry.io loglevel //\n close: {\n enabled: true,\n // Time in milliseconds to forcefully quit the application \n timeout?: number, \n }\n }),\n ],\n})\nexport class AppModule {}\n```\n\n\n## Contributing\n\nI would greatly appreciate any contributions to make this project better. Please\nmake sure to follow the below guidelines before getting your hands dirty.\n\n1. Fork the repository\n2. Create your branch (`git checkout -b my-branch`)\n3. Commit any changes to your branch\n4. Push your changes to your remote branch\n5. Open a pull request\n\n## License\n\nDistributed under the ISC License. See `LICENSE` for more information.\n\n## Acknowledgements\n\n- [nestjs](https://nestjs.com)\n- [@sentry/node](https://github.com/getsentry/sentry-javascript)\n\nCopyright © 2019 Ntegral Inc.\n","readmeFilename":"README.MD"}