로깅(Logging)

로깅의 필요성

대표적인 로깅 요소

무엇을 기록할 것인가? - 로그 콘텐츠

항목	세부 내용
Error	메시지, 스택 추적, 에러 발생 시 애플리케이션이 실행하고 있던 작업
Debugging	디버깅 시 필요한 세부 추적 정보 적용되는 변수 값, 메서드 등 실행에 대한 세부 정보
주요 이벤트	로그에 저장하고 싶은 중요 이벤트 엔티티 생성, 유저 로그인 성공, 작업 실행 등

어디에 기록할 것인가?

1. 콘솔

2. 파일

항목	세부 내용
콘솔	직관적 애플리케이션 종료 혹은 콘솔 버퍼를 초과하면 내용이 휘발될 수 있음
파일	로그가 휘발되지 않고 저장됨 눈으로 읽기는 쉽지만 프로그래밍처럼 패턴화된 방식으로 필터링해서 보기에는 다른 방법보다 어려움이 따름
이메일/문자 (SMTP/SMS)	즉시 조치를 취해야 하는 등 심각한 오류나 이벤트 시에 관리자에게 알림이 가도록 설정
데이터베이스	로그 필터링이 쉽고 효율적 파일보다 기록 속도가 느리고 로깅 양이 많을 때 부하가 발생할 수 있지만 NoSQL 데이터베이스 (MongoDB 등)에 저장한다면 대부분의 문제가 해결됨

어떻게 기록할 것인가? - 로깅 레벨

패키지, 클래스 별로 어느 정도의 정보를 로그로 남길 것인지 설정할 수 있음
로그의 내용에 따라 log level을 구분
Spring Boot에서 쓰이는 로그 프레임워크인 LogBack의 log level
- TRACE < DEBUG < INFO < WARN < ERROR
- 왼쪽으로 갈수록 상세한 수준의 로그, 다음 레벨의 내용을 포함함
예)
TRACE 로그 ≫ DEBUG, INFO, WARN, ERROR 로그를 모두 포함
INFO 로그 ≫ WARN, ERROR 로그 모두 포함

항목	세부 내용
ERROR	즉시 대응해야 할 에러 레벨 로그 대응하지 않을 경우, 애플리케이션 동작 중지 등 심각한 장애를 겪을 수 있음
WARN	상황에 따라 잠재적으로 위험할 수 있을 때 예외처리 등
INFO	로그에 저장하고 싶은 중요 애플리케이션 이벤트, 운영 참고 정보
DEBUG	개발 단계에서 사용 디버깅이 가능하도록 상세한 내용이 출력됨
TRACE	개발 단계에서 사용 DEBUG 레벨보다 상세 - 모든 레벨 로그가 출력

Spring Boot 기본 로깅

SLF4J (Simple Logging Facade for Java)

SLF4J의 구현체 - Logback

SLF4J API를 사용하여 로그를 작성하면, 실제 로깅 작업은 Logback이 처리
springboot starter로 만들어 springboot-web 의존성이 추가되어 있다면 기본적으로 logback 로그 프레임워크 사용 가능
Spring Boot는 Logback에 대한 기본 설정을 제공하므로, 별도의 설정 없이도 바로 로깅을 시작할 수 있음
필요한 경우, 사용자 정의 설정을 통해 로깅 동작을 세부적으로 조절

Logback 설정하기

1. Lombok을 사용한 로깅 어노테이션

@Slf4j : Lombok 라이브러리가 제공하는 어노테이션으로, 로거(Logger) 객체를 자동으로 생성해줌
- Logger 객체를 수동으로 생성할 필요 없이 로깅 사용 가능 ≫ log.info("")

2. 로깅 사용

3. Logback 설정

두 가지 방법
- application.properties에서 간단히 설정하는 방법
- logback-spring.xml 파일을 만들어 세부 설정하는 방법
resource 폴더 밑에 위치해두면 설정을 읽음

4. 기본 logback-spring.xml

** 로깅 결과

5. 파일에 Log 기록하기

** 로깅 결과

6. 주기별로 나눠서 로그 저장하기

daeng note