快捷導(dǎo)航

SpringBoot鏈路追蹤skyworking的接入方法

更新時(shí)間：2024年10月08日 10:17:17 作者：碼至終章

在SpringBoot項(xiàng)目中引入SkyWalking進(jìn)行鏈路追蹤,需要下載探針jar包,配置logback.xml,設(shè)置啟動(dòng)變量,以實(shí)現(xiàn)服務(wù)調(diào)用監(jiān)控和錯(cuò)誤預(yù)警,本文給大家介紹SpringBoot鏈路追蹤skyworking的接入方法,感興趣的朋友一起看看吧

前言

開(kāi)發(fā)中遇到這樣的一個(gè)常見(jiàn)，服務(wù)之間調(diào)用需要鏈路追蹤，并且日志報(bào)錯(cuò)時(shí)能夠及時(shí)預(yù)警，最重要的一點(diǎn)是不要寫(xiě)太多的侵入式代碼，那么我們來(lái)捋捋常用的鏈路追蹤組件，有Google的Dapper，阿里的鷹眼，大眾點(diǎn)評(píng)的CAT，Twitter的Zipkin，LINE的pinpoint，國(guó)產(chǎn)的skywalking。從這些組件分析得出，skyworking是最符合我們的需求。本文也是介紹如何在自己的springboot項(xiàng)目中引入skyworking

探針jar包下載

開(kāi)始服務(wù)接入時(shí)，我們首先需要去把探針jar包下載下來(lái)（本章內(nèi)容測(cè)試用的是9.2），下載地址如下
https://archive.apache.org/dist/skywalking/java-agent/

pom文件

引入依賴(lài)，這里用的skyworking版本是9.2.0

<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-trace</artifactId>
    <version>9.2.0</version>
</dependency>
<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-logback-1.x</artifactId>
    <version>9.2.0</version>
</dependency>
<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-opentracing</artifactId>
    <version>9.2.0</version>
</dependency>
<!-- logback的版本信息-->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.2.3</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.5</version>
</dependency>

logback.xml文件

接著我們需要對(duì)自己服務(wù)的logback文件進(jìn)行內(nèi)容添加，其中包括日志的格式、控制臺(tái)的輸出、上傳的方式以及skyworking日志上報(bào)的等等，完整內(nèi)容如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
   <springProperty scope="context" name="applicationName" source="spring.application.name"/>
<!-- 日志存放路徑 -->
	<property name="log.path" value="/tmp/logDemo" />
   <!-- 日志輸出格式 -->
	<property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} ,[%X{tid}]  [%thread] %-5level %logger{50} - [%method:%line] %msg%n" />
    <!-- 控制臺(tái)輸出 -->
    <appender name="consol" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.mdc.TraceIdMDCPatternLogbackLayout">
                <Pattern>${log.pattern}</Pattern>
            </layout>
        </encoder>
    </appender>
	<!-- 設(shè)置異步方式上報(bào) -->
    <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>1024</queueSize>
        <neverBlock>true</neverBlock>
        <appender-ref ref="consol"/>
    </appender>
    <!--skywalking日志上報(bào)-->
    <appender name="grpc-log" class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.log.GRPCLogClientAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.mdc.TraceIdMDCPatternLogbackLayout">
                <Pattern>${log.pattern}</Pattern>
            </layout>
        </encoder>
    </appender>
    <!--日志文件-->
    <appender name="file_info" class="ch.qos.logback.core.FileAppender">
        <file>${log.path}/info.log</file>
        <!-- 循環(huán)政策：基于時(shí)間創(chuàng)建日志文件 -->
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
                <Pattern>${log.pattern}</Pattern>
            </layout>
        </encoder>
        <!-- 輸出INFO級(jí)別以上的日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
    </appender>
    <appender name="file_error" class="ch.qos.logback.core.FileAppender">
        <file>${log.path}/error.log</file>
        <!-- 循環(huán)政策：基于時(shí)間創(chuàng)建日志文件 -->
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
                <Pattern>${log.pattern}</Pattern>
            </layout>
        </encoder>
        <!-- 輸出ERROR級(jí)別日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>
    <root level="trace">
        <appender-ref ref="grpc-log" />
        <appender-ref ref="ASYNC"/>
    </root>
</configuration>

服務(wù)啟動(dòng)變量

在啟動(dòng)服務(wù)時(shí)需要加上一些啟動(dòng)變量，如

-javaagent:D:\skywalking-agent\skywalking-agent.jar
-Dskywalking.agent.service_name=easy-code::biz-api
-Dskywalking.collector.backend_service=192.168.111.111:11800

需要指定skyworking的服務(wù)地址（192.168.111.111:11800）
skywalking-agent.jar時(shí)skyworking提供的代碼jar包，記得需要把整個(gè)文件夾一起，不能單獨(dú)一個(gè)jar，否則會(huì)出現(xiàn)tid不顯示的情況
service_name表示該服務(wù)的服務(wù)名(log-test)，如果有多個(gè)服務(wù)想歸納到一個(gè)組，可以這樣設(shè)置(local::log-test)

啟動(dòng)項(xiàng)目

本次測(cè)試的是兩個(gè)服務(wù)之間進(jìn)行調(diào)用，具體是是biz-api服務(wù)調(diào)用user服務(wù)，調(diào)用方式為feign
啟動(dòng)項(xiàng)目后，我們可以看到控制臺(tái)有定時(shí)任務(wù)打印的日志，其中有我們執(zhí)行格式的tid