كيفية استخدام 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());
    }
}

نشر الرؤوس المخصصة في طلبات HTTP باستخدام RestTemplate

استخدام RestTemplate Interceptors لإضافة رؤوس مخصصة في الطلبات الصادرة

// 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 باستخدام MDC.put("traceId", value).
3. ما فائدة استخدام OpenTelemetry لنشر التتبع المخصص؟
4. يوفر OpenTelemetry أسلوبًا حديثًا ومحايدًا للبائع لنشر التتبعات، بما في ذلك الرؤوس المخصصة، عبر الخدمات الصغيرة.
5. هل يمكنني نشر الرؤوس المخصصة باستخدام RestTemplate في Spring Boot؟
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. سواء كنت تتعامل مع الرؤوس القياسية الخاصة بـ Client One أو الرؤوس المخصصة لـ Client Two، فإن تنفيذ هذه التقنيات يعمل على سد فجوات التتبع بكفاءة. 🚀