✨ Feature: Add YAML-based configuration override for logger

- Enable overriding default logging settings via a `logger-config.yaml` file at the project root

Author: yooseungmo

README.md

@@ -111,33 +111,30 @@ logs/
 
 | Feature                                    | Description                                                             |
 |--------------------------------------------|-------------------------------------------------------------------------|
-| **다중 전송 로깅 (Multi-Transport Logging)** | - 콘솔 출력과 파일 저장을 동시에 지원<br>- 일정 크기(예: 20MB) 또는 일정 주기(예: 15일)에 따라 자동으로 로그 파일 회전<br>- 로그 파일 예시: `combined-YYYY-MM-DD.log`, `error-YYYY-MM-DD.log`, `exceptions-YYYY-MM-DD.log`, `rejections-YYYY-MM-DD.log` 등의 이름으로 날짜가 붙은 형식으로 저장 |
+| **다중 전송 로깅 (Multi-Transport Logging)** | - 콘솔 출력과 파일 저장을 동시에 지원<br>- 일정 크기(예: 20MB) 또는 일정 주기(예: 15일)에 따라 자동으로 로그 파일 회전<br>- 로그 파일 예시: `combined-YYYY-MM-DD.log`, `error-YYYY-MM-DD.log`, `exceptions-YYYY-MM-DD.log`, `rejections-YYYY-MM-DD.log`|
 | **구조화된 로그 출력 (Structured Logging)** | - UUIDv5를 사용해 고유 LogID 생성<br>- `{timestamp, level, message}` 형식의 표준 JSON 포맷으로 출력되어 외부 시스템 연동 용이 |
 | **모듈별 컨텍스트 추적 (Contextual Tracing)** | - `BlancLoggerMiddleware`를 활용하여 HTTP 요청에서 모듈명 자동 추출<br>- `[UserService → AuthModule → Subsystem]`과 같이 계층 구조로 표시 |
 | **동적 로그 레벨 관리 (Dynamic Log Levels)** | - 개발 및 운영 환경에 따라 `debug, verbose, info, warn, error` 로그 레벨을 실시간으로 조절 가능<br>- 필요한 정보만 선별 기록하여 로그의 가독성과 관리 효율성을 향상 |
 | **SQL 구문 하이라이팅 (SQL Syntax Highlighting)** | - SQL 쿼리의 키워드, 값, 테이블명을 색상 강조 및 들여쓰기로 구분<br>- 파라미터 값 컨텍스트 인식 강조 |
 | **쿼리 성능 분석 (Query Analysis)** | - SQL 성능 저하 유발 패턴 자동 감지 (`SELECT *`, `JOIN 조건 누락` 등) |
 | **에러 진단 및 스택 추적 (Error Diagnostics)** | - 에러 발생 시 다중 스택 레이어와 추가 메타데이터를 포함하여 상세한 에러 로그 기록 |
 | **성능 모니터링 (Performance Monitoring)** | - HTTP 요청 처리 시간 및 `Slow Query`(예: 100ms) 경고 로그 생성<br>- 실행 계획(Explain Plan) 리포트 시각화  |
-| **커스터마이징 (Customization)** | - `logger.config.ts`파일을 통해 로그 저장 경로, 로그 레벨, 파일 크기, 회전 주기 등을 쉽게 조정 가능 |
+| **커스터마이징 (Customization)** | - `logger-config.yaml`파일을 통해 로그 저장 경로, 로그 레벨, 파일 크기, 회전 주기 등을 쉽게 조정 가능 |
 
 ---
 
 ## Configuration
 
 > Blanc Logger는 기본 설정을 제공하지만, 필요에 따라 **사용자 환경**에 맞게 커스터마이징 할 수 있습니다.  
