\n
\n Provides an injectable LogDNA client for logging in nestjs modules\n
\n\n\n This is a fork of [@ntegral/nestjs-sentry](https://github.com/ntegral/nestjs-sentry)\n## Table Of Contents\n\n- [Table Of Contents](#table-of-contents)\n- [About](#about)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Middleware](#middleware)\n- [Exception Filter](#exception-filter)\n- [License](#license)\n- [Acknowledgements](#acknowledgements)\n\n## About\n\n`@bluepic/logdna-nestjs` implements a module, `LogDNAModule`, which when imported into\nyour nestjs project provides a LogDNA client to any class that injects it. This\nlets LogDNA 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 @bluepic/logdna-nestjs @logdna/logger\n```\n## Getting Started\n\nThe simplest way to use `@bluepic/logdna-nestjs` is to use `LogDNAModule.forRootAsync`\n\n```typescript\nimport { Module } from '@nestjs-common';\nimport { LogDNAModule } from '@bluepic/logdna-nestjs';\nimport { ConfigModule, ConfigService } from '@nestjs/config';\n\n@Module({\n imports: [\n LogDNAModule.forRootAsync({\n imports: [ConfigModule],\n useFactory: async (configService: ConfigService) => ({\n ingestionKey: configService.get('LOGDNA_INGESTION_KEY'),\n logDNAOptions: {\n app: 'App Name',\n env: process.env.NODE_ENV,\n defaultLevel: 'info',\n hostname: 'Hostname',\n },\n }),\n inject: [ConfigService],\n });\n ],\n})\nexport class AppModule {}\n```\n\nYou can then inject the LogDNA client into any of your injectables by using a\ncustom decorator\n\n```typescript\nimport { Injectable } from '@nestjs/common';\nimport { LogDNAService, InjectLogDNA } from '@bluepic/logdna-nestjs';\n\n@Injectable()\nexport class AppService {\n constructor(@InjectLogDNA() private readonly logger: LogDNAService) {}\n testLogger() {\n this.logger.log('TEST');\n }\n}\n```\n\nYou can instruct Nest to use the LogDNAService as the default logger:\n\n```typescript\nimport { LogDNAService } from '@bluepic/logdna-nestjs';\n\nasync function bootstrap() {\n const app = await NestFactory.create(AppModule, { logger: false });\n\n app.useLogger(LogDNAService.LogDNAServiceInstance());\n\n await app.listen(3000);\n}\nbootstrap();\n```\n\n## Middleware\n\nYou can use the LogDNAhttpLogger Middleware to automatically log all incoming requests/outgoing responses\n\n```typescript\nimport { LogDNAhttpLogger } from '@bluepic/logdna-nestjs';\n\nasync function bootstrap() {\n const app = await NestFactory.create(AppModule);\n\n app.use(LogDNAhttpLogger({\n filter: (req, res) => res.statusCode == 500\n }))\n\n await app.listen(3000);\n}\nbootstrap();\n```\n\n## Exception Filter\n\nYou can use the LogDNAhttpExceptionLogger to automatically log exceptions\n\n```typescript\nimport { LogDNAhttpExceptionLogger } from '@bluepic/logdna-nestjs';\n\nasync function bootstrap() {\n const app = await NestFactory.create(AppModule);\n\n app.useGlobalFilters(new LogDNAhttpExceptionLogger({\n generateReference: true\n }));\n\n await app.listen(3000);\n}\nbootstrap();\n```\n\n## License\n\nDistributed under the ISC License. See `LICENSE` for more information.\n\n## Acknowledgements\n\n- This is a fork of [@ntegral/nestjs-sentry](https://github.com/ntegral/nestjs-sentry)\n- [nestjs](https://nestjs.com)\n- [logdna](https://www.logdna.com/)\n- [@logdna/logger](https://www.npmjs.com/package/@logdna/logger)","readmeFilename":"README.MD"}