[Spring] 로깅(logging)

운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고,
별도의 로깅 라이브러리를 사용해서 로그를 출력한다.
참고로 로그 관련 라이브러리도 많고, 깊게 들어가면 끝이 없기 때문에, 최소한으로만 알아본다.
 
로깅 라이브러리
스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 함께 포함된다.
스프링 부트 로깅 라이브러리는 기본으로 다음 로깅 라이브러리를 사용한다.
(1) SLF4J - http://www.slf4j.org 

SLF4J

(2) Logback - http://logback.qos.ch 

Logback Home

 
로그 라이브러리는 Logback, Log4J, Log4J2 등등 수 많은 라이브러리가 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 바로 SLF4J 라이브러리다.
 
쉽게 얘기해서 SLF4J는 인터페이스이고, 그 구현체로  Logback 같은 로그 라이브러리를 선택하면 된다.
실무에서는 스프링 부트가 기본으로 제공하는 Logback을 대부분 사용한다.
 
로그 선언
(1)

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

(2) 

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

(3)

@Slf4j // 롬복 사용 가능

 
로그 호출

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

시스템 콘솔로 직접 출력하는 것보다 로그를 사용하면 다음과 같은 장점이 있다.
실무에서는 항상 로그를 사용해야 한다.
 
LogTestController.java

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;

@Slf4j
@RestController
public class LogTestController {
//    private final Logger log = LoggerFactory.getLogger(getClass());

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

        System.out.println("name = " + name);
        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 메시지를 받을 수 있다. @ResponseBody와 관련이 있다.
 
테스트
로그가 출력되는 포멧 확인
  : 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지
로그 레벨 설정을 변경해서 출력 결과를 보자.
  : LEVEL : (1) TRACE 
                  (2) DEBUG
                  (3) INFO
                  (4) WARN
                  (5) ERROR
  : 개발 서버는 debug로 출력
  : 운영 서버는 info로 출력
@Slf4j 로 변경
 
로그 레벨 설정
application.properties

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

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

 
올바른 로그 사용법
- log.debug("data="+data)
   : 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data =" + data  가 실제 실행되어버린다.
     결과적으로 문자 더하기 연산이 발생한다.
 - log.debug("data = {}", data)
   : 로그 출력 레벨을 info.로 설정하면 아무 일도 발생하지 않는다. 따라서 앞과 같은 의미 없는 연산이 발생하지 않는다.
 
로그 사용 시 장점
 : 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
 : 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등
   로그를 상황에 맞게 조절할 수 있다.
 : 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.
   특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
 : 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등)  그래서 실무에서는 꼭 로그를 사용해야 한다.
 
※ 참고
SLF4J - http://www.slf4j.org
Logback - http://logback.qos.ch

Logback Home

스프링 부트가 제공하는 로그 기능은 다음을 참고하자.
https://docs.spring.io/spring-boot/docs/current/reference/html/spring-bootfeatures.html#boot-features-logging