Kuidas kasutada Spring Boot 3.4 kohandatud päistest jälgede levitamiseks

Kohandatud jälgimispäiste paljundamine Spring Bootis 3.4

Java kasutamine koos Spring Boot 3.4 ja mikromeetriga taustatöötluseks

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

Kohandatud jälje päise levitamise ühikutest

Jäljepäise levitamise kontrollimiseks testimine JUniti ja MockMvc-ga

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

Kohandatud päiste levitamine HTTP-päringutes RestTemplate abil

RestTemplate pealtkuulajate kasutamine kohandatud päiste lisamiseks väljaminevatele päringutele

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

Korduma kippuvad küsimused kohandatud jälgede levitamise kohta Spring Bootis

1. Kuidas ma saan Spring Booti kohandatud jälgimispäiseid käsitsi ekstraktida?
2. Saate kasutada request.getHeader("custom-header") konkreetse päise käsitsi toomiseks ja selle lisamiseks MDC-sse, kasutades MDC.put("traceId", value).
3. Mis kasu on OpenTelemetry kasutamisest kohandatud jälgede levitamiseks?
4. OpenTelemetry pakub kaasaegset, müüja-neutraalset lähenemisviisi jälgede, sealhulgas kohandatud päiste levitamiseks mikroteenustes.
5. Kas ma saan Spring Booti rakenduse RestTemplate abil kohandatud päiseid levitada?
6. Jah, rakendades ClientHttpRequestInterceptor, saate väljaminevatele päringutele lisada kohandatud päised, nagu traceid ja spanid.
7. Kuidas registreerida filtrit päiste globaalseks hõivamiseks?
8. Saate luua filtri, mis laiendab funktsiooni OncePerRequestFilter, ja registreerida selle funktsiooni FilterRegistrationBean abil, et jäädvustada kõigi lõpp-punktide päised.
9. Milliseid tööriistu saan kasutada Spring Booti jälgede visualiseerimiseks?
10. Selliseid tööriistu nagu Zipkin, Jaeger ja Prometheus saab integreerida Spring Booti ja OpenTelemetryga, et visualiseerida otspunktide jälgi.

Sujuva jälgimise järjepidevuse tagamine

Kaasaegsetes süsteemides on kohandatud jälgimispäiste käsitlemine usaldusväärse jälgitavuse jaoks kriitilise tähtsusega. Filtrite ja pealtkuulajate abil saate jäädvustada kliendi pakutavat jälgimisteavet ja levitada seda õigesti oma teenustes. See väldib killustatud palke ja puuduvaid jälgi. 🔍

Spring Boot 3.4 koos Micrometeri või OpenTelemetryga võimaldab tugevaid lahendusi ilma vanematele tööriistadele, nagu Spring Cloud Sleuth, tuginemata. Olenemata sellest, kas teil on tegemist Client One standardpäistega või Client Two kohandatud päistega, sillutab nende tehnikate rakendamine jälgimislüngad tõhusalt. 🚀