@evanion/nestjs-correlation-id 1.0.0 → 1.0.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 John Biundo
+Copyright (c) 2019 Mikael Pettersson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -77,6 +77,73 @@ export class AppModule implements NestModule {
 }
 ```
 
+#### Add `correlationId` to logs
+
+In order to add the correlation ID to your logs, you can use the `CorrelationService` service to get the current correlationId.
+
+In the following example, we are using the [@ntegral/nestjs-sentry](https://github.com/ntegral/nestjs-sentry) package, but you can use any package or provider you like.
+
+```ts
+import { Injectable, NestMiddleware } from '@nestjs/common';
+import { Request, Response } from 'express';
+import { CorrelationService } from '@evanion/nestjs-correlation-id';
+import { InjectSentry, SentryService } from '@ntegral/nestjs-sentry';
+
+@Injectable()
+export class SentryMiddleware implements NestMiddleware {
+  constructor(
+    private readonly correlationService: CorrelationService,
+    @InjectSentry() private readonly sentryService: SentryService,
+  ) {}
+
+  async use(req: Request, res: Response, next) {
+    const correlationId = await this.correlationService.getCorrelationId();
+    this.sentryService.configureScope((scope) => {
+      scope.setTag('correlationId', correlationId);
+    });
+    next();
+  }
+}
+```
+
+Then add it to your `AppModule`
+
+```ts
+import { Module } from '@nestjs-common';
+import {
+  SentryModule,
+  ConfigModule,
+  ConfigService,
+} from '@ntegral/nestjs-sentry';
+import {
+  CorrelationModule,
+  CorrelationService,
+} from '@evanion/nestjs-correlation-id';
+
+@Module({
+  imports: [
+    CorrelationModule.forRoot(),
+    SentryModule.forRoot({
+      // ... your config
+    }),
+  ],
+})
+export class AppModule implements NestModule {
+  configure(consumer: MiddlewareConsumer) {
+    consumer.apply(CorrelationIdMiddleware).forRoutes('*');
+    consumer.apply(SentryMiddleware).forRoutes('*');
+  }
+}
+{
+}
+```
+
+If you need to manually set the correlationId anywhere in your application. You can use the `CorrelationService` service to set the correlationId.
+
+```ts
+this.correlationService.setCorrelationId('some_correlation_id');
+```
+
 see [e2e tests](/test) for a fully working example
 
 ## Change Log

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanion/nestjs-correlation-id",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Transparently forward or add correlation id to all requests",
   "author": "Mikael Pettersson <evanion@icloud.com>",
   "license": "MIT",
@@ -20,7 +20,8 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "release": "release-it"
   },
   "keywords": [
     "nestjs",
@@ -43,7 +44,6 @@
     "@nestjs/axios": "^0.1.0",
     "@nestjs/common": "^6.0.0"
   },
-  "dependencies": {},
   "devDependencies": {
     "@nestjs/axios": "^0.1.0",
     "@nestjs/common": "^9.0.1",
@@ -62,6 +62,7 @@
     "jest": "28.1.2",
     "prettier": "^2.7.1",
     "reflect-metadata": "^0.1.13",
+    "release-it": "^15.1.1",
     "rxjs": "^7.5.5",
     "supertest": "6.2.4",
     "ts-jest": "28.0.5",