Како користити Спринг Боот 3.4 за пропагирање трагова из прилагођених заглавља

Пропагирање прилагођених заглавља праћења у Спринг Боот-у 3.4

Коришћење Јаве са Спринг Боот 3.4 и Мицрометер за позадинску обраду

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

Јединични тест за прилагођено ширење заглавља трага

Тестирање са ЈУнит и МоцкМвц за валидацију пропагације заглавља трага

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

Ширење прилагођених заглавља у ХТТП захтевима помоћу РестТемплате-а

Коришћење РестТемплате пресретача за додавање прилагођених заглавља у одлазне захтеве

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

Често постављана питања о пропагирању прилагођених трагова у Спринг Боот-у

1. Како да ручно издвојим прилагођена заглавља праћења у Спринг Боот-у?
2. Можете да користите рекуест.гетХеадер("цустом-хеадер") да ручно преузмете одређено заглавље и додате га у МДЦ користећи МДЦ.пут("трацеИд", валуе).
3. Која је предност коришћења ОпенТелеметри за прилагођено ширење трагова?
4. ОпенТелеметри пружа модеран приступ који је неутралан од произвођача за пропагирање трагова, укључујући прилагођена заглавља, кроз микросервисе.
5. Могу ли да ширим прилагођена заглавља помоћу РестТемплате-а у Спринг Боот-у?
6. Да, применом ЦлиентХттпРекуестИнтерцептор, можете да приложите прилагођена заглавља као што су трацеид и спанид одлазним захтевима.
7. Како да региструјем филтер за хватање заглавља на глобалном нивоу?
8. Можете да направите филтер који проширује ОнцеПерРекуестФилтер и да га региструјете помоћу ФилтерРегистратионБеан да бисте ухватили заглавља за све крајње тачке.
9. Које алатке могу да користим за визуелизацију трагова из Спринг Боот-а?
10. Алати као што су Зипкин, Јаегер и Прометхеус могу да се интегришу са Спринг Боот-ом и ОпенТелеметри-ом да би визуелизовали трагове од краја до краја.

Обезбеђивање беспрекорног континуитета трагова

У савременим системима, руковање прилагођеним заглављима праћења је критично за поуздану видљивост. Коришћењем филтера и пресретача, можете да ухватите информације о праћењу које даје клијент и да их правилно ширите кроз своје услуге. Ово избегава фрагментиране дневнике и трагове који недостају. 🔍

Спринг Боот 3.4, у комбинацији са Мицрометер или ОпенТелеметри, омогућава робусна решења без ослањања на старије алате као што је Спринг Цлоуд Слеутх. Без обзира да ли имате посла са стандардним заглављима клијента један или са прилагођеним заглављима клијента два, примена ових техника ефикасно премошћује празнине у праћењу. 🚀