Springboot项目集成SkyWalking链路追踪系统实战指南_Java

springboot项目集成skywalking链路追踪系统

将 skywalking 链路追踪系统集成到 spring boot 项目中，可以帮助你监控和跟踪微服务架构中的请求流，获取详细的性能数据、调用链信息等。下面是如何在 spring boot 项目中集成 skywalking 链路追踪的基本步骤。

1. 准备工作

1.1 部署skywalking

使用的版本：9.2.0

参考文档：使用docker部署spring boot并接入skywalking的方法

网址地址：https://www.jb51.net/article/210119.htm

1.2 下载 skywalking agent

同样在skywalking的官网中下载java agent：https://skywalking.apache.org/downloads/

下载后解压，获取目录skywalking-agent，放在合适的路径上。

2. 配置java agent需要的主要参数

在启动 spring boot 应用时，添加 skywalking agent 配置。用于重写 agent/config/agent.config 配置文件中的配置参数值。主要配置参数如下：

解压后的 skywalking agent 文件路径

-javaagent:/path/to/skywalking-agent/skywalking-agent.jar

指定你的服务名称，skywalking 会以这个名称显示在监控面板中。sw_agent_name的命名规则，采用双冒号（如ctos::container_sit）,冒号前的文本字符串将作为组名。

agent.service_name=${sw_agent_name:your_applicationname}

指定 skywalking 后端服务的 ip 和端口（默认是 11800，若你使用其他端口，请替换）。

collector.backend_service=${sw_agent_collector_backend_services:127.0.0.1:11800}

考虑到安全因素，部署的skywalking增加了grpc（11880端口）连接是需要token认证。需要看部署时候是否配置sw_authentication。

agent.authentication=${sw_agent_authentication:}

2.1 使用jar命令启动

在启动 spring boot 应用时，添加 skywalking agent 配置。

把skywalking-agent.jar地址、your-service-name、your-collector-ip:port、your-authentication-token、your-spring-boot-app替换为实际值。

2.1.1 方式一

java -javaagent:/path/to/skywalking-agent/skywalking-agent.jar \
-dskywalking.agent.service_name=your-service-name \
-dskywalking.collector.backend_service=your-collector-ip:port \
-dskywalking.agent.authentication=your-authentication-token \
-jar your-spring-boot-app.jar

2.1.2 方式二

java -javaagent:/path/to/skywalking-agent/skywalking-agent.jar=agent.service_name=your-service-name,collector.backend_service=your-collector-ip:port,agent.authentication=your-authentication-token -jar your-spring-boot-app.jar

2.1.3 参数区别

通过方式一和方式二，可以看到使用方式一中-d设置参数多了skywalking前缀

2.2 利用idea启动

2.2.1 打开idea开发工具run-》edit configurations

2.2.2 配置启动参数

方式一

点击modify options -》add vm option

方式二

vm option中配置

-javaagent:/path/to/skywalking-agent/skywalking-agent.jar=agent.service_name=your-service-name,collector.backend_service=your-collector-ip:port,agent.authentication=your-authentication-token

方式三

个人比较喜欢采用环境变量的方法接入，方式如下

vm option中配置

-javaagent:/path/to/skywalking-agent/skywalking-agent.jar

点击modify options -》environment variables，新增环境变量

环境变量	描述
sw_agent_name	服务名
sw_agent_collector_backend_services	注册地址
ssw_agent_authentication	grpc认证的token

2.3 容器化服务部署（kubernetes、docker）

2.3.1 拷贝文件

使用容器化部署，需要把skywalking-agent目录拷贝在镜像里面中，利用dockerfile

# 替换image为自己使用的镜像
from image
copy ./skywalking-agent /usr/local/skywalking-agent

使用build命令生成新的基础镜像

docker build -t new_image .

2.3.2 环境变量（env）配置

环境变量	描述
java_tool_options	额外的 jvm
sw_agent_name	服务名
sw_agent_collector_backend_services	注册地址
ssw_agent_authentication	grpc认证的token

java_tool_options的value配置为

# 替换为skywalking-agent.jar在容器中的实际地址
-javaagent:/path/to/skywalking-agent/skywalking-agent.jar

3. 验证是否连接成功

启动应用后，访问 skywalking 后端（通常是 http://127.0.0.1:8080，取决于你的 skywalking 后端配置）查看你的应用是否已经在 skywalking 控制台上显示。

但是这时候我们发现，打开log，发现并没有日志。如果如果有日志需求，我们可以根据下一步操作接入服务日志。

4. 日志对接

在skywalking的ui端有一个日志的模块，用于收集客户端的日志，默认是没有数据的，那么需要如何将项目中产生日志数据传输到skywalking中

4.1 在springboot项目中导入相关依赖

        <!--打印skywalking的traceid到日志-->
        <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>

部署的时候可以替换自己使用的实际版本。

4.2 logback.xml配置

<?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="logs/app" />
    <!-- 日志输出格式 -->
    <property name="log.pattern" value="%d{yyyy-mm-dd hh:mm:ss.sss} ,[%x{tid}]  [%thread] %-5level %logger{50} - [%method:%line] %msg%n" />
    <!-- 控制台输出 -->
    <appender name="console" 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>
    <!-- 设置异步方式上报 -->
    <appender name="async" class="ch.qos.logback.classic.asyncappender">
        <discardingthreshold>0</discardingthreshold>
        <queuesize>1024</queuesize>
        <neverblock>true</neverblock>
        <appender-ref ref="console"/>
    </appender>
    <!--skywalking日志上报-->
    <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>
        <!-- 循环政策：基于时间创建日志文件 -->
        <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级别以上的日志 -->
        <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>
        <!-- 循环政策：基于时间创建日志文件 -->
        <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级别日志 -->
        <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>