Merge pull request #24 from OlufunbiIK/feat/Add-Comprehensive-Logging-with-Structured-Format-#10

Feat/add comprehensive logging with structured format #10

Author: LaGodxy

package-lock.json

@@ -57,6 +57,7 @@
     "bull": "^4.12.2",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
+    "cls-hooked": "^4.2.2",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
     "crypto-js": "^4.2.0",
@@ -85,7 +86,7 @@
     "sharp": "^0.33.1",
     "uuid": "^9.0.1",
     "web3": "^4.3.0",
-    "winston": "^3.11.0",
+    "winston": "^3.19.0",
     "winston-daily-rotate-file": "^4.7.1",
     "xlsx": "^0.18.5"
   },
@@ -100,7 +101,7 @@
     "@types/cors": "^2.8.17",
     "@types/crypto-js": "^4.2.1",
     "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.8",
+    "@types/jest": "^29.5.14",
     "@types/jsonwebtoken": "^9.0.5",
     "@types/lodash": "^4.14.202",
     "@types/multer": "^1.4.11",
@@ -121,7 +122,7 @@
     "rimraf": "^5.0.5",
     "source-map-support": "^0.5.21",
     "supertest": "^6.3.3",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^29.4.6",
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",

package.json

@@ -0,0 +1,10 @@
+import { createNamespace } from 'cls-hooked';
+
+export const CORRELATION_ID_NAMESPACE = 'app';
+export const CORRELATION_ID_KEY = 'correlationId';
+
+export const correlationNamespace = createNamespace(CORRELATION_ID_NAMESPACE);
+
+export const getCorrelationId = (): string => {
+  return correlationNamespace.get(CORRELATION_ID_KEY);
+};

src/common/logger/correlation-id.ts

@@ -4,6 +4,7 @@ import { LoggerService } from './logger.service';
 import { ConfigService } from '@nestjs/config';
 import * as winston from 'winston';
 import * as DailyRotateFile from 'winston-daily-rotate-file';
+import { LoggingInterceptor } from './logging.interceptor';
 
 @Global()
 @Module({
@@ -24,10 +25,7 @@ import * as DailyRotateFile from 'winston-daily-rotate-file';
         transports: [
           // Console transport for development
           new winston.transports.Console({
-            format: winston.format.combine(
-              winston.format.colorize(),
-              winston.format.simple(),
-            ),
+            format: winston.format.combine(winston.format.colorize(), winston.format.simple()),
           }),
 
           // File transport for errors
@@ -60,7 +58,7 @@ import * as DailyRotateFile from 'winston-daily-rotate-file';
       }),
     }),
   ],
-  providers: [LoggerService],
-  exports: [LoggerService, WinstonModule],
+  providers: [LoggerService, LoggingInterceptor],
+  exports: [LoggerService, WinstonModule, LoggingInterceptor],
 })
 export class LoggerModule {}

src/common/logger/logger.module.ts

@@ -0,0 +1,40 @@
+import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/common';
+import { Observable, tap } from 'rxjs';
+import { getCorrelationId } from './correlation-id';
+import { LoggerService } from './logger.service';
+
+@Injectable()
+export class LoggingInterceptor implements NestInterceptor {
+  constructor(private readonly logger: LoggerService) {} // ✅ inject LoggerService
+
+  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+    const req = context.switchToHttp().getRequest();
+    const correlationId = getCorrelationId();
+
+    this.logger.log(
+      {
+        message: 'Handling request',
+        method: req.method,
+        url: req.url,
+        correlationId,
+      },
+      this.logger['context'], // optional context
+    );
+
+    const now = Date.now();
+    return next.handle().pipe(
+      tap(() => {
+        const res = context.switchToHttp().getResponse();
+        this.logger.log(
+          {
+            message: 'Handling request',
+            method: req.method,
+            url: req.url,
+            correlationId,
+          },
+          this.logger['context'], // optional context
+        );
+      }),
+    );
+  }
+}

src/common/logger/logging.interceptor.ts

@@ -0,0 +1,27 @@
+import { Injectable, NestMiddleware } from '@nestjs/common';
+import { Request, Response, NextFunction } from 'express';
+import { v4 as uuidv4 } from 'uuid';
+import { correlationNamespace, CORRELATION_ID_KEY, getCorrelationId } from './correlation-id';
+import { LoggerService } from './logger.service';
+
+@Injectable()
+export class LoggingMiddleware implements NestMiddleware {
+  constructor(private readonly logger: LoggerService) {}
+
+  use(req: Request, res: Response, next: NextFunction) {
+    const correlationId = req.headers['x-correlation-id'] || uuidv4();
+
+    correlationNamespace.run(() => {
+      correlationNamespace.set(CORRELATION_ID_KEY, correlationId);
+
+      this.logger.logRequest(req.method, req.url, undefined, req.ip);
+
+      const start = Date.now();
+      res.on('finish', () => {
+        this.logger.logResponse(req.method, req.url, res.statusCode, Date.now() - start);
+      });
+
+      next();
+    });
+  }
+}