From 88e7fa9dfda40fb6336ab0d418887f81731ce3a8 Mon Sep 17 00:00:00 2001
From: GeunH <unlxrmsgur@naver.com>
Date: Mon, 20 Nov 2023 18:16:04 +0900
Subject: [PATCH] =?UTF-8?q?feat=20:=20custom=20logger=20=EA=B5=AC=ED=98=84?=
 =?UTF-8?q?=20#35?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- interceptor를 활용하여 request, response logging.
- client ip, status , method, url, delay time logging.
- winston모듈을 이용하여 custome logger 구현.

Co-authored-by: LeeTH916 <thoon916@naver.com>
---
 be/src/app.module.ts         | 12 +++++++-
 be/src/custom.logger.ts      | 55 ++++++++++++++++++++++++++++++++++++
 be/src/logger.interceptor.ts | 41 +++++++++++++++++++++++++++
 3 files changed, 107 insertions(+), 1 deletion(-)
 create mode 100644 be/src/custom.logger.ts
 create mode 100644 be/src/logger.interceptor.ts

diff --git a/be/src/app.module.ts b/be/src/app.module.ts
index d059e904..b5d7246e 100644
--- a/be/src/app.module.ts
+++ b/be/src/app.module.ts
@@ -3,8 +3,18 @@ import { UserModule } from "./user/user.module";
 import { TypeOrmModule } from "@nestjs/typeorm";
 import { typeORMConfig } from "./configs/typeorm.config";
 import { AuthModule } from "./auth/auth.module";
+import { CustomLoggerService } from "./custom.logger";
+import { APP_INTERCEPTOR } from '@nestjs/core';
+import { LoggingInterceptor } from "./logger.interceptor";
 
 @Module({
   imports: [UserModule, TypeOrmModule.forRoot(typeORMConfig), AuthModule],
+  providers: [
+    CustomLoggerService,
+    {
+      provide: APP_INTERCEPTOR,
+      useClass: LoggingInterceptor,
+    },
+  ],
 })
-export class AppModule {}
+export class AppModule { }
diff --git a/be/src/custom.logger.ts b/be/src/custom.logger.ts
new file mode 100644
index 00000000..17d9d579
--- /dev/null
+++ b/be/src/custom.logger.ts
@@ -0,0 +1,55 @@
+import { Injectable, LoggerService } from '@nestjs/common';
+import * as winston from 'winston';
+
+@Injectable()
+export class CustomLoggerService implements LoggerService {
+    private logger: winston.Logger;
+
+    constructor() {
+        this.logger = winston.createLogger({
+            level: 'info',
+            format: winston.format.combine(
+                winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+                winston.format.printf(({ level, message, timestamp, stack = '' }) => {
+                    return `${timestamp} ${level}: ${message} ${stack} `;
+                }),
+            ),
+            transports: [
+                new winston.transports.File({ filename: 'error.log', level: 'error' }),
+                new winston.transports.File({ filename: 'combined.log' }),
+            ],
+
+        });
+
+        if (process.env.NODE_ENV !== 'production') {
+            this.logger.add(new winston.transports.Console({
+                format: winston.format.combine(
+                    winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+                    winston.format.printf(({ level, message, timestamp }) => {
+                        return `${timestamp} ${level}: ${message}`;
+                    })
+                ),
+            }));
+        }
+    }
+
+    log(message: string) {
+        this.logger.info(message);
+    }
+
+    error(message: string, trace: string) {
+        this.logger.error({ message, stack: trace });
+    }
+
+    warn(message: string) {
+        this.logger.warn(message);
+    }
+
+    debug(message: string) {
+        this.logger.debug(message);
+    }
+
+    verbose(message: string) {
+        this.logger.verbose(message);
+    }
+}
diff --git a/be/src/logger.interceptor.ts b/be/src/logger.interceptor.ts
new file mode 100644
index 00000000..213cc981
--- /dev/null
+++ b/be/src/logger.interceptor.ts
@@ -0,0 +1,41 @@
+// logging.interceptor.ts
+import {
+    Injectable,
+    NestInterceptor,
+    ExecutionContext,
+    CallHandler,
+    HttpStatus
+} from '@nestjs/common';
+import { Observable, throwError } from 'rxjs';
+import { tap, catchError } from 'rxjs/operators';
+import { CustomLoggerService } from './custom.logger';
+
+@Injectable()
+export class LoggingInterceptor implements NestInterceptor {
+    constructor(private logger: CustomLoggerService) { }
+
+    intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+        const now = Date.now();
+        const request = context.switchToHttp().getRequest();
+        const response = context.switchToHttp().getResponse();
+        const { method, url } = request;
+        const clientIp = request.ip || request.headers['x-forwarded-for'];
+
+        return next
+            .handle()
+            .pipe(
+                tap(() => {
+                    const { statusCode } = response;
+                    const delay = Date.now() - now;
+                    this.logger.log(`[Success]  ${clientIp} ${method} ${url} ${statusCode} ${delay}ms`);
+                }),
+                catchError((error) => {
+                    const status = error.status || HttpStatus.INTERNAL_SERVER_ERROR;
+                    this.logger.error(`[Error]  ${clientIp} ${method} ${url} ${status} ${error.message}`, error.stack);
+
+                    return throwError(error);
+                }),
+            );
+    }
+
+}