全链路追踪工具SkyWalking使用入门

前言

SkyWalking简介

架构

前言

随着业务越来越复杂，企业应用也进入了分布式服务的阶段，传统的日志监控等方式无法很好达到跟踪调用，排查问题等需求。这是客套话，我们最常见的痛点便是性能优化，在优化时需要找到有问题的代码，以前介绍过使用Arthas排查问题或查找耗时代码，但是该工具毕竟是单一节点而且在遇到反射时常常无法展现，效果有限，此时则需要一款全链路追踪工具，最常用的有SkyWalking和Pinpoint。

SkyWalking简介

SkyWalking是一个针对分布式系统的APM（应用性能监控）系统，特别针对微服务、cloud native和容器化架构，其核心是个分布式追踪系统。它通过探针自动收集所需的指标，且基于探针技术对应用零侵入零耦合。通过这些调用链路以及指标，SkyWalking APM会感知应用间关系和服务间关系，并进行相应的指标统计。

架构

架构图如下：

总体来说可以粗略分为三个部分：

collector（收集器）：链路数据收集器，数据可以落地ElasticSearch，单机也可以落地H2，不推荐，H2仅作为临时演示用
agent（探针）：用来收集和发送数据到收集器
web：web可视化平台，用于展示落地的数据

入门使用

1、下载

可前往官网进行下载：http://skywalking.apache.org/zh/downloads/，mac下载linux下的tar包然后解压即可，这里下载的是6.6.0版本，解压后列表如下：

2、配置探针

前往agent/config/，找到agent.config配置文件，需要配置的就两个地方：

# 在web界面中展示的服务名
agent.service_name=${SW_AGENT_NAME:xxx}

# skyWalking服务所在地址，即该工具在哪里启动的，端口号不用改
collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:127.0.0.1:11800}

3、配置参数到需要监控的应用

以项目带了启动脚本为例，直接在启动参数中加上如下配置即可：

-javaagent:/xxx/agent/skywalking-agent.jar -Dskywalking_config=/xxx/agent/ticket/agent.config

后半段当然也可以不指定配置文件的方式，可以直接使用

-Dskywalking.agent.service_name=itsm-web -Dskywalking.collector.backend_service=10.1.61.165:11800

skyWalking所在的服务器可以和具体探针配置的机器分离，如果分离的话，在探针具体配置的机器上需要将整个agent文件夹移过去，如上面的/agent，注意这里的/xxx是全路径，后面的/ticket/xxx是对应微服务的配置文件，由于是分布式服务，因此需要分别配置

skywalking支持如下

4、配置skyWalking

如果有需要可以进行配置，若没有特殊要求可直接pass，其配置文件在/config/application.yml，大致分为三类：

core：收集器相关配置，支持http/gRPC收集
storage：收集数据存储，支持H2和ES
receiver-：可采集信息，jvm运行相关信息，zipkin追踪日志等

若只是临时调试可直接使用H2存储监控数据，这也是skyWalking的默认数据存储，一般线上都是需要持久化存储，可改为ES存储。如果skyWalking-web界面的8080端口冲突了的话可能会报错，可前往/webapp/webapp.yml进行修改

5、启动skyWalking

运行bin中startup.sh即可，执行后会启动如下两个服务：

Skywalking-Collector：追踪信息收集器，通过 gRPC/Http 收集客户端的采集信息，Http默认端口 12800，gRPC默认端口 11800。
Skywalking-Webapp：管理平台页面默认端口 8080，登录信息 admin/admin

6、查看服务

访问你skyWalking所在的地址，如localhost:8080，看到如下界面就说明启动成功

然后就可以自己使用啦，用的最多的是追踪一栏，即能看到各服务之间的整个调用链及耗时，一目了然。同时在仪表盘的Instance这里还能看到gc信息，更多功能可自行发现，这里也不截图了。

7、sw-web界面不显示数据

项目配置好参数启动后，需要通过访问项目的接口后，sw的web界面才会展示对应的服务，若此时web界面还是没有数据，请开启自动刷新！！！（之前被坑过一次）

探针技术

skyWalking是基于探针技术来实现链路追踪，其探针是使用javaAgent的两大字节码操作工具之一的Byte Buddy（另外一个是Javassist）实现的。这里就简单记录下javaagent知识：

