Spring MDC를 사용해 식별가능한 로그 남기기

✅ Spring MDC를 사용해 식별가능한 로그 남기기

운영을 하다 보면 로그를 추적해서 확인해야 할때가 생기는데 여러 요청이 한꺼번에 들어오면 로그가 순서 없이 쌓여 확인하기 어려울때가 있습니다. 이럴때 요청당 유니크한 값을 주어 로그에 함께 출력함으로써 추적할수 있습니다.

MDC (Mapped Diagnostic Context)

- 멀티 쓰레드환경에서 현재 실행중인 쓰레드에 메타 정보를 넣고 관리하는 공간입니다. 내부적으로 Map으로 관리하고 있고 ThreadLocal에 키 값을 저장하여 Thread가 존재하는 동안 계속 사용할수 있게 합니다.

 

✅ MDC 필터에 구현하기

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class MDCLoggingFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        MDC.put("uuid", UUID.randomUUID().toString().replaceAll("-", ""));
        chain.doFilter(request, response);
        MDC.clear();
    }
}

MDC를 넣어줄만한곳은 필터나 인터셉터등이 있는데 가장 앞단인 필터에 적용하는것이 좋고 필터중에도 가장 앞단에 먼저 등록해준다.

Spring MVC는 쓰레드를 만들어 두었다가 요청이 들어오면 만들어둔 쓰레드를 가져와서 사용 처리후 반납한다. 따라서 쓰레드를 재사용하기 때문에 이전 데이터가 남아 있을수 있으므로 MDC.clear어 해줍니다.

 

logback 패턴

// Logback
%X{<키값>:-<Default>}]
[%X{uuid:-startup}] %d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%t] %-40.40logger{39} [%4L] : %m%n

단일서버내에서 사용을 하고 분산환경일 경우 spring-cloud-sleuth를 참고하세요

 

참고

- https://mangkyu.tistory.com/266

- https://055055.tistory.com/96