[SpringBoot] 로그

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

 

 

로깅 라이브러리

스프링 부트 프로젝트를 생성할 경우 스프링 부트 로깅 라이브러리(spring-boot-startr-logging)가 함께 포함되어 프로젝트가 생성된다.

 

 

스프링 부트 로깅 라이브러리

- SLF4J - http://www.slf4j.org 

- Logback - http://logback.qos.ch 

 

 

로그 라이브러리는 Logback, Log4J, Log4J2 등 수많은 라이브러리가 있는데 그것을 통합하여 인터페이스로 제공하는 것이 SLF4J 라이브러리.

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

실무에서는 스프링부트가 기본으로 제공하는 Logback을 대부분 사용한다.

 

 

로그 선언

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

클래스 윗 라인에 @Slf4j 어노테이션을 사용하여 위 코드를 생략 가능하다.

 

 

로그 호출

log.info("hello")

 

 

LogTestController

package hello.springmvc.basic;

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;

// @Controller를 사용하면 return 타입이 String이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 랜더링 된다.
// @RestController를 사용하면 그냥 String을 반환.
@Slf4j
@RestController
public class LogTestController {
    // @Slf4j를 사용하면 Logger객체 생성하지 않고 로그 사용가능.
    // private final Logger log = LoggerFactory.getLogger(getClass());
    @RequestMapping("/log-test")
    public String logTest() {
        String name = "spring";

        System.out.println("name = " + name);
        log.info("info log={} ", name);
        // 2023-03-26 14:30:25.433  INFO 19748 --- [nio-8080-exec-1] hello.springmvc.basic.LogTestController  : info log=spring
        // 날짜, 시간, 로그레벨, 패키지명, 클래스명, 컨트롤러명과 같은 여러 정보 출력

        System.out.println("==========================");
        System.out.println("==========================");
        System.out.println("==========================");

        // 다양한 로그 유형레벨 존재. 순위대로 나열.
        // application.properties 에 지정.
        // 지정한 레벨부터 ~ 하위 레벨의 로그유형 보여짐(상위레벨은 x)
        // 운영 서버는 보통 info 많이 사용
        // 개발 서버는 debug 많이 사용


        // 로그를 사용할 때는 trace log={} 형태로 사용해야 한다.
        // 만약 하위레벨로 설정하고 상위레벨의 로그를 사용했을 때
        // 위의 형태로 사용하면 아예 연산이 안이루어지지만
        // "trace log=" 이런식으로 호출하게 되면
        // 연산은 이루어지고 출력은 안하게 되어 트래픽이 증가한다.
        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";
    }


}

실행

http://localhost:8080/log-test

 

 

매핑 정보

@RestController

- @Controller는 반환타입이 String이면 뷰 이름으로 인식하여 뷰를 찾고 뷰가 렌더링 된다.

- @RestController는 반환 값으로 뷰를 찾지 않고, HTTP 메시지 바디에 바로 입력하므로 실행 결과로 ok 메시지를 받을 수 있다.

 

 

로그 레벨

- TRACE > DEBUG > INFO > WARN > ERROR

- 개발 서버는 DEBUG, 운영 서버는 INFO level 많이 사용

 

 

로그 레벨 설정

applicaion.properties

 

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

#hello.springmvc 프로젝트와 하위의 로그레벨 설정
#TRACE > DEBUG > INFO > WARN > ERROR > FATAL
logging.level.hello.springmvc=trace

 

 

올바른 로그 사용법

하위 로그 레벨로 설정 후 상위 로그를 호출할 경우

- log.debug("data="+data)

  - 로그 레벨을 info로 설정하여도 해당 코드에 있는 "data="+data 문자 더하기 연산이 발생한다.

- log.debug("data={}", data)

  - 로그 레벨을 info로 설정하면 의미없는 연산이 발생하지 않는다.

 

두 방법 모두 로그 출력은 되지 않지만 첫 번째 방법은 연산이 일어나므로 트래픽이 발생한다.

 

 

로그 사용시 장점

- 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.

- 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.

- 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.

  특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.

- 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등) 그래서 실무에서는 꼭 로그를 사용해야 한다