로깅

본 시리즈는 인프런 학습 사이트의 김영한 강사님의 java spring mvc - 백엔드 웹 개발 핵심 기술 편을 학습한 내용을 바탕으로 정리하였습니다.

개발을 해봤다면 어느 누구든 한번쯤은 사용해본 프린트문 System.out.println()

사실 우리가 만든 프로그램이 잘 동작하는지 궁금해서 사용했겠지만 이는 간단한 로깅의 일종이다.

운영 중인 웹 어플리케이션이 문제가 발생했을 때, 문제의 원인을 파악하기 위해서는 당시의 정보가 필요하다. 이런 정보를 얻기 위해선 Exception이 발생했거나, 중요 기능이 실행되는 부분에서는 적절한 로그를 남겨야만 한다. 더군다나 중요한 서비스 로직들이 돌아가는 실무에서는 로깅이 거의 필수적이기 때문에 로그를 작성하는 것을 습관화하는 것이 좋다.

📌 로깅이란?
정보를 제공하는 일련의 기록인 로그(log) 를 생성하도록 시스템을 작성하는 활동.
출처: https://codingnotes.tistory.com/71 [코딩수첩:티스토리]

로깅 라이브러리

로그를 사용하는 방법에는 System.out.println() 와 같은 시스템 콘솔을 이용하는 방법도 있겠지만 일반적으로 로깅 라이브러리를 사용한다. 스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리 (spring-boot-starter-logging)가 함께 포함된다.

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

• SLF4J - http://www.slf4j.org
• Logback - http://logback.qos.ch

로그 라이브러리는 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")

로그 테스트 코드

LogTestController

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

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

			// 로그를 사용하지 않아도 a+b 계산 로직이 먼저 실행됨, 이런 방식으로 사용하면 X
			log.debug("String concat log=" + name);
			return "ok";
	}
}

테스트 내용

• 로그가 출력되는 포맷
  : 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지
  
  
• 로그 레벨 설정
  • LEVEL : TRACE > DEBUG > INFO > WARN > ERROR
    (오른쪽으로 갈수록 레벨이 높음)
  • 개발 서버는 debug 출력
  • 운영 서버는 info 출력

로그에는 레벨(단계)이 있다. 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 필요한 정보만 출력하는 등 로그를 상황에 맞게 조절해 사용할 수 있다.

예를 들어, org.springframework 로 시작하는 패키지에 속한 클래스에서 출력하는 로그는 info 이상 레벨(info, warn, error)로 출력하고,
kr.or.connect 로 시작하는 패키지에 속한 클래스에서 출력하는 로그는 debug 이상 레벨로 출력하라는 식이다.
보통 개발 서버는 debug 레벨로, 운영 서버는 info 레벨로 로깅하는 편이다.

(출처: https://codingnotes.tistory.com/72 [코딩수첩:티스토리])

로그 레벨은 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)
  : 따라서 위와 같이 SLF4J의 치환문자({ }) 를 사용하여 로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 앞과 같은 의미없는 연산이 발생하지 않는 것이다.

📙 정리

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