1、javaAgent介绍

javaAgent是jdk1.5之后引入的新特性，该特性为用户提供了 jvm在将一个字节码文件读入内存之后，且在jvm使用对应的字节流在堆中生成一个class对象之前，用户可以修改字节码文件的能力，同时将会使用修改后的字节码文件来生成class对象。该特性有点像虚拟机级别的AOP，开发者无需对jdk做任何升级和改动，就可以实现某些AOP的功能。

java agent是java命令的一个参数，参数javaagent可以用于指定一个jar包，同时对该jar包有两个要求：

这个 jar 包的MANIFEST.MF 文件必须指定 Premain-Class 项。
Premain-Class 指定的那个类必须实现 premain（）方法。

重点就在premain方法，看字面意思就是说在main方法之前执行的方法。当java虚拟机启动时，在运行main方法之前，jvm会首先运行 -javaagent 参数指定的jar包中的 Premain-Class 类的 premain() 方法，该方法签名如下：

public static void premain(String agentArgs, Instrumentation inst)
public static void premain(String agentArgs)

且方法1的优先级高于方法2，即jvm会先选择方法1进行执行，agentArgs 是跟随 javaagent:xx.jar=yyy 传入的 yyy 字符串，instrumentation 是一个 java.lang.instrument.Instrumentation 实例，由本地方法实例化并由 jvm 自动传入，此类是 javaAgent 的核心类。

2、javaAgent使用

要想使用javaAgent，主要就是两点，编写MANIFEST.MF文件（该文件在META-INF目录下）以指定Agent的入口类，同时编写该入口类并实现premain方法。新建一个maven工程，编写入口类如下：

public class PremainTest {

    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("agentArgs : " + agentArgs);
        // 可以通过实现ClassFileTransformer来完成我们所希望的类字节码转换
        inst.addTransformer(new ClassFileTransformer() {
            @Override
            public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
                                    ProtectionDomain protectionDomain, byte[] classfileBuffer)
                    throws IllegalClassFormatException {
                System.out.println("premain load Class     :" + className);
                return classfileBuffer;
            }
        }, true);

    }
}

然后使用maven插件来生成MANIFEST.MF，自己编写的话最终打包时会被覆盖，因此还是插件最靠谱，pom中部分：

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <archive>
                        <!--自动添加META-INF/MANIFEST.MF -->
                        <manifest>
                            <addClasspath>true</addClasspath>
                        </manifest>
                        <manifestEntries>
                            <Premain-Class>demo.PremainTest</Premain-Class>
                            <Agent-Class>demo.PremainTest</Agent-Class>
                            <Can-Redefine-Classes>true</Can-Redefine-Classes>
                            <Can-Retransform-Classes>true</Can-Retransform-Classes>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>

然后将上述工程打包即可得到对应jar包，解压后MANIFEST.MF文件如下，可看到有正确指定Premain-Class项

Manifest-Version: 1.0
Premain-Class: demo.PremainTest
Built-By: xujia
Agent-Class: demo.PremainTest
Can-Redefine-Classes: true
Can-Retransform-Classes: true
Created-By: Apache Maven 3.5.4
Build-Jdk: 1.8.0_172

最后随便编写一个测试类如下，然后使用javaagent参数来启动该代理测试方法

public class AgentTest {

    public static void main(String[] args) {
        System.out.println("This is main method ~");
    }
}

-javaagent可指定多个jar包，加载顺序为从前往后，且每一个-javaagent都是独立的，都会有其自己的agent和agent数据。

关于上面的类转换器 ClassFileTransformer，它的作用就是在jvm将某个类的字节码文件读入内存时，但还没生成该类的class对象之前，jvm会遍历所有的 instrumentation 实例并执行其中所有的 ClassFileTransformer 的 transform 方法，关于该方法入参，重点需要关注的有：

className：当前类的限定类名
classfileBuffer：当前类的以 byte 数组呈现的字节码数据（可能跟 class 文件的数据不一致, 因为此处的 byte 数据是此类最新的字节码数据，即此数据可能是原始字节码数据被其他增强方法增强之后的新数据）