Slik bruker du Spring Boot 3.4 til å spre spor fra tilpassede overskrifter

Forplante tilpassede sporingshoder i Spring Boot 3.4

Bruker Java med Spring Boot 3.4 og Micrometer for Backend Processing

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

Unit Test for Custom Trace Header Propagation

Testing med JUnit og MockMvc for å validere sporingshodeutbredelse

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

Spre tilpassede overskrifter i HTTP-forespørsler ved å bruke RestTemplate

Bruke RestTemplate Interceptors for å legge til egendefinerte overskrifter i utgående forespørsler

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

Ofte stilte spørsmål om forplantning av tilpassede spor i vårstøvel

1. Hvordan trekker jeg ut egendefinerte sporingshoder manuelt i Spring Boot?
2. Du kan bruke request.getHeader("custom-header") for å hente en spesifikk overskrift manuelt og legge den til MDC ved å bruke MDC.put("traceId", verdi).
3. Hva er fordelen med å bruke OpenTelemetry for tilpasset sporforplantning?
4. OpenTelemetry gir en moderne, leverandørnøytral tilnærming til å spre spor, inkludert tilpassede overskrifter, på tvers av mikrotjenester.
5. Kan jeg spre egendefinerte overskrifter med RestTemplate i Spring Boot?
6. Ja, ved å implementere en ClientHttpRequestInterceptor, kan du legge ved egendefinerte overskrifter som traceid og spanid til utgående forespørsler.
7. Hvordan registrerer jeg et filter for å fange overskrifter globalt?
8. Du kan opprette et filter som utvider OncePerRequestFilter og registrere det ved å bruke FilterRegistrationBean for å fange opp overskrifter for alle endepunkter.
9. Hvilke verktøy kan jeg bruke for å visualisere spor fra Spring Boot?
10. Verktøy som Zipkin, Jaeger og Prometheus kan integreres med Spring Boot og OpenTelemetry for å visualisere ende-til-ende-spor.

Sikrer sømløs sporingskontinuitet

I moderne systemer er håndtering av tilpassede sporingshoder avgjørende for pålitelig observerbarhet. Ved å bruke filtre og interceptorer kan du fange opp klientlevert sporingsinformasjon og spre den riktig på tvers av tjenestene dine. Dette unngår fragmenterte logger og manglende spor. 🔍

Spring Boot 3.4, kombinert med Micrometer eller OpenTelemetry, tillater robuste løsninger uten å stole på eldre verktøy som Spring Cloud Sleuth. Enten du har å gjøre med Client Ones standardoverskrifter eller Client Twos egendefinerte overskrifter, vil implementering av disse teknikkene bygge bro over sporgapene effektivt. 🚀