Як використовувати Spring Boot 3.4 для поширення трасувань із користувацьких заголовків

Розповсюдження користувацьких заголовків трасування у Spring Boot 3.4

Використання Java із Spring Boot 3.4 і Micrometer для серверної обробки

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

Модульний тест для власного розповсюдження заголовка трасування

Тестування за допомогою JUnit і MockMvc для перевірки поширення заголовка трасування

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

Розповсюдження настроюваних заголовків у HTTP-запитах за допомогою RestTemplate

Використання перехоплювачів RestTemplate для додавання спеціальних заголовків у вихідні запити

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

Поширені запитання щодо розповсюдження власних трасувань у Spring Boot

1. Як вручну витягти власні заголовки трасування у Spring Boot?
2. Ви можете використовувати request.getHeader("custom-header"), щоб вручну отримати певний заголовок і додати його до MDC за допомогою MDC.put("traceId", value).
3. Які переваги використання OpenTelemetry для розповсюдження настроюваного трасування?
4. OpenTelemetry забезпечує сучасний, нейтральний від постачальника підхід до розповсюдження трасування, включаючи спеціальні заголовки, між мікросервісами.
5. Чи можу я поширювати власні заголовки за допомогою RestTemplate у Spring Boot?
6. Так, реалізувавши ClientHttpRequestInterceptor, ви можете додавати спеціальні заголовки, як-от traceid і spanid, до вихідних запитів.
7. Як зареєструвати фільтр для глобального захоплення заголовків?
8. Ви можете створити фільтр, який розширює OncePerRequestFilter, і зареєструвати його за допомогою FilterRegistrationBean для захоплення заголовків для всіх кінцевих точок.
9. Які інструменти я можу використовувати для візуалізації слідів із Spring Boot?
10. Такі інструменти, як Zipkin, Jaeger і Prometheus, можна інтегрувати з Spring Boot і OpenTelemetry для візуалізації наскрізних трас.

Забезпечення безперебійної трасування

У сучасних системах обробка настроюваних заголовків трасування має вирішальне значення для надійної спостережуваності. Використовуючи фільтри та перехоплювачі, ви можете отримувати інформацію про відстеження, надану клієнтом, і правильно поширювати її між вашими службами. Це дозволяє уникнути фрагментованих журналів і відсутніх слідів. 🔍

Spring Boot 3.4 у поєднанні з Micrometer або OpenTelemetry дозволяє створювати надійні рішення, не покладаючись на старіші інструменти, такі як Spring Cloud Sleuth. Незалежно від того, чи маєте ви справу зі стандартними заголовками Клієнта 1 чи користувацькими заголовками Клієнта 2, впровадження цих методів ефективно заповнює пропуски в трасуванні. 🚀