Spring Boot组成的分布式系统中实现日志跟踪

Spring Boot组成的分布式系统中实现日志跟踪

首发2024-07-25 08:54·潘多编程

在分布式系统中,日志跟踪是一项非常重要的功能,它帮助开发者了解请求在整个系统中的流转过程,这对于调试、监控和故障排查至关重要。Spring Boot应用通常作为微服务架构的一部分,因此需要一种机制来确保日志的一致性和可追踪性。本文将介绍如何在基于Spring Boot的分布式系统中实现日志跟踪。

1. 引言

在分布式系统中,一个请求可能会经过多个服务节点。为了更好地理解请求的完整流程,我们需要能够追踪请求在各个服务间的传播路径。日志跟踪可以帮助我们做到这一点,它通常涉及到为每个请求分配一个唯一的标识符(通常是trace ID),并在日志中记录该标识符,以便后续分析。

2. 日志跟踪原理

在分布式系统中,日志跟踪主要包括以下几个概念:

  • Trace ID:唯一标识一次完整的请求流程。
  • Span ID:标识一次请求中的单个服务调用。
  • Parent ID:标识一个Span的父Span,用于表示服务调用的层级关系。

3. 实现方案

3.1 使用Spring Cloud Sleuth

Spring Cloud Sleuth 是一个常用的日志跟踪库,它可以轻松地集成到Spring Boot应用中,以实现日志跟踪。

添加依赖

在pom.xml中添加Sleuth依赖:

Xml

深色版本

1<dependency>
2    <groupId>org.springframework.cloud</groupId>
3    <artifactId>spring-cloud-starter-sleuth</artifactId>
4</dependency>

配置Sleuth

默认情况下,Sleuth会自动启用日志跟踪。可以通过配置文件进一步定制:

Yaml

深色版本

1spring:
2  cloud:
3    sleuth:
4      web:
5        client:
6          enabled: true # 启用客户端跟踪
7      exporter:
8        logging:
9          enabled: true # 启用日志输出

3.2 集成Zipkin

Zipkin 是一个流行的分布式追踪系统,可以与Sleuth一起使用,提供更强大的追踪数据可视化。

添加Zipkin依赖

在pom.xml中添加Zipkin依赖:

Xml

深色版本

1<dependency>
2    <groupId>org.springframework.cloud</groupId>
3    <artifactId>spring-cloud-starter-zipkin</artifactId>
4</dependency>

配置Zipkin

配置Zipkin服务器的地址:

Yaml

深色版本

1spring:
2  cloud:
3    sleuth:
4      web:
5        client:
6          enabled: true
7      exporter:
8        zipkin:
9          enabled: true
10    zipkin:
11      base-url: http://zipkin-server:9411

部署Zipkin Server

Zipkin Server可以使用Docker容器轻松部署:

Sh

深色版本

1docker run -d --name zipkin-server -p 9411:9411 openzipkin/zipkin

4. 自定义日志输出

除了使用Sleuth和Zipkin之外,我们还可以自定义日志输出格式,以便更容易地识别请求的追踪信息。

使用MDC (Mapped Diagnostic Context)

MDC 是Logback或Log4j提供的一个功能,用于在日志中记录额外的信息。我们可以通过@Slf4j注解和MDC.put方法来设置MDC变量。

Java

深色版本

1import org.slf4j.MDC;
2
3@Service
4public class MyService {
5
6    private static final Logger logger = LoggerFactory.getLogger(MyService.class);
7
8    public void processRequest(String traceId) {
9        MDC.put("traceId", traceId);
10        logger.info("Processing request");
11        // ...
12        MDC.remove("traceId"); // 移除MDC变量
13    }
14}

自定义日志模式

在logback.xml或log4j.properties中定义日志模式,以包含MDC中的traceId:

Xml

深色版本

1<!-- logback.xml -->
2<configuration>
3  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
4    <encoder>
5      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %X{traceId} - %msg%n</pattern>
6    </encoder>
7  </appender>
8  <root level="info">
9    <appender-ref ref="STDOUT" />
10  </root>
11</configuration>

5. 示例

假设我们有两个Spring Boot应用:service-a和service-b,其中service-a调用service-b。

service-a

Java

深色版本

1@RestController
2public class ServiceAController {
3
4    private final ServiceBClient serviceBClient;
5
6    public ServiceAController(ServiceBClient serviceBClient) {
7        this.serviceBClient = serviceBClient;
8    }
9
10    @GetMapping("/invoke-service-b")
11    public String invokeServiceB(@RequestHeader("traceId") String traceId) {
12        MDC.put("traceId", traceId);
13        String response = serviceBClient.invoke();
14        MDC.remove("traceId");
15        return response;
16    }
17}

