分布式服务调用链路追踪——Skywalking

SkyWalking是什么？

SkyWalking是一个可观测性分析平台和应用性能管理系统，提供分布式跟踪、服务网格遥测分析、度量聚合和可视化一体化解决方案，并支持多种开发语言。

官网：http://skywalking.apache.org/

特点：

性能好
针对单实例5000tps的应用，在全量采集的情况下，只增加 10% 的CPU开销。详细评测见《skywalking agent performance test》。
无代码嵌入，支持众多中间件
支持多语言探针
支持自动及手动探针
自动探针：Java支持的中间件、框架与类库列表
手动探针：OpenTrackingApi、@Trace注解、trackId集成到日志中。

SkyWalking 架构

说明：

SkyWalking 的核心是数据分析和度量结果的存储平台，通过 HTTP 或 gRPC 方式向 SkyWalking Collecter 提交分析和度量数据，

SkyWalking Collecter 对数据进行分析和聚合，存储到 Elasticsearch、H2、MySQL、TiDB 等其一即可，最后我们可以通过 SkyWalking UI 的可视化界面对最终的结果进行查看。

Skywalking 支持从多个来源和多种格式收集数据：多种语言的 Skywalking Agent 、Zipkin v1/v2 、Istio 勘测、Envoy 度量等数据格式。

整体架构看似模块有点多，但在实际上还是比较清晰的，主要就是通过收集各种格式的数据进行存储，然后展示。

所以搭建 Skywalking 服务我们需要关注的是 SkyWalking Collecter、SkyWalking UI 和存储设备，SkyWalking Collecter、SkyWalking UI 官方下载安装包内已包含，最终我们只需考虑存储设备即可。

安装部署

下载

SkyWalking支持单机与集群部署（默认standalone），并支持多种数据存储（默认H2），如mysql，Elasticsearch，Elasticsearch7等。

本文以SkyWalking8.4.0并使用Elasticsearch来存储数据进行讲解，ElasticSearch搭建请参考我的另外一篇文章。

SkyWalking下载地址：http://skywalking.apache.org/downloads/

由于要使用Elasticsearch，下载的时候请注意选择：

根据不同版本，点击tar后选择一个地址即可开始下载：

项目集成

1. 将skywalking主目录下的agent目录，拷贝到各服务所在机器上用作探针：

scp -r /opt/soft/skywalking/apache-skywalking-apm-bin-es7/agent chengjs@192.168.100.12:/opt/skywalking/

2. 修改 agent/config/agent.config 配置文件，也可以通过命令行参数指定。

主要是配置服务名称和后端服务地址：

# 服务名称
agent.service_name=${SW_AGENT_NAME:user-center}

# 采集信息的服务地址
collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:192.168.100.12:11800}

当然，也可以在启动的时候通过环境变量来设置，例如：

-Dskywalking.agent.service_name=masl
-Dskywalking.collector.backend_service=XXX.XXX.XXX.XXX:11800

#skywalking.agent.service_name 服务名称
#skywalking.collector.backend_service 采集信息的服务地址 agent.config配置了就可以不用指定

3. 最后，在服务启动的时候用相关命令行参数来指定探针：

Linux Tomcat

修改 tomcat/bin/catalina.sh,在首行加入如下信息：

CATALINA_OPTS="$CATALINA_OPTS -javaagent:/opt/skywalking/agent/skywalking-agent.jar"; export CATALINA_OPTS

JAR file

在启动你的应用程序的命令行中添加 -javaagent 参数. 并确保在-jar参数之前添加它. 例如:

java -javaagent:/opt/skywalking/agent/skywalking-agent.jar -jar yourApp.jar

或

java -javaagent:/opt/skywalking/agent/skywalking-agent.jar 
     -Dskywalking.agent.service_name=masl
     -Dskywalking.collector.backend_service=XXX.XXX.XXX.XXX:11800 
     -jar yourApp.jar

IDEA

-javaagent:D:\soft\apache-skywalking-apm-bin-es7\agent\skywalking-agent.jar -Dskywalking.agent.service_name=masl -Dskywalking.collector.backend_service=172.16.10.63:11800

4. 访问应用中服务后访问skywalking UI界面查看相应信息：

其它

日志输出TraceId

1. pom添加依赖项：

<!--打印skywalking的TraceId到日志-->
<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-logback-1.x</artifactId>
    <version>8.4.0</version>
</dependency>

2. logback日志layout使用 org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout，通过%tid输出trace-id（%tid必须小写）：

    <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.TraceIdPatternLogbackLayout">
                <Pattern>
                    %black(%d{ISO8601}) [%tid] %highlight(${LOG_LEVEL_PATTERN:-%5p}) [%blue(%t)] %yellow(%C{1.}): %msg%n%throwable
                </Pattern>
            </layout>
        </encoder>
    </appender>

3. 访问相关请求，输出日志如下：

将方法加入链路跟踪

业务代码中未被跟踪的方法，如果需要跟踪，则：

1. pom添加依赖项：

<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-trace</artifactId>
    <version>8.4.0</version>
</dependency>

2. 在方法上添加@Trace注解：

SkyWalking通过AOP实现跟踪，静态方法添加@Trace无效，只能用于实例方法；

Span中添加自定义Tag

链路跟踪只记录方法名，不记录参数值，可通过代码添加，在当前span上添加tag（必须是被SkyWalking跟踪的方法）：

ActiveSpan.tag("account", account);
ActiveSpan.tag("userId", String.valueOf(userId));

链路跟踪中即查看tag名称和值：

记录SQL语句参数值

在agent\config\agent.config文件中将plugin.mysql.trace_sql_parameters设为true。

自动收集日志

1、skywalking8.4.0版本开始才支持收集日志功能，同时pom需引用以下依赖（version对应skywalking的版本）：

<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-trace</artifactId>
    <version>8.4.0</version>
</dependency>

2、配置应用中的logback-spring.xml 文件：

<appender name="skywalking-grpc-log" class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.log.GRPCLogClientAppender"></appender>

同时要开启日志,且你要输出日志到文件中,grpc是利用本地日志去上传的：

<root level="info">
    <appender-ref ref="skywalking-grpc-log" />
</root>

3、打开你的agent/config/agent.config配置文件，添加如下配置信息,注意skywalking的log通信用的grpc：

# 指定要向其报告日志数据的grpc服务器的主机
plugin.toolkit.log.grpc.reporter.server_host=${SW_GRPC_LOG_SERVER_HOST:172.16.10.63}

# 指定要向其报告日志数据的grpc服务器的端口
plugin.toolkit.log.grpc.reporter.server_port=${SW_GRPC_LOG_SERVER_PORT:11800}

# 指定grpc客户端要报告的日志数据的最大大小
plugin.toolkit.log.grpc.reporter.max_message_size=${SW_GRPC_LOG_MAX_MESSAGE_SIZE:10485760}

# 客户端向上游发送数据时将超时多长时间。单位是秒
plugin.toolkit.log.grpc.reporter.upstream_timeout=${SW_GRPC_LOG_GRPC_UPSTREAM_TIMEOUT:30}

注：gRPC报告程序可以将收集到的日志转发到SkyWalking OAP服务器或SkyWalking Satellite卫星。

4、然后就可以在你的UI界面上看到：