4xx, 5xx 에러 로그 남기기

현재 회사는 모듈들이 다 나눠져 있습니다. 그리고 현재 제가 맡은 모듈은 다른 모듈과 통신할 때 HTTP 통신을 사용하고 있죠.

그러다보니 RestClient를 사용해 HTTP 통신을 하면서 4xx, 5xx 에러 로그를 남기고 싶었습니다.

로그를 남기지 않으니 문제를 파악하기가 너무 어렵더라구요.

RestClientHttpClient

실제 HTTP 요청을 수행하는 클라이언트 구현체입니다.

@Slf4j
@Component
@RequiredArgsConstructor
public class RestClientHttpClient implements HttpClient {

    private final RestClient restClient;
    private final RestClientErrorHandler errorHandler;
    private final RestClientExceptionHandler exceptionHandler;

    @Override
    public <T> T post(String url, Object request, Class<T> responseType, UUID transactionId) {
        return exceptionHandler.executeWithExceptionHandling(
                () -> restClient.post()
                        .uri(url)
                        .body(request)
                        .retrieve()
                        .onStatus(HttpStatusCode::isError, errorHandler.createErrorHandler(transactionId))
                        .body(responseType),
                transactionId
        );
    }
}

1. UUID transactionId
   • 현재 모듈의 API를 타게 되면 각 요청을 구분하기 위해 UUID를 만듭니다. 즉, 구분하기 위한 용도의 값입니다.

RestClientExceptionHandler

RestClient 호출 시 발생하는 네트워크 레벨 예외를 처리합니다.

@Slf4j
@Component
public class RestClientExceptionHandler {

    public <T> T executeWithExceptionHandling(Supplier<T> apiCall, UUID transactionId) {
        try {
            return apiCall.get();
        } catch (ResourceAccessException e) {
            return handleNetworkError(e, transactionId);
        } catch (RestClientException e) {
            return handleRestClientError(e, transactionId);
        }
    }

    private <T> T handleNetworkError(ResourceAccessException e, UUID transactionId) {
        LOGGER.info("[{}] Network error: {}", transactionId, e.getMessage(), e);
        throw new BaseBusinessException(
                MessageSourceUtil.getMessage(
                        "conductor-service.workflow.http.network-error",
                        new Object[]{transactionId}
                )
        );
    }

    private <T> T handleRestClientError(RestClientException e, UUID transactionId) {
        LOGGER.info("[{}] RestClient error: {}", transactionId, e.getMessage(), e);
        throw new BaseBusinessException(
                MessageSourceUtil.getMessage(
                        "conductor-service.workflow.http.client-error",
                        new Object[]{transactionId}
                )
        );
    }

}

1. Supplier
   • Supplier 패턴을 사용하여 실제 API 호출 로직을 감쌉니다
2. ResourceAccessException
   • 네트워크 연결 실패, 타임아웃 등의 물리적 연결 문제
   • 예: 서버가 응답하지 않음, DNS 실패, 소켓 타임아웃
3. RestClientException
   • RestClient 사용 중 발생하는 일반적인 클라이언트 예외
   • 위의 ResourceAccessException을 제외한 RestClient 관련 예외
4. BaseBusinessException
   • 사내에서 공통으로 사용하는 커스텀 예외입니다. message.properties에서 정의한 오류 메시지를 사용합니다.
   • 크게 중요하진 않으니 그냥 넘어갑시다.