Spring Boot 3.4:n käyttäminen jälkien levittämiseen mukautetuista otsikoista

Mukautettujen jäljitysotsikoiden levittäminen Spring Bootissa 3.4

Javan käyttö Spring Boot 3.4:n ja Micrometerin kanssa taustakäsittelyyn

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

Yksikkötesti mukautetun jäljityksen otsikon levittämiseksi

Testaus JUnitilla ja MockMvc:llä jäljityksen otsikon leviämisen vahvistamiseksi

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

Mukautettujen otsikoiden lisääminen HTTP-pyynnöissä RestTemplatea käyttämällä

RestTemplate Interceptors -ohjelman käyttö mukautettujen otsikoiden lisäämiseen lähteviin pyyntöihin

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

Usein kysyttyjä kysymyksiä mukautettujen jälkien levittämisestä Spring Bootissa

1. Kuinka puran mukautetut jäljitysotsikot manuaalisesti Spring Bootissa?
2. Voit käyttää request.getHeader("custom-header") noutaaksesi tietyn otsikon manuaalisesti ja lisätäksesi sen MDC:hen käyttämällä MDC.put("traceId", value).
3. Mitä hyötyä on OpenTelemetryn käyttämisestä mukautettuun jäljityksen levittämiseen?
4. OpenTelemetry tarjoaa modernin, toimittajaneutraalin lähestymistavan jälkien, mukaan lukien mukautettujen otsikoiden, levittämiseen mikropalveluissa.
5. Voinko levittää mukautettuja otsikoita RestTemplatella Spring Bootissa?
6. Kyllä, ottamalla käyttöön ClientHttpRequestInterceptor, voit liittää lähteviin pyyntöihin mukautettuja otsikoita, kuten traceid ja spanid.
7. Kuinka rekisteröin suodattimen otsikoiden kaappaamiseksi maailmanlaajuisesti?
8. Voit luoda suodattimen, joka laajentaa OncePerRequestFilteriä, ja rekisteröidä sen FilterRegistrationBeanilla kaapataksesi kaikkien päätepisteiden otsikot.
9. Mitä työkaluja voin käyttää Spring Bootin jälkien visualisointiin?
10. Työkalut, kuten Zipkin, Jaeger ja Prometheus, voidaan integroida Spring Bootin ja OpenTelemetryn kanssa päästäkseen päähän -jälkien visualisoimiseksi.

Saumattoman jäljityksen jatkuvuuden varmistaminen

Nykyaikaisissa järjestelmissä mukautettujen jäljitysotsikoiden käsittely on kriittistä luotettavan havainnoinnin kannalta. Käyttämällä suodattimia ja sieppaajia voit kaapata asiakkaan toimittamat jäljitystiedot ja levittää niitä oikein palveluissasi. Tämä välttää hajanaiset lokit ja puuttuvat jäljet. 🔍

Spring Boot 3.4 yhdistettynä Micrometerin tai OpenTelemetryn kanssa mahdollistaa kestäviä ratkaisuja turvautumatta vanhempiin työkaluihin, kuten Spring Cloud Sleuth. Olitpa sitten tekemisissä Client One -sovelluksen vakiootsikoiden tai Client Twon mukautettujen otsikoiden kanssa, näiden tekniikoiden käyttöönotto siltaa jäljitysaukot tehokkaasti. 🚀