[SpringBoot] 로깅 간단히 알아보기

목차

 

로깅

운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고, 별도의 로깅 라이브러리를 사용해서 로그를 출력합니다. 

여기서는 최소한의 사용 방법만을 알아봅니다.

 

로깅 라이브러리

스프링부트 라이브러리를 사용하면, 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 함께 포함됩니다.

스프링 부트 로깅 라이브러리는 기본적으로 다음 로깅 라이브러리를 사용합니다.

• SLF4J - https://www.slf4j.org/
• Logback - https://logback.qos.ch/

 

SLF4J는 인터페이스입니다. 그 구현체로 Logback같은 로그 라이브러리를 선택하면 됩니다.

로그 라이브러리는 Logback, Log4J, Log4J2 등 수 많은 라이브러리들이 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 SLF4J입니다.

실무에서는 스프링 부트가 제공하는 Logback을 대부분 사용합니다.

 

 

로그 선언

private Logger log = LoggerFactory.getLogger(getClass());    //org.slf4j 패키지

private static final Logger log = LoggerFactory.getLogger(Xxx.class);

@Slf4j   //위의 코드를 자동으로 생성하여 로그를 선언해줍니다. 개발자는 편리하게 log 라고 사용하면 됩니다.

 

로그 호출

log.info("hello")     //System.out.println("hello") 와 동일

 

 

로그 레벨

아래로 내려갈수록 좁은 범위입니다. 

• log.trace
• log.debug : 디버그 모드 (개발 서버에서 사용)
• log.info : 운영시스템에서 사용
• log.warn : 경고 확인
• log.error : 급한 에러 확인

 

LogTestController

package hello.springmvc.basic;
import org.slf4j.Logger;
...

@RestController
public class LogTestController {

    private final Logger log = LoggerFactory.getLogger(getClass());  //현재 클래스 지정

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

        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);

        //로그를 사용하지 않아도 a+b 계산 로직이 먼저 실행됨, 이런 방식으로 사용하면 X
        log.debug("String concat log=" + name);
        return "ok";
    }
}

출력 결과

2023-08-19 22:10:40.596 INFO 2288 --- [nio-8080-exec-2] hello.springmvc.basic.LogTestController : info log=Spring

 

포맷

시간, 로그 레벨(INFO), 프로세스 ID (2288), 쓰레드명(nio-8080-exec-2), 클래스명(LogtestController), 로그 메시지(info log=Spring)

 

 

로그 레벨 변경

로그 레벨 설정을 변경해서 출력 결과를 봅시다.

• LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
• 개발 서버는 debug 모드로 설정해서 출력합니다. (trace 로그는 포함하지 않습니다.)
• 운영 서버는 info 모드로 설정해서 출력합니다. (trace 로그와 debug 로그를 포함하지 않습니다. 따라서 운영 서버에 필요한 정보만을 남길 수 있습니다.)
• 하지만 System.out.println()은 어떤 레벨이든 모두 무분별하게 찍으므로 사용하면 안 됩니다. 

 

application.properties

#전체 로그 레벨 설정(기본 info)
logging.level.root=info

#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=trace

 

 

올바른 로그 사용법

 //로그를 사용하지 않아도 a+b 계산 로직이 먼저 실행됨, 이런 방식으로 사용하면 X
log.debug("data=" + data);

• 이렇게 작성하면, 로그 레벨을 info로 설정해서 debug는 사용하지 않아도 해당 코드 안에 있는 + 연산이 실행되므로 쓸모없는 연산이 발생합니다.

 

log.debug(”data={}”, data)

• {}을 사용해 작성하면 앞과 같이 의미없는 연산이 발생하지 않습니다.

 

로그 사용 시 장점

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

따라서 실무에서는 꼭 로그를 사용해야 합니다.

 

 

더 공부하실 분

• 로그에 대해서 더 자세한 내용은 SLF4J, logback을 검색해봅시다.
  • SLF4J - https://www.slf4j.org/
  • Logback - https://www.slf4j.org/
• 스프링 부트가 제공하는 로그 기능은 다음을 참고할 수 있습니다.
  • https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.logging

 

---

출처

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의