一、单体项目
1.直接使用springboot自带日志框架
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
2.定义日志拦截器
import org.apache.commons.lang3.StringUtils;
import org.slf4j.MDC;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;
public class OcrLogInterceptor implements HandlerInterceptor {
private static final String TRACE_ID = "TRACE_ID";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String tid = UUID.randomUUID().toString().replaceAll("-", "");
if (StringUtils.isNotBlank(request.getHeader(TRACE_ID))) {
tid = request.getHeader(TRACE_ID);
}
MDC.put(TRACE_ID, tid);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
MDC.remove(TRACE_ID);
}
}
3.将定义的日志拦截器配置到WebMvcConfigurer中，并且指定拦截请求的规则
import demo.RequestInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* 拦截WEB请求
*/
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new RequestInterceptor());
}
}
4.配置 Logback
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg %X{traceId}%n</pattern>
</encoder>
</appender>
<root level="debug">
<appender-ref ref="STDOUT" />
</root>
</configuration>
在这个配置文件中，我们定义了一个控制台输出的 appender，并使用 %X{traceId} 来输出 MDC 中的 traceId。
参考：https://www.cnblogs.com/jingzh/p/17248886.html
二、分布式项目
在Spring Cloud中，可以使用Spring Cloud Sleuth来实现分布式追踪。
在pom.xml文件中添加Spring Cloud Sleuth依赖，例如：
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>
2、配置日志。
在application.properties（或application.yml）文件中，添加以下配置：
spring.sleuth.sampler.probability: 1.0
这将启用Sleuth并设置采样率为100%。
3、 打印日志。
在需要追踪的代码中添加日志输出，例如：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@RestController
public class TestController {
private static final Logger logger = LoggerFactory.getLogger(TestController.class);
@GetMapping("/hello")
public String hello() {
logger.info("Hello, Sleuth!");
return "Hello, Sleuth!";
}
}
4、运行应用程序。
启动应用程序并观察日志输出。Sleuth将为每个请求生成一个唯一的跟踪ID和跟踪标签，以便跟踪请求的路径。
- 查看追踪信息。
可以使用Zipkin等分布式追踪系统来查看和分析生成的追踪信息。通过配置Sleuth将追踪信息发送到Zipkin服务器。
这些是使用Spring Cloud Sleuth进行分布式追踪的基本步骤。您还可以配置更多的参数来自定义和优化追踪行为。有关更多详细信息，请参阅Spring Cloud Sleuth的官方文档。
