[Spring MVC] logging

logging

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

logging Library

SpringBoot Library를 사용하면 spring-boot-starter-logging이 함께 포함되며 기본으로 다음 로깅 라이브러리를 사용한다.

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

로그 라이브러리는 Logback, Log4J, Log4J2 등 많은 라이브러리가 있는데, 이들을 통합해서 인터페이스로 제공하는 것이 SLF4J 라이브러리다.
SLF4J는 인터페이스이고, 그 구현체로 Logback 같은 로그 라이브러리를 선택하면 된다.

로그 선언

• private Logger log = LoggerFactory.getLogger(getClass());
• private static final Logger log = LoggerFactory.getLogger(Xxx.class);
• @Slf4j: loombok 사용 가능

로그 호출

• log.info("hello")
• System.out.println("hello")

LogTestController

//@Slf4j
@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);

        return "ok";
    }
}

매핑 정보

• @RestController
  • @Controller는 반환 값이 String이면 view 이름으로 인식되어 view를 찾고 렌더링 한다.
  • @RestController는 반환 값으로 view를 찾는 것이 아닌, HTTP 메시지 바디에 바로 입력한다.
    따라서, 실행 결과로 ok 메시지를 받을 수 있는 것이다.

로그 레벨

• LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
• 개발 서버는 debug 출력
• 운영 서버는 info 출력

레벨 설정

application.properties

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

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

올바른 로그 사용법

• log.debug("data="+data)
  • 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 “data=”+data가 실제 실행이 되어 문자 더하기 연산이 발생한다.(출력은 X, 연산만)
• log.debug("data={}", data)
  • 로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 따라서, 앞과 같은 의미없는 연산이 발생X

로그 사용시 장점

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

<출처 : 인프런 - 스프링 MVC 1편 : 백엔드 웹 개발 핵심 기술(김영한)>