Spring boot - 로깅 [ 스프링 로그남기기 ]

 

 

 

스프링 부트를 사용하면 로그 라이브러리가 자동적으로 추가된다.

 

로그 라이브러리는 종류가 많은데 그것을 통합적으로 인터페이스로 제공하는 것이 SLF4J 라이브러리이다.

실무에서는 Logback을 대부분 사용한다.

 

 

💬 로그 선언 방법

// 1번 방법
private Logger log = LoggerFactory.getLogger(getClass());
// 2번 방법
private static final Logger log = LoggerFactory.getLogger(Xxx.class);
//3번 방법 애노테이션 사용(lombok이 제공)
@Slf4j

 

✍ 첫번째 두 번째 로그 선언 방법을 사용할 경우

로그는 slf4j라이브러리를 사용해야한다.

 

 

 

📝 로그 사용 방법

@Slf4j // lombok이 제공하는 기능 (= private final Logger log = LoggerFactory.getLogger(getClass()); )
@RestController
public class LogTestController {

    @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";
    }
}

 

 

1. @RestController

@Controller 대신에 @RestController를 대신 사용하는 이유가 있다.

👉 @Controller는 반환 값이 String이면 view이름으로 알고 view를 반환하고 렌더링 한다.

👉 @RestController는 반환 값이 String이어도 그냥 String이 반환된다. 따라서 위의 예시처럼 return "ok"; 라고 입력해도 화면에 ok라고 표시된다.

 

 

2. 로그 레벨

ERROR

WARN

INFO

DEBUG

TRACE

로그 레벨은 TRACE > DEBUG > INFO > WARN > ERROR이다.

 

 

 

3. 로그 포맷 확인

👉 2021-08-12 21:52:18.003  : 시간

👉 INFO : 로그 레벨

👉  21200 : 프로세스 ID

👉  [nio-8080-exec-1] : 쓰레드 정보

👉  hello.springmvc.basic.LogTestController  : 컨트롤러 이름, 클래스 이름

👉  info log=Spring : 메시지

 

 

 

4. 로그 레벨 설정

로그 레벨은 기본적으로 info로 설정되어있다. 

따라서 따로 로그 레벨을 설정하지 않는다면 info, warn, error만 콘솔 창에 출력된다.

 

로그 레벨 범위를 조정하고 싶다면 application.properties파일에 들어가서 따로 코드를 입력해야 한다.

 

◾ 전체 로그 레벨 설정

logging.level.root=(trace or debug or info or warn or error)

 

◾ 모든 로그를 보고 싶을 때

logging.level.[Group명.Artifact명]=trace
// 내가 사용한 코드
logging.level.hello.spingmvc=trace

 

◾ DEBUG 밑으로 모두 보고 싶을 때

logging.level.[Group명.Artifact명]=debug

이렇게 하면 debug를 포함한 하위 레벨의 로그가 모두 출력된다. (debug, info, warn, error)

 

 

⭐ 개발 서버에서는 debug로, 운영 서버에서는 info 설정을 기본으로 권장한다.

 

 

 

✍ 주의해야 할 점

 

➖

로그를 System.out.println();으로 남기면 절대 안 된다.

이렇게 되면 경우에 상관없이 매번 출력이 이루어지기 때문에 낭비가 심하다.

 

➖

log.trace("trace log=" + name); 이랑 log.trace("trace log={}", name); 은 같은 값이 출력된다.

하지만, log.trace("trace log={}", name); 의 방법을 사용해야 한다!!!

만약 로그 레벨의 범위를 debug로 설정했을 경우에 trace는 필요하지 않다. 하지만 자바에서는 + 연산을    먼저 하게 설정되어있다. 따라서 log.trace("trace log=" + name); 이 방법을 사용하게 될 경우에는, trace를 사용하지 않음에도 불구하고 연산을 하는 경우가 발생하기 때문에 쓸모없는 리소스 낭비가 일어난다. 따라서 오른쪽 같은 방식을 사용해야 한다.

오른쪽 방식은 그냥 메서드 방식이기 때문에 연산을 하지 않는다.

 

 

 

👍 로그 사용 장점

• 쓰레드 정보, 클래스 이름 같은 부가 정보를 볼 수 있고, 출력 모양을 조정할 수 있다.
• 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 로그 등 상황에 맞게 조절할 수 있다.
• 콘솔에만 출력하는 것이 아니라, 로그를 별도의 위치에 남길 수 있다. 
• System.out 보다 성능이 훨씬 좋다.

 

 

---

잘못된 내용이 있다면 댓글에 남겨주세요!

 

➕ 스프링 부트에서 제공하는 로그 기능

 

이 포스팅은 인프런 김영한님의 [스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술]을 듣고 작성된 복습 포스팅입니다.