[Feat] logger 적용

apps/api/package.json

@@ -22,12 +22,14 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
+    "@aws-sdk/client-s3": "^3.701.0",
     "@nestjs/common": "^10.4.6",
     "@nestjs/config": "^3.3.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/jwt": "^10.2.0",
     "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/schedule": "^4.1.1",
     "@nestjs/swagger": "^8.0.1",
     "@nestjs/throttler": "^6.2.1",
     "@nestjs/typeorm": "^10.0.2",
@@ -39,6 +41,7 @@
     "eslint-import-resolver-typescript": "^3.6.3",
     "jsonwebtoken": "^9.0.2",
     "mysql2": "^3.11.3",
+    "nest-winston": "^1.9.7",
     "passport": "^0.7.0",
     "passport-github2": "^0.1.12",
     "passport-google-oauth20": "^2.0.0",
@@ -47,6 +50,8 @@
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1",
     "typeorm": "^0.3.20",
+    "winston": "^3.17.0",
+    "winston-daily-rotate-file": "^5.0.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {

apps/api/src/app.module.ts

@@ -1,11 +1,15 @@
-import { Module } from '@nestjs/common';
+import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
+import { ScheduleModule } from '@nestjs/schedule';
 import { ThrottlerModule } from '@nestjs/throttler';
 import { TypeOrmModule } from '@nestjs/typeorm';
 
 import { TypeOrmConfigService } from '@/config/typeorm.config';
 
 import { AuthModule } from './auth/auth.module';
+import { LoggerMiddleware } from './common/log/logger.middleware';
+import { LoggerModule } from './common/log/logger.module';
+import { NcpModule } from './common/ncp/ncp.module';
 import { DashboardModule } from './dashboard/dashboard.module';
 import { StreamModule } from './stream/stream.module';
 import { TicleModule } from './ticle/ticle.module';
@@ -32,6 +36,12 @@
       useClass: TypeOrmConfigService,
     }),
     DashboardModule,
+    LoggerModule,
+    NcpModule,
   ],
 })
-export class AppModule {}
+export class AppModule implements NestModule {
+  configure(consumer: MiddlewareConsumer) {
+    consumer.apply(LoggerMiddleware).forRoutes('*');
+  }
+}

apps/api/src/common/filter/http-exception.filter.ts

@@ -1,7 +1,7 @@
 import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
 import { Response } from 'express';
 
