Kā izmantot Spring Boot 3.4, lai izplatītu pēdas no pielāgotajām galvenēm

Pielāgotu izsekošanas galveņu pavairošana programmā Spring Boot 3.4

Java izmantošana ar Spring Boot 3.4 un mikrometru aizmugures apstrādei

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

Vienības pārbaude pielāgotas izsekošanas galvenes izplatīšanai

Testēšana ar JUnit un MockMvc, lai apstiprinātu izsekošanas galvenes izplatīšanu

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

Pielāgotu galveņu pavairošana HTTP pieprasījumos, izmantojot RestTemplate

RestTemplate pārtvērēju izmantošana, lai pievienotu pielāgotas galvenes izejošajiem pieprasījumiem

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

Bieži uzdotie jautājumi par pielāgoto pēdu pavairošanu programmā Spring Boot

1. Kā manuāli izvilkt pielāgotās izsekošanas galvenes programmā Spring Boot?
2. Varat izmantot request.getHeader("custom-header"), lai manuāli izgūtu konkrētu galveni un pievienotu to MDC, izmantojot MDC.put("traceId", value).
3. Kāds ir OpenTelemetry izmantošanas ieguvums pielāgotai izsekošanas izplatīšanai?
4. OpenTelemetry nodrošina modernu, piegādātāju ziņā neitrālu pieeju izsekojumu, tostarp pielāgotu galveņu, izplatīšanai mikropakalpojumos.
5. Vai es varu izplatīt pielāgotas galvenes, izmantojot RestTemplate programmā Spring Boot?
6. Jā, ieviešot ClientHttpRequestInterceptor, izejošajiem pieprasījumiem varat pievienot pielāgotas galvenes, piemēram, traceid un spanid.
7. Kā reģistrēt filtru, lai globāli uztvertu galvenes?
8. Varat izveidot filtru, kas paplašina OncePerRequestFilter, un reģistrēt to, izmantojot FilterRegistrationBean, lai tvertu visu galapunktu galvenes.
9. Kādus rīkus es varu izmantot, lai vizualizētu pēdas no Spring Boot?
10. Tādus rīkus kā Zipkin, Jaeger un Prometheus var integrēt ar Spring Boot un OpenTelemetry, lai vizualizētu pēdas līdz galam.

Nevainojama izsekošanas nepārtrauktības nodrošināšana

Mūsdienu sistēmās pielāgotu izsekošanas galveņu apstrāde ir ļoti svarīga uzticamai novērojamībai. Izmantojot filtrus un pārtvērējus, varat tvert klienta nodrošināto izsekošanas informāciju un pareizi izplatīt to savos pakalpojumos. Tas ļauj izvairīties no sadrumstalotiem baļķiem un trūkstošām pēdām. 🔍

Spring Boot 3.4 apvienojumā ar Micrometer vai OpenTelemetry nodrošina stabilus risinājumus, nepaļaujoties uz vecākiem rīkiem, piemēram, Spring Cloud Sleuth. Neatkarīgi no tā, vai jums ir darīšana ar Client One standarta galvenēm vai Client Two pielāgotajām galvenēm, šo metožu ieviešana efektīvi novērš izsekošanas nepilnības. 🚀