springboot cloud项目 通过网关生成TraceId ,使用MDC,传递到各个服务,可以使用logback。打印TraceId 并追踪

  1. 在网关生成TraceId:在网关处,可以拦截所有的请求,在请求进入系统时生成唯一的TraceId,并将其添加到请求的Header中,例如使用UUID.randomUUID().toString()生成一个唯一的TraceId,并将其添加到HTTP Header中。

  2. 传递TraceId到各个服务:网关转发请求到各个微服务时,需要将TraceId传递下去。这可以通过在网关处将TraceId添加到HTTP Header中,然后微服务在接收到请求时提取Header中的TraceId,并设置到MDC中。

  3. 在各个服务中打印TraceId:使用logback,在日志输出时打印TraceId。这可以通过logback的配置来实现。

下面是一个简单的示例:

<!-- logback-spring.xml -->
<configuration>

    <!-- Define the pattern for logging including TraceId -->
    <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} [%X{TraceId}] - %msg%n"/>

    <!-- Console Appender -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- Root Logger -->
    <root level="info">
        <appender-ref ref="CONSOLE"/>
    </root>

</configuration>

在这个配置中,[%X{TraceId}]用于从MDC中获取TraceId并打印到日志中。

在微服务中,接收到请求时,需要将TraceId从Header中提取出来,并设置到MDC中:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.UUID;

public class TraceIdFilter implements Filter {

    private static final Logger logger = LoggerFactory.getLogger(TraceIdFilter.class);

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String traceId = httpRequest.getHeader("TraceId");
        if (traceId == null || traceId.isEmpty()) {
            traceId = UUID.randomUUID().toString();
            logger.info("Generated TraceId: {}", traceId);
        }
        MDC.put("TraceId", traceId);
        try {
            chain.doFilter(request, response);
        } finally {
            MDC.remove("TraceId");
        }
    }
}

这个Filter用于从请求中获取TraceId,如果请求中没有TraceId,则生成一个新的,并将其设置到MDC中。然后在chain.doFilter(request, response);之后,清理MDC,确保不会影响其他请求的TraceId。

最后,在微服务的启动类中注册这个Filter:

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class WebConfig {

    @Bean
    public FilterRegistrationBean<TraceIdFilter> traceIdFilter() {
        FilterRegistrationBean<TraceIdFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new TraceIdFilter());
        registrationBean.addUrlPatterns("/*"); // Add filter to all URLs
        return registrationBean;
    }
}

这样,就可以在整个系统中追踪请求,而且在日志中打印出TraceId,方便追踪和调试。

  • 4
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
logback中写入traceid可以通过使用MDC(Mapped Diagnostic Context)实现。MDC是一个线程相关的map,可以用来存储一些上下文信息。 例如,我们可以在请求进来时生成一个唯一的traceid,并将其放入MDC中,然后在后续的日志记录中,通过占位符`${mdcKey}`来引用这个traceid。 具体实现可以参考以下示例代码: 1. 在请求进来时生成traceid并放入MDC中 ``` import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.slf4j.MDC; import java.util.UUID; public class TraceInterceptor extends HandlerInterceptorAdapter { private static final Logger logger = LoggerFactory.getLogger(TraceInterceptor.class); @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String traceid = UUID.randomUUID().toString(); MDC.put("traceid", traceid); logger.info("TraceInterceptor preHandle, traceid={}", traceid); return true; } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { MDC.remove("traceid"); } } ``` 2. 在logback配置文件中使用`${mdcKey}`占位符来引用traceid ``` <?xml version="1.0" encoding="UTF-8"?> <configuration> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg %n</pattern> </encoder> </appender> <logger name="com.example" level="DEBUG"/> <root level="INFO"> <appender-ref ref="CONSOLE"/> </root> </configuration> ``` 在以上的logback配置中,我们可以使用`${mdcKey}`占位符来引用traceid,例如:`[%X{traceid}]`。 ``` %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceid}] %-5level %logger{36} - %msg %n ``` 这样,在日志中就可以看到类似于`[1a2b3c4d-5e6f-7g8h-9i10j11k12l]`这样的traceid了。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值