service-b

Java

深色版本

1@RestController
2public class ServiceBController {
3
4    @GetMapping("/invoke")
5    public String invoke(@RequestHeader("traceId") String traceId) {
6        MDC.put("traceId", traceId);
7        logger.info("Received request in service-b");
8        MDC.remove("traceId");
9        return "Response from service-b";
10    }
11}

6. 总结

通过使用Spring Cloud Sleuth和Zipkin,我们可以轻松地为Spring Boot应用实现日志跟踪。这种方式不仅简化了日志跟踪的实现,还提供了强大的可视化工具,帮助我们更好地理解和调试分布式系统。此外,通过自定义日志输出格式和使用MDC,我们可以进一步定制日志以适应特定的需求。


通过上述步骤,你可以在基于Spring Boot的分布式系统中实现有效的日志跟踪功能,从而提高系统的可维护性和可观察性。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/49731.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【cmd】Windows CMD命令整理及示例使用

1. dir 显示目录中的文件和子目录列表。 dir带参数使用示例&#xff1a; dir /p # 分页显示目录中的内容 dir /s # 显示指定目录及所有子目录中的文件 dir /a # 显示具有隐藏属性的文件2. copy 复制文件和目录。 copy source destination带参数使用示例&#xff1a; c…

养宠浮毛异味双困扰?性价比高的宠物空气净化器推荐

家里养了两只银渐层&#xff0c;谁懂啊&#xff01;一下班打开家门就看到家里飘满了猫浮毛雪&#xff0c;空气中还传来隐隐约约的异味。每天不是在吸毛的路上&#xff0c;就是在洗猫砂盆的路上&#xff0c;而且空气中的浮毛还很难清理干净&#xff0c;这是最让人头疼的问题。 …

SSM学习8:SpringMVC请求与响应

