点击上方 IT牧场 ，选择 置顶或者星标技术干货每日送达！
前置知识
在正式进入编写环节之前，建议先花一点时间了解下javaagent（这是JDK 5引入的一个玩意儿，最好了解下其工作原理）；另外，Skywalking用到了byte-buddy（一个动态操作二进制码的库），所以最好也熟悉下。
当然不了解关系也不大，一般不影响你玩转Skywalking。
•javaagent[1]•byte-buddy 1.9.6 简述及原理1[2]
术语
Span:可理解为一次方法调用，一个程序块的调用，或一次RPC/数据库访问。只要是一个具有完整时间周期的程序访问，都可以被认为是一个span。SkyWalking Span 对象中的重要属性
属性
名称
备注
component
组件
插件的组件名称，如：Lettuce，详见:ComponentsDefine.Class。
tag
标签
k-v结构，关键标签，key详见：Tags.Class。
peer
对端资源
用于拓扑图，若DB组件，需记录集群信息。
operationName
操作名称
若span=0，operationName将会搜索的下拉列表。
layer
显示
在链路页显示，详见SpanLayer.Class。
Trace:调用链，通过归属于其的Span来隐性的定义。一条Trace可被认为是一个由多个Span组成的有向无环图（DAG图），在SkyWalking链路模块你可以看到，Trace又由多个归属于其的trace segment组成。
Trace segment:Segment是SkyWalking中的一个概念，它应该包括单个OS进程中每个请求的所有范围，通常是基于语言的单线程。由多个归属于本线程操作的Span组成。
TIPS
Skywalking的这几个术语和Spring Cloud Sleuth类似，借鉴自谷歌的Dapper。我在 《Spring Cloud Alibaba微服务从入门到进阶》[3] 课程中有详细剖析调用链的实现原理，并且用数据库做了通俗的类比，本文不再赘述。
核心API
详见 http://www.itmuch.com/books/skywalking/guides/Java-Plugin-Development-Guide.html\[4\] 文章有非常详细的描述。
实战
本文以监控 org.apache.commons.lang3.StringUtils.replace 为例，手把手教你编写Skywalking插件。
依赖
首先，创建一个Maven项目，Pom.xml如下。
<?xml version="1.0" encoding="UTF-8"?>
这个Pom.xml中，除如下依赖以外，其他都得照抄，不管你开发什么框架的Skywalking插件，否则无法正常构建插件！！
<dependency>
编写Instrumentation类
public class StringReplaceInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
编写拦截器
public class StringReplaceInterceptor implements StaticMethodsAroundInterceptor {
编写配置文件
创建resources/skywalking-plugin.def ，内容如下：
# Key=value的形式
构建
mvn clean install
构建完成后，到target目录中，找到JAR包(非 origin-xxx.jar 、非xxx-source.jar )，扔到 agent/plugins 目录里面去，即可启动。
插件调试
插件的编写可能不是一步到位的，有时候可能会报点错什么的。如果想要Debug自己的插件，那么需要将你的插件代码和接入Java Agent的项目（也就是你配置了-javaagent启动的项目）扔到同一个工作空间内，可以这么玩：
•使用IDEA，打开接入Java Agent的项目•找到File->New->Module from Exisiting Sources…，引入你的插件源码即可。
测试与监控效果
想办法让你接入Java Agent的项目，调用到如下代码
String replace = StringUtils.replace("oldString", "old","replaced");
之后，就可以看到类似如下的图啦：
写在最后
本文只是弄了一个简单的例子，讲解插件编写的套路。总的来说，插件编写还是非常顺利的，单纯代码的层面，很少会遇到坑；但搜遍各种搜索引擎，竟然没有一篇手把手的文章…而且也没有文章讲解依赖该如何引入、Maven插件如何引入。于是只好参考Skywalking官方插件的写法，引入依赖和Maven插件了，这块反倒是费了点时间。
此外，如果你想真正掌握乃至精通skywalking插件编写，最好的办法，还是阅读官方的插件代码，详见：https://github.com/apache/skywalking/tree/master/apm-sniffer/apm-sdk-plugin ，随便挑两款看一下就知道怎么玩了。我在学习过程中参考的插件代码有：
•apm-feign-default-http-9.x-plugin•apm-jdbc-commons
参考文档
•Skywalking插件开发指南[5]•SkyWalking apm-sniffer原理学习与插件编写[6]•SkyWalking Java 插件贡献实践[7]
References
[1] javaagent: https://blog.csdn.net/qyongkang/article/details/7799603[2] byte-buddy 1.9.6 简述及原理1: https://blog.csdn.net/undergrowth/article/details/86493336[3] 《Spring Cloud Alibaba微服务从入门到进阶》: https://coding.imooc.com/class/358.html[4]: http://www.itmuch.com/books/skywalking/guides/Java-Plugin-Development-Guide.html[5] Skywalking插件开发指南: http://www.itmuch.com/books/skywalking/guides/Java-Plugin-Development-Guide.html[6] SkyWalking apm-sniffer原理学习与插件编写: https://skywalking.apache.org/zh/blog/2018-12-21-SkyWalking-apm-sniffer-beginning.html[7] SkyWalking Java 插件贡献实践: https://blog.csdn.net/weixin\_34262482/article/details/91379642
关注我
喜欢就点个"在看"呗^_^
本文分享自微信公众号 - IT牧场（itmuch_com）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。
