[Spring] 로깅 (Slf4j / Logback)

 

 

로그(log)

• 운영 중인 웹 애플리케이션이 문제가 발생했을 경우, 문제의 원인을 파악하려면 문제가 발생했을 때 당시의 정보가 필요하다. 이런 정보를 얻기 위해 중요 기능이 실행되는 부분에서 적절한 로그를 남겨야 한다.
• 프로그램 개발이나 운영시 발생하는 문제점을 추적하거나 운영 상태의 모니터링 정보의 기록을 의미한다.
• 기록 데이터를 분석하여 다양한 통계에 사용할 수 있다.
• 운영 시스템에서는 'System.out.println()' 같은 시스템 콘솔을 출력하지 않고 별도의 로깅 라이브러리를 사용하여 로그로 남긴다.
• 실무에서는 무조건 로그를 사용해야 한다.

 

🔍 로그 사용시 장점

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

 

---

 

로깅 라이브러리

 

• 스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 포함된다.
• 로그 라이브러리는 Logback, Log4J, Log4J2 등등 많은 라이브러리가 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 Slf4j 라이브러리다.
• 쉽게 말해, Slf4j는 인터페이스이고, 그 구현체로 Logback 같은 로그 라이브러리를 사용하면 된다.
• 실무에서는 수프링 부트가 기본으로 제공하는 Logback을 많이 사용한다.

 

 

🔍 로그 선언

/* ex.1 */
private Logger log = LoggerFactory.getLogger(getClass());


/* ex.2 */
private static final Logger log = LoggerFactory.getLogger(Xxx.class)


/* ex.3 Lombok 사용*/
@Slf4j

• 3가지 방법 중 하나를 선택하면 된다.

 

📌 로그 사용 예제

package hello.springmvc.basic;

import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

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

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

        // 운영서버(배포)에는 info, 개발서버에는 debug, 로컬 pc에서는 trac 또는 debug
        log.trace("info log = {}", name);
        log.debug("info log = {}", name);  // 현재 로그는 디버그할 때 보는 것 (개발 서버에서 보는 것)
        log.info("info log = {}", name);  // 현재 로그는 중요한 정보다. (비즈니스 정보라던지 운영 시스템에서 봐야할 정보)
        log.warn("info log = {}", name);  // 경고
        log.error("info log = {}", name);  // 에러

        return "ok";
    }
}

• @RestController
  • @Controller 애노테이션을 사용하고 메서드의 반환 타입이 String 타입이면 뷰 이름으로 인식 된다., 그러면 뷰를 찾고 뷰가 렌더링 된다.
  • @RestController 애노테이션은 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.
  • 따라서 실행 결과로 리턴값인 "ok" 메시지를 받을 수 있다. 
  • 이것은 @ResponseBody 애노테이션과 관련이 있다.
• 로그 사용방법
  • log.debug("data={}", data)

 

 

🔍 로그 레벨 설정

• 로그가 출력되는 포멧 확인
  • 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스 명, 로그 메시지
• 로그 레벨 
  • trace > debug > info > warn > error
    • info로 지정시 info / warn / error 모두 출력
    • debug로 지정시 debug / info / warn / error 모두 출력
  • 개발 서버는 debug 레벨로 출력
  • 운영 서버는 info 레벨로 출력
  • 로그 레벨설정은 application.properties에서 가능하다.
• 로그 레벨 종류
  • error : 요청을 처리하는 중 문제가 발생한 오류 정보
  • warn : 오류는 아니지만 잠재적인 오류 원인이 될 수 있는 경고성 정보
  • info : 진행상황 같은 일반 정보
  • debug : 디버깅하는데 유용한 세분화된 정보
  • trace : debug보다 더 상세한 정보

 

 

 

📌 application.properties

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


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

 

 

 

 

---

👀 참고 자료

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

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

 

https://velog.io/@neity16/6-%EC%8A%A4%ED%94%84%EB%A7%81-MVC-7-%EB%A1%9C%EA%B9%85Slf4j-Logback

[6] 스프링 MVC (7) - 로깅(Slf4j / Logback)

 

https://ahndding.tistory.com/12

[Log] 로깅의 개념과 다양한 로그 라이브러리, 그리고 주의사항