Cara Menggunakan Spring Boot 3.4 untuk Menyebarkan Jejak dari Header Kustom

Menyebarkan Header Pelacakan Kustom di Spring Boot 3.4

Menggunakan Java dengan Spring Boot 3.4 dan Mikrometer untuk Pemrosesan Backend

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

Uji Unit untuk Propagasi Header Jejak Kustom

Pengujian dengan JUnit dan MockMvc untuk Memvalidasi Propagasi Trace Header

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

Menyebarkan Header Kustom dalam Permintaan HTTP Menggunakan RestTemplate

Menggunakan RestTemplate Interceptors untuk Menambahkan Header Kustom di Permintaan Keluar

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

Pertanyaan Umum tentang Menyebarkan Jejak Kustom di Spring Boot

1. Bagaimana cara mengekstrak header jejak khusus secara manual di Spring Boot?
2. Anda dapat menggunakan request.getHeader("custom-header") untuk mengambil header tertentu secara manual dan menambahkannya ke MDC menggunakan MDC.put("traceId", value).
3. Apa manfaat menggunakan OpenTelemetry untuk propagasi jejak kustom?
4. OpenTelemetry memberikan pendekatan modern dan netral terhadap vendor untuk menyebarkan jejak, termasuk header khusus, di seluruh layanan mikro.
5. Bisakah saya menyebarkan header khusus dengan RestTemplate di Spring Boot?
6. Ya, dengan menerapkan ClientHttpRequestInterceptor, Anda dapat melampirkan header khusus seperti traceid dan spanid ke permintaan keluar.
7. Bagaimana cara mendaftarkan filter untuk menangkap header secara global?
8. Anda dapat membuat filter yang memperluas OncePerRequestFilter dan mendaftarkannya menggunakan FilterRegistrationBean untuk menangkap header untuk semua titik akhir.
9. Alat apa yang dapat saya gunakan untuk memvisualisasikan jejak dari Spring Boot?
10. Alat seperti Zipkin, Jaeger, dan Prometheus dapat berintegrasi dengan Spring Boot dan OpenTelemetry untuk memvisualisasikan jejak end-to-end.

Memastikan Kontinuitas Jejak yang Mulus

Dalam sistem modern, menangani header pelacakan khusus sangat penting agar observasi dapat diandalkan. Dengan menggunakan filter dan interseptor, Anda dapat menangkap informasi penelusuran yang disediakan klien dan menyebarkannya dengan benar ke seluruh layanan Anda. Hal ini untuk menghindari log yang terfragmentasi dan jejak yang hilang. 🔍

Spring Boot 3.4, dikombinasikan dengan Micrometer atau OpenTelemetry, memungkinkan solusi tangguh tanpa bergantung pada alat lama seperti Spring Cloud Sleuth. Baik Anda berurusan dengan header standar Klien Satu atau header kustom Klien Dua, penerapan teknik ini akan menjembatani kesenjangan pelacakan secara efisien. 🚀