Sådan bruges Spring Boot 3.4 til at udbrede spor fra brugerdefinerede overskrifter

Udbredelse af tilpassede sporingshoveder i Spring Boot 3.4

Brug af Java med Spring Boot 3.4 og Micrometer til Backend-behandling

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

Test med JUnit og MockMvc for at validere sporhovedudbredelse

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

Udbredelse af tilpassede overskrifter i HTTP-anmodninger ved hjælp af RestTemplate

Brug af RestTemplate Interceptors til at tilføje brugerdefinerede overskrifter i udgående anmodninger

// 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 stillede spørgsmål om udbredelse af tilpassede spor i fjederstøvler

1. Hvordan udtrækker jeg manuelt tilpassede sporingsoverskrifter i Spring Boot?
2. Du kan bruge request.getHeader("custom-header") til manuelt at hente en specifik header og tilføje den til MDC ved hjælp af MDC.put("traceId", værdi).
3. Hvad er fordelen ved at bruge OpenTelemetry til tilpasset sporudbredelse?
4. OpenTelemetry giver en moderne, leverandørneutral tilgang til udbredelse af spor, herunder tilpassede headere, på tværs af mikrotjenester.
5. Kan jeg udbrede tilpassede overskrifter med RestTemplate i Spring Boot?
6. Ja, ved at implementere en ClientHttpRequestInterceptor, kan du vedhæfte tilpassede overskrifter som traceid og spanid til udgående anmodninger.
7. Hvordan registrerer jeg et filter til at fange overskrifter globalt?
8. Du kan oprette et filter, der udvider OncePerRequestFilter og registrere det ved hjælp af FilterRegistrationBean for at fange overskrifter for alle endepunkter.
9. Hvilke værktøjer kan jeg bruge til at visualisere spor fra Spring Boot?
10. Værktøjer som Zipkin, Jaeger og Prometheus kan integreres med Spring Boot og OpenTelemetry for at visualisere ende-til-ende-spor.

Sikring af sømløs sporingskontinuitet

I moderne systemer er håndtering af tilpassede sporingshoveder afgørende for pålidelig observerbarhed. Ved at bruge filtre og interceptorer kan du fange klient-leveret sporingsinformation og udbrede den korrekt på tværs af dine tjenester. Dette undgår fragmenterede logfiler og manglende spor. 🔍

Spring Boot 3.4, kombineret med Micrometer eller OpenTelemetry, tillader robuste løsninger uden at være afhængige af ældre værktøjer som Spring Cloud Sleuth. Uanset om du beskæftiger dig med Client Ones standardheaders eller Client Twos tilpassede headers, slår implementeringen af ​​disse teknikker bro mellem sporingshullerne effektivt. 🚀