Cách sử dụng Spring Boot 3.4 để truyền dấu vết từ tiêu đề tùy chỉnh

Tuyên truyền các tiêu đề theo dõi tùy chỉnh trong Spring Boot 3.4

Sử dụng Java với Spring Boot 3.4 và Micromet để xử lý phụ trợ

// 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;
    }
}

Kiểm tra đơn vị để truyền bá tiêu đề dấu vết tùy chỉnh

Thử nghiệm với JUnit và MockMvc để xác thực việc truyền bá tiêu đề theo dõi

// 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());
    }
}

Tuyên truyền tiêu đề tùy chỉnh trong yêu cầu HTTP bằng RestTemplate

Sử dụng Bộ chặn RestTemplate để thêm tiêu đề tùy chỉnh trong các yêu cầu gửi đi

// 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;
    }
}

Câu hỏi thường gặp về việc truyền dấu vết tùy chỉnh trong Spring Boot

1. Làm cách nào để trích xuất thủ công các tiêu đề theo dõi tùy chỉnh trong Spring Boot?
2. Bạn có thể sử dụng request.getHeader("custom-header") để tìm nạp thủ công một tiêu đề cụ thể và thêm nó vào MDC bằng cách sử dụng MDC.put("traceId", value).
3. Lợi ích của việc sử dụng OpenTelemetry để truyền dấu vết tùy chỉnh là gì?
4. OpenTelemetry cung cấp cách tiếp cận hiện đại, trung lập với nhà cung cấp để truyền dấu vết, bao gồm cả tiêu đề tùy chỉnh, trên các vi dịch vụ.
5. Tôi có thể truyền bá các tiêu đề tùy chỉnh bằng RestTemplate trong Spring Boot không?
6. Có, bằng cách triển khai ClientHttpRequestInterceptor, bạn có thể đính kèm các tiêu đề tùy chỉnh như traceid và spanid vào các yêu cầu gửi đi.
7. Làm cách nào để đăng ký bộ lọc để thu thập tiêu đề trên toàn cầu?
8. Bạn có thể tạo một bộ lọc mở rộng OncePerRequestFilter và đăng ký nó bằng cách sử dụng FilterRegistrationBean để thu thập các tiêu đề cho tất cả các điểm cuối.
9. Tôi có thể sử dụng công cụ nào để trực quan hóa dấu vết từ Spring Boot?
10. Các công cụ như Zipkin, Jaeger và Prometheus có thể tích hợp với Spring Boot và OpenTelemetry để trực quan hóa các dấu vết từ đầu đến cuối.

Đảm bảo tính liên tục của dấu vết liền mạch

Trong các hệ thống hiện đại, việc xử lý các tiêu đề theo dõi tùy chỉnh là rất quan trọng để có khả năng quan sát đáng tin cậy. Bằng cách sử dụng các bộ lọc và thiết bị chặn, bạn có thể nắm bắt thông tin theo dõi do khách hàng cung cấp và truyền bá thông tin đó một cách chính xác trên các dịch vụ của mình. Điều này tránh các bản ghi bị phân mảnh và dấu vết bị thiếu. 🔍

Spring Boot 3.4, kết hợp với Micrometer hoặc OpenTelemetry, mang đến các giải pháp mạnh mẽ mà không cần dựa vào các công cụ cũ hơn như Spring Cloud Sleuth. Cho dù bạn đang xử lý các tiêu đề tiêu chuẩn của Khách hàng Một hay tiêu đề tùy chỉnh của Khách hàng Hai, việc triển khai các kỹ thuật này sẽ thu hẹp khoảng cách theo dõi một cách hiệu quả. 🚀