SpringBoot项目无缝集成SkyWalking:实现分布式追踪与日志透传实战

一、引言

Apache SkyWalking 是一款开源的应用性能监视工具,特别适合于微服务架构下的应用性能管理和分布式追踪。本文将手把手教你如何将SkyWalking整合到Spring Boot项目中,实现服务链路追踪,并同步改造日志中的Transaction ID,便于日志关联和问题定位。

二、集成SkyWalking步骤

  1. 添加依赖

    在Spring Boot项目的pom.xml文件中添加SkyWalking的starter依赖:

    <dependency>
        <groupId>org.apache.skywalking</groupId>
        <artifactId>apm-spring-boot-starter</artifactId>
        <version>{latest_version}</version>
    </dependency>
    

    替换 {latest_version} 为最新的SkyWalking版本号。

  2. 配置SkyWalking

    application.ymlapplication.properties 文件中配置SkyWalking的服务地址:

    skywalking:
      agent:
        service_name: your-service-name
        collector_backend_service: ${SW_AGENT_COLLECTOR_BACKEND_SERVICE:localhost:11800}
    
  3. 启动应用

    无需额外改动,只需正常启动Spring Boot应用,SkyWalking探针将会自动接入并开始收集跟踪数据。

三、改造日志透传Transaction ID

为了将SkyWalking的Trace ID和Span ID传递到日志中,我们可以使用SkyWalking提供的API来获取当前上下文的Trace信息,并将其加入到日志模板中。

  1. 引入SkyWalking Tracing工具类

    在需要打印日志的地方,注入org.apache.skywalking.apm.toolkit.trace.TraceContext工具类。

    java 复制代码
    import org.apache.skywalking.apm.toolkit.trace.TraceContext;
    ...
    
    @Component
    public class YourService {
        ...
    }
  2. 定制日志输出格式

    修改日志框架配置,例如对于Logback,可以在logback.xml中添加变量引用:

    XML 复制代码
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg [%X{traceId:-},%X{spanId:-}]%n</pattern>
        </encoder>
    </appender>

    在日志输出模板中,使用${X{traceId:-},X{spanId:-}}引用SkyWalking的Trace ID和Span ID。

  3. 在业务代码中填充Trace信息

    在需要打印日志的方法中,获取并设置Trace ID和Span ID到MDC(Mapped Diagnostic Context)中:

    java 复制代码
    public void yourMethod() {
        String traceId = TraceContext.traceId();
        String spanId = TraceContext.spanId();
        MDC.put("traceId", traceId);
        MDC.put("spanId", spanId);
    
        // 业务逻辑...
        
        logger.info("Your log message");
    }

    这样,每次打印日志时,都会携带当前请求的Trace ID和Span ID,极大方便了日志关联和分布式追踪。

四、总结

通过以上步骤,我们成功地将SkyWalking集成到了Spring Boot项目中,并实现了日志中的Transaction ID(即Trace ID)的透传。这将极大地助力于我们对分布式系统的性能监控和问题诊断。在实际项目中,可以根据需求进一步优化日志输出格式和追踪粒度,以适应更为复杂的微服务架构环境。

相关推荐
天天进步20155 分钟前
Vue+Springboot用Websocket实现协同编辑
vue.js·spring boot·websocket
乌啼霜满天24944 分钟前
Spring 与 Spring MVC 与 Spring Boot三者之间的区别与联系
java·spring boot·spring·mvc
tangliang_cn1 小时前
java入门 自定义springboot starter
java·开发语言·spring boot
Grey_fantasy1 小时前
高级编程之结构化代码
java·spring boot·spring cloud
苹果酱05672 小时前
前端面试vue篇:Vue2 和 Vue3 在设计和性能上有显著区别
java·spring boot·毕业设计·layui·课程设计
刘大浪2 小时前
后端数据增删改查基于Springboot+mybatis mysql 时间根据当时时间自动填充,数据库连接查询不一致,mysql数据库连接不好用
数据库·spring boot·mybatis
一只爱撸猫的程序猿2 小时前
简单实现一个系统升级过程中的数据平滑迁移的场景实例
数据库·spring boot·程序员
陌小呆^O^3 小时前
Cmakelist.txt之Liunx-rabbitmq
分布式·rabbitmq
攻心的子乐3 小时前
shell脚本启动springboot项目
spring boot
程序媛-徐师姐3 小时前
Java 基于SpringBoot+vue框架的老年医疗保健网站
java·vue.js·spring boot·老年医疗保健·老年 医疗保健