로그 사용법

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

로그를 사용할 수 있게끔, 사용 방법만 간단히 알아보자!

 

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

 

---

• 로그 선언
  • private Logger log = LoggerFactory.getLogger(getClass());
  • private static final Logger log = LoggerFactory.getLogger(Xxx.class)
  • @Slf4j (롬복 사용 가능)

• 로그 호출
  • log.info("hello")
  • System.out.println("hello")

---

@RestController     //HTTP 메시지 바디에 바로 입력
public class LogTestController {

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

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

        //로그 레벨: TRACE > DEBUG > INFO > WARN > ERROR
        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";
    }

}

로그가 5개중 3개만 출력되었다

• 로그가 출력되는 포멧
  • 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지

 

---

• application.properties에서 로그 레벨 설정

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

#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug
#개발 서버는 debug, 운영 서버는 info 출력

 

• LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
  • 로그레벨을 debug로 설정하면 debug부터 4개만 출력. error로 설정하면 error 1개만 출력

---

• application.properties

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

로그가 trace부터 5개 모두 출력되었다!

 

---

• @Slf4j

@Slf4j
@RestController     //HTTP 메시지 바디에 바로 입력
public class LogTestController {

    //private final Logger log= LoggerFactory.getLogger(getClass());
    //@Slf4j 가 자동으로 넣어줌

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

        //로그 레벨: TRACE > DEBUG > INFO > WARN > ERROR
        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);

        //log.debug("debug my log=" + name);   이런 방식으로 사용하면 안됨!!
        //로그를 사용하지 않아도(로그 출력 레벨이 info여도) 더하기 연산(의미없는 연산)이 발생

        return "ok";
    }

}

• @Slf4j는 다음 코드를 자동으로 생성해서 로그를 선언해준다. 개발자는 편리하게 log 라고 사용하면 된다.

private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class);

 

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

 

---

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

→ 그래서 실무에서는 꼭 로그를 사용해야 한다.

 

---

---

• 로그에 대해서 더 자세한 내용은 slf4j, logback 검색
• SLF4J - http://www.slf4j.org

SLF4J

• Logback - http://logback.qos.ch

Logback Home

 

 

• 스프링 부트가 제공하는 로그 기능

https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#boot-features-logging

Core Features