代码拉取完成，页面将自动刷新
当我们使用Splunk、ELK等日志工具的时候，我们希望有一个
traceId就可以把这个请求关联的所有服务日志都搜索出来，并且可以看到上下游服务名称，以及当前请求经历了几层服务，这样子更加方便我们定位问题。
日志样例：
2022-12-04 17:24:33.015 DEBUG [service-sample,reactor-netty-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1.1.1.1.1] 22456 --- [nio-9000-exec-1] c.l.t.servlet.TracerServletInterceptor : Built logging tracer context: {X-B3-TraceId=3a13f40b0ac24c0bb6b981ffde658ff6, X-B3-SpanName=service-sample, X-B3-SpanId=0.1.1.1.1.1.1, X-B3-Parent-SpanName=reactor-netty-sample}
2022-12-04 17:24:33.028 INFO [service-sample,reactor-netty-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1.1.1.1.1] 22456 --- [nio-9000-exec-1] c.l.t.s.service.ServiceSampleController : Received new request for hello api.
2022-12-04 17:24:33.028 INFO [service-sample,reactor-netty-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1.1.1.1.1] 22456 --- [nio-9000-exec-1] c.l.t.s.service.ServiceSampleController : Request header with [user-agent: ReactorNetty/1.0.25]
[service-sample,webclient-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1.1.1.1]：
service-sample：当前服务名称。webclient-sample：上游服务名称。3a13f40b0ac24c0bb6b981ffde658ff6：链路ID，即traceId。0.1.1.1.1.1.1：请求经历的服务层级。
logging-tracer-spring-boot-starter也支持SpringBoot3
3.0.0及以上版本的logging-tracer-spring-boot-starter只针对使用SpringBoot3用户，SpringBoot2用户请使用低于3.0.0版本的logging-tracer-spring-boot-starter，两者功能不受影响，均会同步更新！
依赖已发布至Maven中央仓库，可直接引入依赖。
<dependency>
<groupId>com.lzhpo</groupId>
<artifactId>logging-tracer-spring-boot-starter</artifactId>
<version>${latest-version}</version>
</dependency>
implementation 'com.lzhpo:logging-tracer-spring-boot-starter:${latest-version}'
PS：如果不需要定制，直接导入相关依赖按照下面组件说明正常使用即可。
在这模拟多链路调用服务，按如下顺序逐层call：
| 顺序 | 服务名称 | 截取的部分trace样例 |
|---|---|---|
| 1 | feign-sample | [feign-sample,N/A,3a13f40b0ac24c0bb6b981ffde658ff6,0] |
| 2 | httpclient-sample | [httpclient-sample,feign-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1] |
| 3 | okhttp-sample | [okhttp-sample,httpclient-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1] |
| 4 | resttemplate-sample | [resttemplate-sample,okhttp-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1.1] |
| 5 | webclient-sample | [webclient-sample,okhttp-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1.1.1] |
| 6 | reactor-netty-sample | [reactor-netty-sample,webclient-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1.1.1.1] |
| 7 | service-sample | [service-sample,reactor-netty-sample,3a13f40b0ac24c0bb6b981ffde658ff6,0.1.1.1.1.1.1] |
导入feign依赖将自动生效。
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
参考示例：logging-tracer-feign-sample
导入httpclient依赖将自动生效。
<dependency>
<groupId>org.apache.httpcomponents.client5</groupId>
<artifactId>httpclient5</artifactId>
<version>${httpclient.version}</version>
</dependency>
和使用HttpClients一样，不同的是在这使用的TracerHttpClients 的Bean，方法和HttpClients一样。
参考示例：logging-tracer-httpclient-sample
导入okhttp依赖将自动生效。
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>${okhttp.version}</version>
</dependency>
之前：
OkHttpClient okHttpClient = new OkHttpClient();
现在：注入OkHttpClient.BuilderBean直接使用，就不是直接new了。
@Autowired
private OkHttpClient.Builder okHttpClientBuilder;
// 略...
OkHttpClient okHttpClient = okHttpClientBuilder.build();
参考示例：logging-tracer-okhttp-sample
直接注入RestTemplateBean使用即可。
参考示例：logging-tracer-resttemplate-sample
直接注入WebclientBean使用即可。
参考示例：logging-tracer-webclient-sample
直接注入HttpClientBean使用即可。
参考示例：logging-tracer-reactor-netty-sample
加入了logging-tracer-spring-boot-starter依赖即可，在SpringCloud-Gateway环境中会自动生效。
导入dubbo依赖将自动生效。
参考示例：logging-tracer-dubbo-api-sample、logging-tracer-dubbo-consumer-sample、logging-tracer-dubbo-provider-sample
logging:
tracer:
pattern: '%5p [${spring.application.name:},%X{X-B3-Parent-SpanName},%X{X-B3-TraceId},%X{X-B3-SpanId}]'
当然，你也可以按照以前的方式配置，也是一样生效的，如果两个都配置了，优先使用上面的。
logging:
pattern:
level: '%5p [${spring.application.name:},%X{X-B3-Parent-SpanName},%X{X-B3-TraceId},%X{X-B3-SpanId}]'
logging:
tracer:
proxy-headers:
- Authorization
- User-Id
然后，这些请求头将会自动转发到下游服务，比如，我需要在日志中只显示一个User-Id，就可以这样配置：
logging:
pattern:
level: '%5p [%X{User-Id}]'
如果是多个，英文逗号分隔即可。
logging-tracer功能logging:
tracer:
enabled: false
可以参考
logging-tracer-resttemplate-sample模块中的RestTemplateSampleController中示例代码。
ThreadPoolTaskExecutor【推荐】：如果是注入ThreadPoolTaskExecutor线程池执行多线程任务的话，则正常使用即可，logging-tracer会自动处理相关逻辑。
@Autowired
private ThreadPoolTaskExecutor threadPoolTaskExecutor;
// 略...
threadPoolTaskExecutor.execute(() -> log.info("[threadPool] Hello, I'm threadPool."));
Thread: 因为logging-tracer依赖的是MDC，所以，如果是使用的Thread，需要手动在子父线程中维持MDC相关上下文。
Map<String, String> context = MDC.getCopyOfContextMap();
Thread thread = new Thread(() -> {
MDC.setContextMap(context);
log.info("[multiThread] Hello, I'm multiThread.");
});
thread.start();
其它的方式也同理。
实现接口TracerContextCustomizer，加入到Spring容器中即可。
比如，当你需要添加请求头转发到下游服务的时候，又或者是你需要自定义日志链路输出格式，如果请求头中或当前context中没有此变量，就需要将相关的变量添加到context中。
@Component
public class SampleTracerContextCustomizer implements TracerContextCustomizer {
@Override
public void customize(Map<String, String> context) {
context.put("abc", "123");
context.put("def", "456");
}
}
感谢Jetbrains提供的License！
| 微信 | 公众号 |
|---|---|
 |
 |
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型