로깅 전략 관련 논의

[Jin409]

📄 로깅 컨벤션 가이드 v1.0 (템플릿)

버전: 1.0

작성일: 2025-08-05

목적:

일관된 로그 구조를 통해 문제 추적, 사용자 흐름 분석, 운영 효율성 향상

---

📌 1. 기본 원칙

• 모든 로그는 **읽는 사람(개발자/운영자/기획자)**이 문제를 인지하고 추적할 수 있도록 작성한다.
• 중요한 흐름의 시작/종료/예외는 반드시 로그로 남긴다.
• 로그는 요약된 의미 + 상세 맥락을 갖도록 구성한다.

---

📌 2. 로그 레벨 기준

Level	목적	사용 기준 예시
TRACE	내부 흐름 디버깅	반복 루프, 파라미터 추적 (운영 X)
DEBUG	개발/테스트 분석	API 진입, 서비스 분기 등
INFO	비즈니스 이벤트	성공적인 회원가입, 주문 생성 등
WARN	위험 징후	외부 API 지연, validation 실패 등
ERROR	예외/장애 발생	Exception 발생, DB 연결 오류 등

---

📌 8. 도구 설정 참고

• JSON 로그가 필요한 경우 logstash-logback-encoder 활용
• 로그 Appender는 Console + File 분리 출력 권장

---

✅ 작성/관리 권장 사항

• 이 문서는 docs/logging-convention.md 등에 고정 위치 배치
• PR 시 “로그 메시지/위치 적절성” 체크 항목 포함
• 주요 예외/로직 변경 시 로그 메시지 변경도 반드시 리뷰