-import { ErrorResponse } from '@/response.interface';
+import { ErrorResponse } from '@/common/Interceptor/response.interface';
 
 @Catch(HttpException)
 export class HttpExceptionFilter implements ExceptionFilter {

apps/api/src/common/log/logger.batch.ts

@@ -0,0 +1,37 @@
+import path from 'path';
+
+import { Injectable } from '@nestjs/common';
+import { Cron, CronExpression } from '@nestjs/schedule';
+
+import { LoggerService } from './logger.service';
+import { NcpService } from '../ncp/ncp.service';
+
+@Injectable()
+export class LogBatchService {
+  constructor(
+    private readonly ncpService: NcpService,
+    private readonly loggerService: LoggerService
+  ) {}
+
+  @Cron(CronExpression.EVERY_DAY_AT_1AM)
+  async uploadLogToObjectStorage() {
+    const logsDir = path.join(__dirname, '../../../logs');
+    console.log('logsDir : ', logsDir);
+    const today = new Date();
+    today.setHours(today.getHours() + 9);
+    today.setDate(today.getDate() - 1);
+
+    console.log('today : ', today);
+    const logFileName = `application-${today.toISOString().split('T')[0]}.log`;
+    const localFilePath = path.join(logsDir, logFileName);
+
+    console.log('localFilePath : ', localFilePath);
+    try {
+      const remoteFileName = `logs/${logFileName}`;
+      const result = await this.ncpService.uploadFile(localFilePath, remoteFileName);
+      this.loggerService.log(`Log file uploaded successfully: ${result}`, 'logBatchService');
+    } catch (error) {
+      this.loggerService.log(`Failed to upload log file: ${error}`, 'logBatchService');
+    }
+  }
+}

apps/api/src/common/log/logger.middleware.ts

@@ -0,0 +1,26 @@
+import { Injectable, NestMiddleware } from '@nestjs/common';
+import { Request, Response, NextFunction } from 'express';
+
+import { LoggerService } from './logger.service';
+
+@Injectable()
+export class LoggerMiddleware implements NestMiddleware {
+  constructor(private readonly logger: LoggerService) {}
+
+  use(req: Request, res: Response, next: NextFunction) {
+    const { method, originalUrl } = req;
+    const userAgent = req.headers['user-agent'] || 'Unknown';
+
+    res.on('finish', () => {
+      const { statusCode } = res;
+      const contentLength = res.get('content-length') || 0;
+
+      this.logger.log(
+        `[${method}] ${originalUrl} - ${statusCode} - ${contentLength} bytes - UserAgent: ${userAgent}`,
+        'HTTP'
+      );
+    });
+
+    next();
+  }
+}

apps/api/src/common/log/logger.module.ts

@@ -0,0 +1,17 @@
+import { Global, Module } from '@nestjs/common';
+import { ScheduleModule } from '@nestjs/schedule';
+import { WinstonModule } from 'nest-winston';
+
+import { WinstonConfig } from '@/config/winston.confing';
+
+import { LogBatchService } from './logger.batch';
+import { LoggerService } from './logger.service';
+import { NcpModule } from '../ncp/ncp.module';
+
+@Global()
+@Module({
+  imports: [WinstonModule.forRoot(WinstonConfig), ScheduleModule.forRoot(), NcpModule],
+  providers: [LoggerService, LogBatchService],
+  exports: [LoggerService],
+})
+export class LoggerModule {}

apps/api/src/common/log/logger.service.ts

@@ -0,0 +1,28 @@
+import { Inject, Injectable, LoggerService as NestLoggerService } from '@nestjs/common';
+import { WINSTON_MODULE_PROVIDER } from 'nest-winston';
+import { Logger } from 'winston';
+
+@Injectable()
+export class LoggerService implements NestLoggerService {
+  constructor(@Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger) {}
+
+  log(message: string, context: string) {
+    this.logger.info(message, { context });
+  }
+
+  error(message: string, trace: string, context: string) {
+    this.logger.error(message, { trace, context });
+  }
+
+  warn(message: string, context: string) {
+    this.logger.warn(message, { context });
+  }
+
+  debug(message: string, context: string) {
+    this.logger.debug(message, { context });
+  }
+
+  verbose(message: string, context: string) {
+    this.logger.verbose(message, { context });
+  }
+}

apps/api/src/common/ncp/ncp.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+
+import { NcpConfig } from '@/config/ncp.config';
+
+import { NcpService } from './ncp.service';
+
+@Module({
+  providers: [NcpService, NcpConfig],
+  exports: [NcpService],
+})
+export class NcpModule {}

apps/api/src/common/ncp/ncp.service.ts

@@ -0,0 +1,42 @@
+import * as fs from 'fs';
+
+import { S3Client, PutObjectCommand } from '@aws-sdk/client-s3';
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { ErrorMessage } from '@repo/types';
+
+import { NcpConfig } from '@/config/ncp.config';
+
+@Injectable()
+export class NcpService {
+  private s3: S3Client;
+
+  constructor(
+    private ncpConfig: NcpConfig,
+    private configService: ConfigService
+  ) {
+    this.s3 = ncpConfig.s3Client;
+  }
+
+  async uploadFile(localFilePath: string, remoteFileName: string): Promise<string> {
+    const bucketName = this.configService.get<string>('NCP_OBJECT_STORAGE_BUCKET');
+    const endpoint = this.configService.get<string>('NCP_OBJECT_STORAGE_ENDPOINT');
+
+    const fileStream = fs.createReadStream(localFilePath);
+    const params = {
+      Bucket: bucketName,
+      Key: remoteFileName,
+      Body: fileStream,
+    };
+
+    try {
+      const uploadResponse = await this.s3.send(new PutObjectCommand(params));
+      // console.log('File uploaded:', uploadResponse);
+
+      const url = `${endpoint}/${bucketName}/${remoteFileName}`;
+      return remoteFileName;
+    } catch (error) {
+      throw new Error(ErrorMessage.FILE_UPLOAD_FAILED);
+    }
+  }
+}

apps/api/src/config/ncp.config.ts

@@ -0,0 +1,25 @@
+import { S3Client } from '@aws-sdk/client-s3';
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+
+@Injectable()
+export class NcpConfig {
+  s3Client: S3Client;
+
+  constructor(private configService: ConfigService) {
+    const accessKeyId = this.configService.get<string>('NCP_ACCESS_KEY');
+    const secretAccessKey = this.configService.get<string>('NCP_SECRET_KEY');
+    const region = this.configService.get<string>('NCP_OBJECT_STORAGE_REGION');
+    const endpoint = this.configService.get<string>('NCP_OBJECT_STORAGE_ENDPOINT');
+
+    this.s3Client = new S3Client({
+      region: region,
+      credentials: {
+        accessKeyId: accessKeyId,
+        secretAccessKey: secretAccessKey,
+      },
+      endpoint: endpoint,
+      forcePathStyle: true,
+    });
+  }
+}

apps/api/src/config/winston.confing.ts

@@ -0,0 +1,26 @@
+import path from 'path';
+
+import * as winston from 'winston';
+import 'winston-daily-rotate-file';
+
+export const WinstonConfig = {
+  transports: [
+    new winston.transports.Console({
+      format: winston.format.combine(
+        winston.format.timestamp(),
+        winston.format.colorize(),
+        winston.format.printf(({ level, message, timestamp }) => {
+          return `[${timestamp}] ${level}: ${message}`;
+        })
+      ),
+    }),
+    new winston.transports.DailyRotateFile({
+      dirname: path.join(__dirname, '../../logs'),
+      filename: 'application-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+    }),
+  ],
+};

apps/api/src/dashboard/dashboard.controller.ts

@@ -3,7 +3,7 @@
 
 import { JwtAuthGuard } from '@/auth/jwt/jwt-auth.guard';
 import { GetUserId } from '@/common/decorator/get-userId.decorator';
-import { ZodValidationPipe } from '@/zodValidationPipe';
+import { ZodValidationPipe } from '@/common/pipe/zodValidationPipe';
 
 import { DashboardService } from './dashboard.service';
 import { GetDashboardListQueryDto } from './dto/getDashboardListQueryDto';

apps/api/src/main.ts

@@ -8,7 +8,8 @@ import { AppModule } from '@/app.module';
 
 import { DBExceptionFilter } from './common/filter/db-exception.filter';
 import { HttpExceptionFilter } from './common/filter/http-exception.filter';
-import { ResponseInterceptor } from './response.interceptor';
+import { ResponseInterceptor } from './common/Interceptor/response.interceptor';
+import { LoggerService } from './common/log/logger.service';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
@@ -30,6 +31,7 @@ async function bootstrap() {
     })
   );
 
+  app.useLogger(app.get(LoggerService));
   app.useGlobalInterceptors(new ResponseInterceptor());
   app.useGlobalFilters(new HttpExceptionFilter(), new DBExceptionFilter());
   app.setGlobalPrefix('api');

apps/api/src/ticle/ticle.controller.ts

@@ -3,7 +3,7 @@ import { CreateTicleSchema } from '@repo/types';
 
 import { JwtAuthGuard } from '@/auth/jwt/jwt-auth.guard';
 import { GetUserId } from '@/common/decorator/get-userId.decorator';
-import { ZodValidationPipe } from '@/zodValidationPipe';
+import { ZodValidationPipe } from '@/common/pipe/zodValidationPipe';
 
 import { CreateTicleDto } from './dto/createTicleDto';
 import { GetTicleListQueryDto } from './dto/getTicleListQueryDto';

packages/types/src/errorMessages.ts

@@ -21,6 +21,7 @@ export const ErrorMessage = {
   ROOM_NOT_FOUND: '방이 존재하지 않습니다',
   TRANSPORT_NOT_FOUND: 'transport가 존재하지 않습니다',
   PEER_ALREADY_EXISTS_IN_ROOM: '이미 방에 존재하는 Peer입니다',
+  FILE_UPLOAD_FAILED: '파일 업로드에 실패했습니다',
 } as const;
 
 export type ErrorMessage = (typeof ErrorMessage)[keyof typeof ErrorMessage];