skywalking 插件源码分析

–> go to 总目录

一、总览

了解插架如何使用，和开发者的意图。可以在阅读源码时更明白源码处理的含义。

1.1 启动

启动命令
skywakling的使用插件的方式
java -javaagent:/path/to/skywalking-package/agent/skywalking-agent.jar -jar yourApp.jar
目录结构
下载的目录目录接口如下。

• skywalking-agent.jar就是核心的agent.jar
• activations 日志打印，这个目录下的插件会在日志里打印traceId
• config 配置
• plugins 会被使用的插件，放在这个目录下就能会自动加载
• optional plugins 有代价插件。目录下的插件开启时会影响性能，或者开启有条件限制。就放在这个/optional-plugins下仅仅是released 。想要开启需要移动到plugins目录下。
• bootstrap-plugins 风险插件。想要使用移动到plugins目录下。这个目录下的插件会有未知的风险。目前已知的有

Plugin of JDK HttpURLConnection. Agent is compatible with JDK 1.6+
Plugin of JDK Callable and Runnable. Agent is compatible with JDK 1.6+

1.2 写一个插件

sky-walking是如何做到捕获目标的方法，并生成trace数据的呢？
总得来讲，找到目标方法，修改目标方法字节码在目标方法的前后加入额外的方法。
一个span的生成，就像恰秒表，点一下开始，再点一下结束，这段时间里面发生的信息被算作一个span。
所以在before()中开始，在after()结束，就是一个最简单的span生成逻辑。

1.2.1 定义拦截规则

提供了两种拦截切点的方式

• ClassInstanceMethodsEnhancePluginDefine 会拦截构造器和实例的方法
• ClassStaticMethodsEnhancePluginDefine 会拦截静态方法

下面演示拦截的某个方法

定义拦截类

定义拦截点
这里用到bytebuddy的只是 ElemntMatcher就是bytebyte中用来匹配目标的方法，只有一个方法boolena matches(Object object)

1.2.2 配置插件定义

在文件 skywalking-plugin.def 中添加插件定义

1.2.3 实现一个拦截器

作为一个实例方法的拦截器, 需要实现。org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceMethodsAroundInterceptor

agent启动时，会根据前面的定义的拦截规则，命中要被修改的目标。
然后拦截器里面的方法会被bytebuddy，织入到目标。
织入之后的行为（比如before中的逻辑，则是用户自己定义的）。
一般是根据skywalking提供的生成span的逻辑，这个就需要开发者自己编写。
org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceMethodsAroundInterceptor

1.2.4 一个现成的插件

httpclient插件

如果你使用了httpclient这个库，你的每一次请求，都会到捕获生成一个span。

• 定义拦截器
  了解过httpclient的，就很清楚，发送request是底层会调用doExecute()方法。
  这里就是通过捕获这个方法，来捕获请求信息的。
  org.apache.http.impl.client.AbstractHttpClient.doExecute
  
• 配置拦截器
  定义了多个拦截器
  
• 定义拦截器行为（生成span）
  

二. 源码分析

2.1 源码位置

apm-sniffer

2.2 启动流程

最好能下载源码参照阅读

1. 启动&处理启动参数
2. 加载插件jar包
   a. 寻找所有jar包
   b. 加载skywalking.def文件
   c. 解析def问价，汇总所有插件
3. agentBuilder加载插件
   a. 使用bootstrapClassCoader加载skywalking工具类，加载 bytebuddy工具类，加载使用bootstrapClassCoader加载的插件
   b. 加载普通插件
4. serviceManagent Boot 服务启动
5. showndown关闭

2.1.1 启动&处理启动参数

java -javaagent:/path/to/skywalking-package/agent/skywalking-agent.jar -jar yourApp.jar

1. premain启动，进入premain
   

2. 加载配置。
   从jvm实例变量和环境变量中获取skywalking_config=config.path获取配置路径。
   否则加载/config/agent.config

3. 加载后的配置赋值给org.apache.skywalking.apm.agent.core.conf.Config
   配置keeper
   

2.1.2 加载插件

1. 获取 SystemClassloader

PluginBootstrap().loadPlugins() ----> AgentClassLoader.initDefaultLoader() ----> PluginBootstrap.class.getClassLoader()
描述SystemClassLoader加载agent

2. 设置路径集合：

AgentClassLoader的构造器添加插件路径： agentDir/plugins 和agentDdir/activations

3. 搜索插件jar包中"skywalking-plugin.def"

AgentClassLoader.getDefault().getResources("skywalking-plugin.def") —> AgentClassLoader.findResources(String name)
a. AgentClassLoader.findResources(String name) —> AgentClassLoader.getAllJars()
得到所有的jar包
b. 得到所有的skywalking-plugin.def文件路径
AgentClassLoader.findResources(String name) —>new URL("jar:file:" + jar.sourceFile.getAbsolutePath() + "!/" + name)
比如 jar:file:/agent//httpClient-4.x-plugin.jar!/skywalking-plugin.def

4. 加载skywalking-plugin.def内容

一个def文件如下。最小的单元是Instrumentation----定义了切点

PluginBootstrap().loadPlugins() ---->PluginCfg.INSTANCE.load(defUrl)
将所有的Instrumentation加载到
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-0sUia34k-1591201526750)(evernotecid://8EBEF415-ABC2-408F-A899-BEFE934875B0/appyinxiangcom/22606983/ENResource/p1975)]

5. * Instrumet类简介

一个插件类的结构
上面的切点定义Instrument都是AbstractClassEnhancePluginDefine</