欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

SpringBoot之微服务日志链路追踪

程序员文章站 2023-01-25 15:18:35
SpringBoot之微服务日志链路追踪 简介 在微服务里,业务出现问题或者程序出的任何问题,都少不了查看日志,一般我们使用 相关的日志收集工具,服务多的情况下,业务问题也是有些难以排查,只能确定大致时间定位相关日志。 解决多个服务调用日志的问题,它可以将一个完整的调用链给整合为一个完整有序的日志。 ......

springboot之微服务日志链路追踪

简介

在微服务里,业务出现问题或者程序出的任何问题,都少不了查看日志,一般我们使用 elk 相关的日志收集工具,服务多的情况下,业务问题也是有些难以排查,只能确定大致时间定位相关日志。log-trace-spring-boot-starter 解决多个服务调用日志的问题,它可以将一个完整的调用链给整合为一个完整有序的日志。

支持组件:

  • zuul 调用
  • feign 调用
  • resttemplate 调用

日志输出格式:

2019-11-14 14:22:07.796  info [log-trace-service-a-demo,ac8ffaaed5f343da,log-trace-zuul-demo,,] 88948 --- [nio-8081-exec-7] c.p.l.t.service.a.demo.testcontroller    : controller test2 执行 ac8ffaaed5f343da
2019-11-14 14:23:15.569  info [log-trace-service-a-demo,04cf5392dc5c4881,log-trace-zuul-demo,,] 88948 --- [nio-8081-exec-9] c.p.l.t.service.a.demo.testcontroller    : controller test2 执行 04cf5392dc5c4881
2019-11-14 14:24:44.183  info [log-trace-service-a-demo,86b5c555ce4f4451,log-trace-zuul-demo,,] 88948 --- [nio-8081-exec-1] c.p.l.t.service.a.demo.testcontroller    : controller test2 执行 86b5c555ce4f4451

我们可以通过 86b5c555ce4f4451 id 进行查询链路上的所有日志信息。

log-trace-service-a-demo 为当前应用。
log-trace-zuul-demo 为上游应用。

当然这些参数可以基于业务定制的。

功能使用

添加依赖

ps: 实际version版本请使用最新版
最新版本:

点击查看最新新版本

<dependency>
  <groupid>com.purgeteam</groupid>
  <artifactid>log-trace-spring-boot-starter</artifactid>
  <version>0.1.0.release</version>
</dependency>

ps: 请基于 spirngboot2.1.x 版本使用

配置应用

这里以3个微服务来举例子。

  1. log-trace-zuul-demo 充当网关功能
  2. log-trace-service-a-demo 充当服务a
  3. log-trace-service-b-demo 充当服务b

调用链路为:

log-trace-zuul-demo -> log-trace-service-a-demo testcontroller#test -> log-trace-service-b-demo testcontroller#test

访问网关地址: http://127.0.0.1:8000/a/test

网关日志如下:

2019-11-14 14:27:37.434 debug [33b07a9c5f324375,this] 89996 --- [nio-8000-exec-1] c.p.l.t.s.i.zuul.traceprezuulfilter      : zuul traceid 33b07a9c5f324375

网关转发至服务a

服务a 日志如下:

2019-11-14 14:27:37.476  info [log-trace-service-a-demo,33b07a9c5f324375,log-trace-zuul-demo,,] 88948 --- [nio-8081-exec-5] c.p.l.t.service.a.demo.testcontroller    : controller test2 执行 33b07a9c5f324375

服务a 调用 服务b

服务b 日志如下:

2019-11-14 14:27:37.478  info [log-trace-service-b-demo,33b07a9c5f324375,log-trace-service-a-demo,,] 88952 --- [nio-8082-exec-3] c.p.l.t.servcie.b.demo.testcontroller    : header traceid 33b07a9c5f324375
2019-11-14 14:27:37.478  info [log-trace-service-b-demo,33b07a9c5f324375,log-trace-service-a-demo,,] 88952 --- [nio-8082-exec-3] c.p.l.t.servcie.b.demo.testcontroller    : controller test 执行 33b07a9c5f324375
2019-11-14 14:27:37.478  info [log-trace-service-b-demo,33b07a9c5f324375,log-trace-service-a-demo,,] 88952 --- [nio-8082-exec-3] c.p.l.trace.servcie.b.demo.testservice   : test 方法执行 33b07a9c5f324375
2019-11-14 14:27:37.478  info [log-trace-service-b-demo,33b07a9c5f324375,log-trace-service-a-demo,,] 88952 --- [nio-8082-exec-3] c.p.l.trace.servcie.b.demo.testservice   : test1 方法执行 33b07a9c5f324375

这样可以在第三方日志平台按照一个id进行查询了。

elk 通过 33b07a9c5f324375 id 查询出相关的所有链路调用。

配置输出格式

目前支持以上参数:

x-b3-parentname 上游服务名称
x-b3-traceid 为一个请求分配的id号,用来标识一条请求链路。

通过 application.properties 进行配置。

spring.trace.log.format=x-b3-traceid,x-b3-parentname


`spring.trace.log.format` 配置参数顺序将影响日志输出格式。

不配置将按照默认格式输出。

日志输出如下:

2019-11-14 14:27:37.434 debug [33b07a9c5f324375,this] 89996 --- [nio-8000-exec-1] c.p.l.t.s.i.zuul.traceprezuulfilter      : zuul traceid 33b07a9c5f324375

总结

目前实现了日志连贯的功能,后续将支持定制输出 比如按照登陆人员id进行输出,方便追踪用户行为。
框架方便后续支持 dubbo 等。

示例代码地址:

作者github:
purgeyao 欢迎关注

qq交流群: 812321371 微信交流群: mercyyao

微信公众号:

SpringBoot之微服务日志链路追踪