Ako používať Spring Boot 3.4 na šírenie stôp z vlastných hlavičiek

Propagácia vlastných hlavičiek sledovania v systéme Spring Boot 3.4

Použitie Java s Spring Boot 3.4 a Micrometer pre Backend Processing

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

Test jednotky pre vlastné šírenie hlavičky sledovania

Testovanie pomocou JUnit a MockMvc na overenie šírenia hlavičky sledovania

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

Propagácia vlastných hlavičiek v požiadavkách HTTP pomocou šablóny RestTemplate

Používanie zachytávačov RestTemplate na pridávanie vlastných hlavičiek do odchádzajúcich požiadaviek

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

Často kladené otázky o šírení vlastných stôp v Spring Boot

1. Ako manuálne extrahujem vlastné hlavičky sledovania v aplikácii Spring Boot?
2. Pomocou request.getHeader("custom-header") môžete manuálne načítať konkrétnu hlavičku a pridať ju do MDC pomocou MDC.put("traceId", hodnota).
3. Aká je výhoda používania OpenTelemetry na vlastné šírenie sledovania?
4. OpenTelemetry poskytuje moderný, dodávateľsky neutrálny prístup k šíreniu stôp, vrátane vlastných hlavičiek, cez mikroslužby.
5. Môžem šíriť vlastné hlavičky pomocou šablóny RestTemplate v aplikácii Spring Boot?
6. Áno, implementáciou ClientHttpRequestInterceptor môžete k odchádzajúcim požiadavkám pripojiť vlastné hlavičky ako traceid a spanid.
7. Ako zaregistrujem filter na globálne zachytávanie hlavičiek?
8. Môžete vytvoriť filter, ktorý rozširuje OncePerRequestFilter a zaregistrovať ho pomocou FilterRegistrationBean na zachytenie hlavičiek pre všetky koncové body.
9. Aké nástroje môžem použiť na vizualizáciu stôp z aplikácie Spring Boot?
10. Nástroje ako Zipkin, Jaeger a Prometheus sa dajú integrovať so Spring Boot a OpenTelemetry na vizualizáciu stôp od konca po koniec.

Zabezpečenie bezproblémovej kontinuity sledovania

V moderných systémoch je manipulácia s vlastnými hlavičkami sledovania kritická pre spoľahlivú pozorovateľnosť. Pomocou filtrov a zachytávačov môžete zachytiť informácie o sledovaní od klienta a správne ich šíriť vo vašich službách. Vyhnete sa tak fragmentovaným protokolom a chýbajúcim stopám. 🔍

Spring Boot 3.4 v kombinácii s Micrometer alebo OpenTelemetry umožňuje robustné riešenia bez spoliehania sa na staršie nástroje, ako je Spring Cloud Sleuth. Či už máte čo do činenia so štandardnými hlavičkami klienta 1 alebo vlastnými hlavičkami klienta 2, implementácia týchto techník efektívne premosťuje medzery v sledovaní. 🚀