-> 설정을 변경하려면 프로젝트에 `logger.config.ts` 파일을 생성하고 아래와 같이 `Override`할 수 있습니다.
+> 설정을 변경하려면 `프로젝트 루트`에 `logger-config.yaml` 파일을 생성하고 아래와 같이 `Override`할 수 있습니다.
+
+```yaml
+LOG_DIR: logs            # 로그 파일 저장 경로 (기본: 프로젝트 루트/logs)
+CONSOLE_LOG_LEVEL: info  # 콘솔 출력 로그 레벨 (debug, info, warn, error)
+FILE_LOG_LEVEL: error    # 파일 출력 로그 레벨
+ROTATION_DAYS: 30d       # 로그 파일 보관 기간 (예: 30일)
+MAX_FILE_SIZE: 20m       # 단일 파일 최대 크기 (예: 20MB)
 
-```typescript
-import { setLoggingConfig } from 'blanc-logger';
-
-setLoggingConfig({
-  LOG_DIR: 'logs',            // 로그 파일 저장 경로 (기본: 프로젝트 루트/logs)
-  CONSOLE_LOG_LEVEL: 'info',  // 콘솔 출력 로그 레벨 (debug, info, warn, error)
-  FILE_LOG_LEVEL: 'error',    // 파일 출력 로그 레벨
-  ROTATION_DAYS: '30d',       // 로그 파일 보관 기간 (예: 30일)
-  MAX_FILE_SIZE: '20m'        // 단일 파일 최대 크기 (예: 20MB)
-});
 ```
 ---
 

package-lock.json

@@ -1,10 +1,12 @@
 {
   "name": "blanc-logger",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Advanced Winston logger for NestJS & TypeORM with structured logging (npm package).",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["dist"],  
+  "files": [
+    "dist"
+  ],
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -34,6 +36,7 @@
   "dependencies": {
     "@nestjs/common": "^9.0.0",
     "chalk": "^4.1.0",
+    "js-yaml": "^4.1.0",
     "nest-winston": "^1.0.0",
     "typeorm": "^0.3.20",
     "uuid": "^9.0.0",
@@ -42,6 +45,7 @@
   },
   "devDependencies": {
     "@types/express": "^5.0.0",
+    "@types/js-yaml": "^4.0.9",
     "@types/uuid": "^10.0.0",
     "eslint": "^8.0.0",
     "express": "^4.21.2",

package.json

@@ -1,3 +1,7 @@
+import * as fs from 'fs';
+import * as yaml from 'js-yaml';
+import * as path from 'path';
+
 export interface LoggingConfig {
   LOG_DIR: string; // 로그 파일 저장 디렉토리
   CONSOLE_LOG_LEVEL: string; // 콘솔 로그 레벨
@@ -6,17 +10,26 @@ export interface LoggingConfig {
   MAX_FILE_SIZE: string; // 단일 파일 최대 크기
 }
 
-const defaultLoggingConfig: LoggingConfig = {
-  LOG_DIR: 'logs', // 기본 로그 파일 저장 디렉토리
-  CONSOLE_LOG_LEVEL: 'info', // 기본 콘솔 로그 레벨
-  FILE_LOG_LEVEL: 'error', // 기본 파일 로그 레벨
-  ROTATION_DAYS: '30d', // 기본 로그 파일 보관 기간
-  MAX_FILE_SIZE: '20m', // 기본 단일 파일 최대 크기
+const DEFAULT_LOGGING_CONFIG: LoggingConfig = {
+  LOG_DIR: 'logs',
+  CONSOLE_LOG_LEVEL: 'info',
+  FILE_LOG_LEVEL: 'error',
+  ROTATION_DAYS: '30d',
+  MAX_FILE_SIZE: '20m',
 };
 
-export let LOGGING_CONFIG: LoggingConfig = { ...defaultLoggingConfig };
+function loadUserConfig(configFileName: string = 'logger-config.yaml'): Partial<LoggingConfig> {
+  const configPath = path.resolve(process.cwd(), configFileName);
+  if (!fs.existsSync(configPath)) return {};
+  const fileContents = fs.readFileSync(configPath, 'utf8');
+  return yaml.load(fileContents) as Partial<LoggingConfig>;
+}
+
+export let LOGGING_CONFIG: LoggingConfig = {
+  ...DEFAULT_LOGGING_CONFIG,
+  ...loadUserConfig(),
+};
 
-// 유저가 원하는 값으로 오버라이드
 export function setLoggingConfig(userConfig: Partial<LoggingConfig>): void {
-  LOGGING_CONFIG = { ...defaultLoggingConfig, ...userConfig };
+  LOGGING_CONFIG = { ...DEFAULT_LOGGING_CONFIG, ...userConfig };
 }