Kako koristiti Spring Boot 3.4 za širenje tragova iz prilagođenih zaglavlja

Širenje prilagođenih zaglavlja praćenja u Spring Boot-u 3.4

Korištenje Jave sa Spring Boot 3.4 i Micrometer za pozadinsku obradu

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

Jedinični test za prilagođeno širenje zaglavlja praćenja

Testiranje s JUnit i MockMvc za provjeru valjanosti širenja zaglavlja praćenja

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

Širenje prilagođenih zaglavlja u HTTP zahtjevima pomoću RestTemplate

Korištenje presretača RestTemplate za dodavanje prilagođenih zaglavlja u odlazne zahtjeve

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

Često postavljana pitanja o širenju prilagođenih tragova u Spring Boot-u

1. Kako mogu ručno izdvojiti prilagođena zaglavlja praćenja u Spring Boot-u?
2. Možete koristiti request.getHeader("custom-header") da ručno dohvatite određeno zaglavlje i dodate ga u MDC pomoću MDC.put("traceId", value).
3. Koja je korist korištenja OpenTelemetryja za prilagođeno širenje praćenja?
4. OpenTelemetry pruža moderan, dobavljaču neutralan pristup širenju praćenja, uključujući prilagođena zaglavlja, preko mikroservisa.
5. Mogu li propagirati prilagođena zaglavlja s RestTemplate u Spring Boot-u?
6. Da, implementacijom ClientHttpRequestInterceptor, možete priložiti prilagođena zaglavlja kao što su traceid i spanid odlaznim zahtjevima.
7. Kako mogu registrirati filtar za globalno hvatanje zaglavlja?
8. Možete stvoriti filtar koji proširuje OncePerRequestFilter i registrirati ga pomoću FilterRegistrationBean za hvatanje zaglavlja za sve krajnje točke.
9. Koje alate mogu koristiti za vizualizaciju tragova iz Spring Boot-a?
10. Alati kao što su Zipkin, Jaeger i Prometheus mogu se integrirati sa Spring Bootom i OpenTelemetryjem za vizualizaciju tragova s ​​kraja na kraj.

Osiguravanje besprijekornog kontinuiteta traga

U modernim sustavima, rukovanje prilagođenim zaglavljima praćenja ključno je za pouzdanu vidljivost. Korištenjem filtara i presretača možete uhvatiti informacije o praćenju koje dostavlja klijent i ispravno ih širiti kroz svoje usluge. Time se izbjegavaju fragmentirani zapisi i nedostajući tragovi. 🔍

Spring Boot 3.4, u kombinaciji s Micrometerom ili OpenTelemetryjem, omogućuje robusna rješenja bez oslanjanja na starije alate kao što je Spring Cloud Sleuth. Bilo da imate posla sa standardnim zaglavljima Klijenta jedan ili prilagođenim zaglavljima Klijenta dva, implementacija ovih tehnika učinkovito premošćuje praznine u tragovima. 🚀