Merge pull request #45 from HangHae-plus-2-9/feature-common

Feat: add http logging interceptor

src/app.module.ts

@@ -13,6 +13,8 @@ import { WinstonContextModule } from './winston-context/winston-context.module';
 import { HttpExceptionFilter } from './common/filters/http.exception.filter';
 import { FavoriteModule } from './modules/favorite/favorite.module';
 import { CartModule } from './modules/cart/cart.module';
+import { HttpLoggerInterceptor } from './common/interceptors';
+import { APP_INTERCEPTOR } from '@nestjs/core';
 // import { PaymentsModule } from './modules/payments/payments.module';
 
 @Module({
@@ -33,7 +35,13 @@ import { CartModule } from './modules/cart/cart.module';
     FavoriteModule,
     CartModule,
   ],
-  providers: [HttpExceptionFilter],
+  providers: [
+    HttpExceptionFilter,
+    {
+      provide: APP_INTERCEPTOR,
+      useClass: HttpLoggerInterceptor,
+    },
+  ],
 })
 export class AppModule implements NestModule {
   constructor(private readonly als: AsyncLocalStorage<any>) {}

src/common/interceptors/http-logger.interceptor.ts

@@ -0,0 +1,46 @@
+import { WinstonContextLogger } from '@/winston-context/winston-context.logger';
+import {
+  Injectable,
+  NestInterceptor,
+  ExecutionContext,
+  CallHandler,
+} from '@nestjs/common';
+import { Observable } from 'rxjs';
+import { tap } from 'rxjs/operators';
+import { formattedString } from '../utils';
+
+@Injectable()
+export class HttpLoggerInterceptor implements NestInterceptor {
+  constructor(private readonly cLogger: WinstonContextLogger) {}
+
+  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+    const now = Date.now();
+    const httpContext = context.switchToHttp();
+    const req = httpContext.getRequest();
+    const res = httpContext.getResponse();
+    const { method, originalUrl, ip, headers: reqHeaders, body: reqBody } = req;
+
+    return next.handle().pipe(
+      tap(() => {
+        const { statusCode } = res;
+        const contentLength = res.get('content-length') || 0;
+        const userAgent = req.get('user-agent') || '';
+        const logMessage = `${method} ${originalUrl} ${statusCode} ${contentLength} ${
+          Date.now() - now
+        }ms - ${userAgent} ${ip}`;
+
+        if (statusCode >= 500) {
+          this.cLogger.error(formattedString(logMessage));
+        } else if (statusCode >= 400) {
+          this.cLogger.warn(formattedString(logMessage));
+        } else {
+          this.cLogger.log(formattedString(logMessage));
+        }
+
+        // 추가적으로 reqHeaders, reqBody를 로깅하고 싶다면 아래 주석을 해제하세요.
+        // this.cLogger.verbose(`Headers: ${formattedString(reqHeaders)}`);
+        // this.cLogger.verbose(`Body: ${formattedString(reqBody)}`);
+      }),
+    );
+  }
+}

src/common/interceptors/index.ts

@@ -1 +1,2 @@
 export * from './transform.interceptors';
+export * from './http-logger.interceptor';

src/common/utils.ts

@@ -48,3 +48,5 @@ export const getEndOfDay = (date: Date) => {
 export const createNumericId = () => {
   return Math.floor(Math.random() * 2000000000);
 };
+
+export const formattedString = (str: string) => JSON.stringify(str, null, 2);

src/config/winston.config.ts

@@ -41,13 +41,13 @@ const customLogFormat = combine(
   printf((aLog) => {
     const nestReqId = aLog.alsCtx?.nestReqId;
     const nestReqIdStr = nestReqId //
-      ? `[${nestReqId}]`
+      ? `${nestReqId}`
       : '';
     const stackStr =
       aLog.stack && aLog.stack[0] !== undefined //
         ? ` \n ${aLog.stack}`
         : '';
-    return `[${aLog.timestamp}] [${aLog.level}] ${nestReqIdStr}: ${aLog.message}${stackStr}`;
+    return `[${aLog.timestamp}] [${aLog.level}] [${nestReqIdStr}]: ${aLog.message}${stackStr}`;
   }),
 );
 
@@ -71,9 +71,9 @@ const cloudwatchConfig = {
     const { level, message, additionalInfo, alsCtx } = aLog;
     const nestReqId = alsCtx?.nestReqId;
     const nestReqIdStr = nestReqId //
-      ? `[${nestReqId}]`
-      : '[]';
-    return `[${level}] ${nestReqIdStr}: ${message} \nAdditional Info: ${JSON.stringify(
+      ? `${nestReqId}`
+      : '';
+    return `[${level}] [${nestReqIdStr}]: ${message} \nAdditional Info: ${JSON.stringify(
       additionalInfo,
     )}`;
   },