스프링 MVC - 1편 - 스프링 MVC 기본 기능 - (2) 로깅 간단히 알아보기

인프런 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술편을 학습하고 정리한 내용 입니다.

앞으로 이 강의에서는 로그를 사용할 것이기 때문에, 이번엔 로그에 대해서 간단히 알아보자.

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

로깅 라이브러리

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

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

• SLF4J (인터페이스) - http://www.slf4j.org
• Logback (구현체) - http://logback.qos.ch

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

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

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

1. private final Logger log = LoggerFactory.getLogger(getClass());
2. private final Logger log = LoggerFactory.getLogger(클래스명.class);

이 2가지 방법 중 편한 걸 사용하면 된다.

@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.info(" info log={}", name);  
  
        return "ok";  
    }  
}

이렇게 System.out.println("name = " + name);, log.info(" info log={}", name); 두 갤 비교 하자.

다음과 같이 h.springmvc.basic.LogTestController로그에선 이런 식으로 위치도 나온다.

그리고 또 로그의 장점은 레벨을 설정할 수 있다는 거다.

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

다음과 같이 레벨에 따라 출력이 가능하다. 지금은 INFO 부터 로그에 남기도록 해놨다.

이 설정은

다음과 같이 application.properties나 yml 파일을 설정해 주면 된다.

로그 정보

• 로그가 출력되는 포멧 확인
  • 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지
• 로그 레벨 설정을 변경해서 출력 결과를 보자.
  • LEVEL : TRACE > DEBUG > INFO > WARN > ERROR
  • 개발 서버는 debug 출력
  • 운영 서버는 info 출력
• 롬복 사용 시 @Slf4j로 컨트롤러에 어노테이션 붙힘.

올바른 로그 사용법

• log.debug("data="+data)
  • 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행이 되어 버린다. 결과적으로 문자 더하기 연산이 발생한다.
• log.debug("data={}", data)
  • 로그 출력 레벨을 info로 설정하면 아무 일도 발생하지 않는다. 따라서 위와 같은 쓸데없는 연산이 발생하지 않는다.

로그 사용 시 장점

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

추가 정보

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