로깅 (SLF4J, Logback)

1. 개념 👮‍♂️

  스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리가 함께 포함된다.

├─ springmvc
│ └─ Dependencies
│     └─ org.springframework.boot:spring-boot-starter-thymeleaf
│        └─ org.springframework.boot:spring-boot-starter
│           └─ org.springframework.boot:spring-boot-starter-logging
│              └─ ch.qos.logback:logback-classic
│              └─ org.apache.logging.log4j:log4j-toslf4j
│              └─ org.slf4j:jul-to-slf4j

  기본적으로 SLF4J와 Logback 라이브러리를 사용한다. 간단하게 이해하면 SLF4J는 인터페이스이고, 그 구현체 중 하나로 Logback을 사용하는 것이다.

 

2. 사용법 💂‍♂️

  기본적인 사용법은 아래와 같다. 이때 import를 주의해서 하도록 하자.

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

@RestController
public class LogTestController {

    private final Logger log = LoggerFactory.getLogger(getClass());

    @RequestMapping("/log-test")
    public String logTest(){
        String name = "amenable";

        log.info("info log={}", name);

        return "ok";
    }
}

  롬복에서 제공하는 @Slf4j를 사용한다면 아래와 같이 간단하게 사용할 수 있다.

@Slf4j
@RestController
public class LogTestController {

    @RequestMapping("/log-test")
    public String logTest(){
        String name = "amenable";

        log.info("info log={}", name);

        return "ok";
    }
}

  로그는 다음과 같은 형식으로 출력된다.

// 형식
시간 | 로그레벨 | 프로세스ID | 스레드 명 | 클래스명 | 로그 메시지

// 실제 출력 값
2023-04-09T09:38:12.671+09:00 INFO 4644 --- [nio-8080-exec-1] h.springmvc.basic.LogTestController : info log=amenable

 

3. 로그 레벨 🕵️‍♂️

  로그 레벨에는 5가지가 있다.

TRACE - DEBUG - INFO - WARN - ERROR

  기본적으로는 INFO 레벨부터(INFO - WARN - ERROR) 로그를 찍게 되어있다.

# 파일 : application.properties
# 전체 로그 레벨 설정(기본 값)
logging.level.root=info

@Slf4j
@RestController
public class LogTestController {

    @RequestMapping("/log-test")
    public String logTest(){
        String name = "amenable";

        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";
    }
}

2023-04-09T09:42:49.545+09:00 INFO 15304 --- [nio-8080-exec-1] h.springmvc.basic.LogTestController : info log=amenable
2023-04-09T09:42:49.546+09:00 WARN 15304 --- [nio-8080-exec-1] h.springmvc.basic.LogTestController : warn log=amenable
2023-04-09T09:42:49.546+09:00 ERROR 15304 --- [nio-8080-exec-1] h.springmvc.basic.LogTestController : error log=amenable

  하지만 로그 레벨을 설정하여 원하는 로그레벨부터 볼 수 있다. 예를 들어, 로그 레벨을 TRACE와 ERROR로 바꾼다면 아래와 같은 결과를 얻게 된다.

  전체 로그 설정을 바꾸는 게 아니라 패키지의 로그 레벨을 설정하도록 하자. 로그 출력은 간단하게 '로그 레벨'과 '로그 메시지'만 적겠다.

로그 레벨이 TRACE인 경우

# 파일 : application.properties
# 전체 로그 레벨(기본 값)
logging.level.root=info
# 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=trace;

@Slf4j
@RestController
public class LogTestController {

    @RequestMapping("/log-test")
    public String logTest(){
        String name = "amenable";

        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";
    }
}

TRACE : trace log=amenable
DEBUG : debug log=amenable
INFO : info log=amenable
WARN : warn log=amenable
ERROR : error log=amenable

로그 레벨이 ERROR인 경우

# 파일 : application.properties
# 전체 로그 레벨(기본 값)
logging.level.root=info
# 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=error;

ERROR : error log=amenable

 

일반적으로 개발 서버에서는 debug로 설정하고 운영 서버에서는 info를 출력한다.

 

4. 올바른 로그 사용법 👨‍⚖️

@Slf4j
@RestController
public class LogTestController {

    @RequestMapping("/log-test")
    public String logTest(){
        String name = "amenable";

        // 올바르지 않은 로그 사용법
        log.info("info log="+name);
        // 올바른 로그 사용법
        log.info("info log={}", name);

        return "ok";
    }
}

올바르지 않은 로그 사용법

  log.debug("data="+data)를 사용한다면 다음과 같은 절차를 거치면서 로그가 출력된다.

1. log.debug("data="+"spring")
2. log.debug("data=spring")
3. 로그 레벨을 확인 후 출력

올바른 로그 사용법

  log.debug("data={}", data)를 사용하게 된다면 다음과 같은 절차를 거친다.

1. 로그 레벨을 확인 후 출력

  만약 로그 레벨이 INFO였다면 '올바르지 않은 로그 사용법'에서는 불필요한 연산이 진행된다.

그러므로 '올바른 로그 사용법'을 이용하여 로그를 사용하도록 하자.

 

5. 로그를 사용해야 하는 이유 👨‍🔬

  지금까지 살펴봤던 내용과 함께 로그를 사용해야 하는 이유는 다음과 같다.

• 쓰레드 정보, 클래스 이름과 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
• 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영 서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.
• 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다. 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
• 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등) 

 

해당 글은 김영한 님의 '스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술'을 참고하였습니다.