로그 라이브러리: SLF4J, Logback

2025. 5. 2. 14:04Backend/기타

1. 로그 라이브러리를 통한 로그 사용

  • 운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고,
    별도의 로깅 라이브러리를 사용해서 로그를 출력한다.
  • 스프링 부트 로깅 라이브러리는 기본적으로 Logback을 제공한다.
    • SLF4J: 여러 로그 라이브러리(Logback, Log4J, Log4J2 등)를 통합해서 인터페이스로 제공
    • Logback: SLF4J를 구현한 구현체
  • 로그 사용시 장점 
    • 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
    • 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.
    • 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.
      특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
    • 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등) 그래서 실무에서는 꼭 로그를 사용해야 한 다.

2. 로그 사용법

import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class LogTestController {
    //1. 로그 선언: 롬복으로도 가능
    //private final Logger log = LoggerFactory.getLogger(getClass());

    @RequestMapping("/log-test")
    public String logTest(){
        String name = "Spring";
        
        //단순 출력
        System.out.println("name = " + name);
        
        //2. slf4j.Logger로 로그 호출 
        //로그 레벨 설정이 가능하다 (뒤로 갈수록 레벨 높아짐)
        log.trace("trace log={}", name);
        log.debug("debug log={}", name);
        log.info("info log={}", name); //디폴트
        log.warn("warn log={}", name);
        log.error("error log={}", name);
        
        return "ok";
    }
}
  • 선언: private final Logger log = LoggerFactory.getLogger(getClass());
    롬복으로 @Slf4j를 쓰면 위와 똑같이 log라는 이름으로 Logger 객체를 생성해줌 (바로 log 변수 쓰면 됨)
  • 로그가 출력되는 포멧
    시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지
2025-04-30T12:53:18.559+09:00  INFO 3249 --- [springmvc] [nio-8080-exec-2] h.springmvc.basic.LogTestController      : info log=Spring
2025-04-30T12:53:18.560+09:00  WARN 3249 --- [springmvc] [nio-8080-exec-2] h.springmvc.basic.LogTestController      : warn log=Spring
2025-04-30T12:53:18.560+09:00 ERROR 3249 --- [springmvc] [nio-8080-exec-2] h.springmvc.basic.LogTestController      : error log=Spring
  • 올바른 로그 사용법
    • ❌ log.debug("data="+data)
       로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행이 되어 버린다. 
      결과적으로 의미 없는 문자 더하기 연산이 발생한다. 
    • ✅ log.debug("data={}", data) 
       로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 
      따라서 앞과 같은 의미없는 연산이 발생하지 않는다.
  • 로그 레벨 설정 
#전체 로그 레벨 설정 (디폴트: info)
logging.level.root=info 

#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug
  • LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
  • 로그 레벨에 따라 로그의 출력을 상황에 맞게 조절할 수 있다.
    예: 개발 서버는 debug 레벨부터, 운영 서버는 info 레벨부터 출력