设置请求映射路径 设置配置 config/ServletContainersInitConfig.class public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {protected Class<?>[] getServletConfigClasses() {return new Class[]{SpringMvcC…

Golang | Leetcode Golang题解之第282题给表达式添加运算符

题目&#xff1a; 题解&#xff1a; func addOperators(num string, target int) (ans []string) {n : len(num)var backtrack func(expr []byte, i, res, mul int)backtrack func(expr []byte, i, res, mul int) {if i n {if res target {ans append(ans, string(expr))}…

stm32——lcd液晶显示

一.液晶屏介绍 液晶显示屏是由液晶显示面板&#xff0c;电容触摸屏&#xff0c;pcb底板构成。在液晶显示屏里我们有带控制芯片的还有不带控制芯片的。对于低端的微控制器它不能直接控制液晶面板&#xff0c;所以需要给液晶控制面板而外增加一个液晶控制芯片。对于单片机stm32f4…

销售分析,奥威BI,销售好帮手

【销售分析&#xff0c;奥威BI&#xff0c;销售好帮手】 在商海浮沉中&#xff0c;销售数据是企业最宝贵的资产之一&#xff0c;它不仅反映了市场的反馈&#xff0c;更是指引企业未来战略方向的灯塔。奥威BI&#xff08;Business Intelligence&#xff09;&#xff0c;作为数据…

openssl req 详解

一、openssl req 该命令用于创建和处理PKCS#10格式的证书请求&#xff08;certificate requests CSRs&#xff09;&#xff0c;也可以用来创建自签名证书&#xff08; self-signed certificates&#xff09;来当作根证书&#xff08;root CAs&#xff09;使用 -new 该选项用来…

硅纪元视角 | Stability AI推出Stable Video 4D,40秒生成8角度动态视频!

在数字化浪潮的推动下&#xff0c;人工智能&#xff08;AI&#xff09;正成为塑造未来的关键力量。硅纪元视角栏目紧跟AI科技的最新发展&#xff0c;捕捉行业动态&#xff1b;提供深入的新闻解读&#xff0c;助您洞悉技术背后的逻辑&#xff1b;汇聚行业专家的见解&#xff0c;…

SpringBoot集成Tomcat、DispatcherServlet

通过 SpringBoot 自动配置机制&#xff0c;导入配置类 利用 SpringBoot 自动配置机制&#xff0c;SpringBoot 会导入一个类型为 ServletWebServerFactoryAutoConfiguration 的配置类 ServletWebServerFactoryAutoConfiguration ServletWebServerFactoryAutoConfigurations 类上…

C# VS2019 Form 图标的修改

一、 窗口的左上角图标 1、Form的属性中找到Icon项直接选择图标&#xff08;.ico&#xff09;路径,窗口左上角会自动更新选择更新的图标。 Form属性 2.发布后的exe图标

谷粒商城实战笔记-48~49-商品服务-API-三级分类-查询-树形展示三级分类数据-前端优化

文章目录 一&#xff0c;48-商品服务-API-三级分类-查询-树形展示三级分类数据1&#xff0c;创建商品服务命名空间2&#xff0c;商品服务增加配置3&#xff0c;网关增加商品服务的路由配置4&#xff0c;前端树形展示5&#xff0c;测试 二&#xff0c;49-商品服务-API-三级分类-…

select for update作用

SELECT ... FOR UPDATE 是 MySQL 中用于实现行级锁的一种机制。它通常在事务处理中使用&#xff0c;以确保在读取和修改数据的过程中&#xff0c;事务不会对这些数据进行并发修改&#xff0c;从而避免脏读、不可重复读等并发问题。 以下是 SELECT ... FOR UPDATE 的主要作用和…

航空机载总线介绍——ARINC429总线

航空机载总线是现代航空电子系统中的重要组成部分&#xff0c;它们负责在机载电子设备之间传递信息&#xff0c;实现各个系统之间的协同工作。其中&#xff0c;ARINC429总线作为早期广泛应用于民用航空领域的数字式信息传输总线&#xff0c;具有其独特的技术特点和广泛的应用场…

Python酷库之旅-第三方库Pandas(044)

目录 一、用法精讲 151、pandas.Series.any方法 151-1、语法 151-2、参数 151-3、功能 151-4、返回值 151-5、说明 151-6、用法 151-6-1、数据准备 151-6-2、代码示例 151-6-3、结果输出 152、pandas.Series.autocorr方法 152-1、语法 152-2、参数 152-3、功能 …

守护Web安全:WebKit与内容安全策略(CSP)的深度解析

守护Web安全&#xff1a;WebKit与内容安全策略(CSP)的深度解析 随着网络安全威胁的不断增加&#xff0c;Web应用的安全性变得至关重要。内容安全策略&#xff08;Content Security Policy&#xff0c;简称CSP&#xff09;是一种网络安全标准&#xff0c;旨在防止跨站脚本攻击&…

线上语音交友平台成熟案例源码出售本地找搭子交友app软件线下陪玩系统开发服务

1、上麦相亲互动:直播间内除了红娘外&#xff0c;还有男女用户两个视频麦位&#xff0c;直播间符合要求的用户可以申请上麦, 2、公屏聊天:为上麦用户可以通过在公屏发言的方式参与直播间内的话题互动。 3、私信异性用户之间可以发送私信消息&#xff0c;通过付要或开通会员可解…

Composio

文章目录 一、关于 Composio为什么是Composo&#xff1f;&#x1f914;主要特点 &#x1f525;例子&#x1f4a1; 二、Python入门&#x1f680;1、安装2、马上测试 Composio 三、&#x1f680;Javascript入门1、安装Composo SDK&#xff1a;2、设置OpenAI和 Composio 工具集&am…

全志T113-S3裸机定时器驱动(timer0,timer1操作)

虽然只有2个定时器&#xff0c;但是好在是32bit的&#xff0c;日常使用刚好够&#xff0c;1个定时器当做StopWatch定时器&#xff0c;1us精度&#xff0c;用于时间测量&#xff0c;1个定时器给OS作为滴答时钟使用。 直接上代码&#xff1a; /********************************…

无线领夹麦克风哪个牌子好?几十块和几百块的领夹麦克风推荐

现如今视频自媒体行业还在蓬勃发展&#xff0c;麦克风对于自媒体行业可以说是必不可少的装备了&#xff0c;在互联网“内卷”的时代&#xff0c;各大视频博主、Up主、主播大多都会使用无线麦克风来辅助视频和直播内容输出。无线领夹麦克风作为视频行业中的麦克风新宠&#xff0…

深入理解TCP:互联网通信的基石

深入理解TCP&#xff1a;互联网通信的基石 引言TCP的普遍应用TCP连接的建立与维护三次握手&#xff08;Three-Way Handshake&#xff09;连接的可靠性与超时重传数据传输与流量控制连接的终止状态转换 TCP与UDP的对比TCP协议栈的层级结构应用层&#xff08;Application Layer&a…