Spring Boot 3.4를 사용하여 사용자 정의 헤더에서 추적을 전파하는 방법

Spring Boot 3.4에서 사용자 정의 추적 헤더 전파

백엔드 처리를 위해 Spring Boot 3.4 및 Micrometer와 함께 Java 사용

// Solution 1: Extract and Propagate Custom Trace Headers Manually
// Import necessary Spring Boot and Micrometer libraries
import org.slf4j.MDC;
import org.springframework.http.HttpHeaders;
import org.springframework.web.filter.OncePerRequestFilter;
import javax.servlet.FilterChain;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class CustomTraceFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws IOException {
        String traceId = request.getHeader("ot-custom-traceid");
        String spanId = request.getHeader("ot-custom-spanid");
        try {
            if (traceId != null) {
                MDC.put("traceId", traceId); // Add traceId to Mapped Diagnostic Context
            }
            if (spanId != null) {
                MDC.put("spanId", spanId);
            }
            filterChain.doFilter(request, response); // Continue request processing
        } finally {
            MDC.clear(); // Ensure MDC is cleared after processing
        }
    }
}

// Register the filter in your configuration class
@Configuration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean<CustomTraceFilter> traceFilter() {
        FilterRegistrationBean<CustomTraceFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new CustomTraceFilter());
        registrationBean.addUrlPatterns("/*");
        return registrationBean;
    }
}

사용자 정의 추적 헤더 전파를 위한 단위 테스트

추적 헤더 전파를 검증하기 위해 JUnit 및 MockMvc를 사용한 테스트

// Import necessary libraries
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest
public class CustomTraceFilterTest {
    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testCustomTraceHeaders() throws Exception {
        mockMvc.perform(get("/test-endpoint")
                .header("ot-custom-traceid", "12345")
                .header("ot-custom-spanid", "67890"))
                .andExpect(status().isOk());
    }
}

RestTemplate을 사용하여 HTTP 요청에 사용자 정의 헤더 전파

RestTemplate 인터셉터를 사용하여 나가는 요청에 사용자 정의 헤더 추가

// Import necessary libraries
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpRequest;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.web.client.RestTemplate;
import java.io.IOException;

public class CustomHeaderInterceptor implements ClientHttpRequestInterceptor {
    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        HttpHeaders headers = request.getHeaders();
        headers.add("ot-custom-traceid", "12345");
        headers.add("ot-custom-spanid", "67890");
        return execution.execute(request, body);
    }
}

// Register the interceptor with RestTemplate
@Configuration
public class RestTemplateConfig {
    @Bean
    public RestTemplate restTemplate() {
        RestTemplate restTemplate = new RestTemplate();
        restTemplate.getInterceptors().add(new CustomHeaderInterceptor());
        return restTemplate;
    }
}

Spring Boot에서 사용자 정의 추적 전파에 대해 자주 묻는 질문

1. Spring Boot에서 사용자 정의 추적 헤더를 수동으로 추출하려면 어떻게 해야 합니까?
2. request.getHeader("custom-header")를 사용하여 특정 헤더를 수동으로 가져오고 MDC.put("traceId", value)를 사용하여 MDC에 추가할 수 있습니다.
3. 사용자 지정 추적 전파에 OpenTelemetry를 사용하면 어떤 이점이 있나요?
4. OpenTelemetry는 마이크로서비스 전반에 걸쳐 사용자 지정 헤더를 포함한 추적을 전파하는 공급업체 중립적인 최신 접근 방식을 제공합니다.
5. Spring Boot에서 RestTemplate을 사용하여 사용자 정의 헤더를 전파할 수 있나요?
6. 예, ClientHttpRequestInterceptor를 구현하면 traceid 및 spanid와 같은 사용자 정의 헤더를 나가는 요청에 연결할 수 있습니다.
7. 헤더를 전체적으로 캡처하려면 필터를 어떻게 등록합니까?
8. OncePerRequestFilter를 확장하는 필터를 생성하고 FilterRegistrationBean을 사용하여 이를 등록하여 모든 엔드포인트에 대한 헤더를 캡처할 수 있습니다.
9. Spring Boot의 추적을 시각화하는 데 어떤 도구를 사용할 수 있나요?
10. Zipkin, Jaeger, Prometheus와 같은 도구는 Spring Boot 및 OpenTelemetry와 통합되어 엔드투엔드 추적을 시각화할 수 있습니다.

원활한 추적 연속성 보장

최신 시스템에서는 안정적인 관찰을 위해 사용자 정의 추적 헤더를 처리하는 것이 중요합니다. 필터와 인터셉터를 사용하면 클라이언트가 제공한 추적 정보를 캡처하고 이를 서비스 전체에 올바르게 전파할 수 있습니다. 이렇게 하면 조각난 로그와 추적 누락을 방지할 수 있습니다. 🔍

Micrometer 또는 OpenTelemetry와 결합된 Spring Boot 3.4를 사용하면 Spring Cloud Sleuth와 같은 이전 도구에 의존하지 않고도 강력한 솔루션을 사용할 수 있습니다. 클라이언트 1의 표준 헤더를 처리하든 클라이언트 2의 사용자 정의 헤더를 처리하든 이러한 기술을 구현하면 추적 격차를 효율적으로 메울 수 있습니다. 🚀