如何使用 Spring Boot 3.4 从自定义标头传播跟踪

在 Spring Boot 3.4 中传播自定义跟踪标头

使用 Java 与 Spring Boot 3.4 和 Micrometer 进行后端处理

// 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 集成，以可视化端到端跟踪。

确保无缝跟踪连续性

在现代系统中，处理自定义跟踪标头对于可靠的可观察性至关重要。通过使用过滤器和拦截器，您可以捕获客户端提供的跟踪信息并将其在您的服务中正确传播。这可以避免日志碎片和丢失痕迹。 🔍

Spring Boot 3.4 与 Micrometer 或 OpenTelemetry 相结合，可以提供强大的解决方案，而无需依赖 Spring Cloud Sleuth 等旧工具。无论您是处理客户端一的标准标头还是客户端二的自定义标头，实施这些技术都可以有效地弥补跟踪差距。 🚀