手把手教你编写Skywalking插件

在正式进入编写环节之前，建议先花一点时间了解下javaagent（这是JDK 5引入的一个玩意儿，最好了解下其工作原理）；另外，Skywalking用到了byte-buddy（一个动态操作二进制码的库），所以最好也熟悉下。

当然不了解关系也不大，一般不影响你玩转Skywalking。

• javaagent
• byte-buddy 1.9.6 简述及原理1

Span:可理解为一次方法调用，一个程序块的调用，或一次RPC/数据库访问。只要是一个具有完整时间周期的程序访问，都可以被认为是一个span。SkyWalking Span 对象中的重要属性

Trace:调用链，通过归属于其的Span来隐性的定义。一条Trace可被认为是一个由多个Span组成的有向无环图（DAG图），在SkyWalking链路模块你可以看到，Trace又由多个归属于其的trace segment组成。

Trace segment:Segment是SkyWalking中的一个概念，它应该包括单个OS进程中每个请求的所有范围，通常是基于语言的单线程。由多个归属于本线程操作的Span组成。

TIPS

Skywalking的这几个术语和Spring Cloud Sleuth类似，借鉴自谷歌的Dapper。我在 《Spring Cloud Alibaba微服务从入门到进阶》 课程中有详细剖析调用链的实现原理，并且用数据库做了通俗的类比，本文不再赘述。

详见 http://www.itmuch.com/books/skywalking/guides/Java-Plugin-Development-Guide.html 文章有非常详细的描述。

本文以监控 org.apache.commons.lang3.StringUtils.replace 为例，手把手教你编写Skywalking插件。

首先，创建一个Maven项目，Pom.xml如下。

    4.0.0

    com.itmuch.skywalking
    apm-string-replace-plugin
    jar
    1.0.0-SNAPSHOT

    
 6.6.0
 org.apache.skywalking.apm.dependencies
 net.bytebuddy
 ${shade.package}.${shade.net.bytebuddy.source}
    

    
 
     org.apache.skywalking
     apm-agent-core
     ${skywalking.version}
     provided
 

 
     org.apache.skywalking
     apm-util
     ${skywalking.version}
     provided
 

 
     org.apache.commons
     commons-lang3
     3.4
     provided
 
    

    
 
     
  maven-shade-plugin
  
      
   package
   
shade
   
   
false
true
true
true

    
 ${shade.net.bytebuddy.source}
 ${shade.net.bytebuddy.target}
    

   
      
  
     
     
  org.apache.maven.plugins
  maven-compiler-plugin
  
      6
      6
  
     
 
    

  org.apache.commons
  commons-lang3
  3.4
  provided

public class StringReplaceInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
    @Override
    protected ClassMatch enhanceClass() {
 // 指定想要监控的类
 return NameMatch.byName("org.apache.commons.lang3.StringUtils");
    }

    @Override
    public ConstructorInterceptPoint[] getConstructorsInterceptPoints() {
 return new ConstructorInterceptPoint[0];
    }

    @Override
    public InstanceMethodsInterceptPoint[] getInstanceMethodsInterceptPoints() {
 // 指定想要监控的实例方法，每个实例方法对应一个InstanceMethodsInterceptPoint
 return new InstanceMethodsInterceptPoint[0];
    }

    @Override
    public StaticMethodsInterceptPoint[] getStaticMethodsInterceptPoints() {
 // 指定想要监控的静态方法，每一个方法对应一个StaticMethodsInterceptPoint
 return new StaticMethodsInterceptPoint[]{
     new StaticMethodsInterceptPoint() {
  @Override
  public ElementMatcher getMethodsMatcher() {
      // 静态方法名称
      return ElementMatchers.named("replace");
  }

  @Override
  public String getMethodsInterceptor() {
      // 该静态方法的监控拦截器类名全路径
      return "com.itmuch.skywalking.plugin.stringreplace.StringReplaceInterceptor";
  }

  @Override
  public boolean isOverrideArgs() {
      return false;
  }
     }
 };
    }
}

public class StringReplaceInterceptor implements StaticMethodsAroundInterceptor {
    @Override
    public void beforeMethod(Class aClass, Method method, Object[] argumentsTypes, Class[] classes, MethodInterceptResult methodInterceptResult) {
 // 创建span(监控的开始)，本质上是往ThreadLocal对象里面设值
 AbstractSpan span = ContextManager.createLocalSpan("replace");

 
 span.setComponent(ComponentsDefine.TOMCAT);

 span.tag(new StringTag(1000, "params"), argumentsTypes[0].toString());
 // 指定该调用的layer，layer是个枚举
 span.setLayer(SpanLayer.CACHE);
    }

    @Override
    public Object afterMethod(Class aClass, Method method, Object[] objects, Class[] classes, Object o) {
 String retString = (String) o;
 // 激活span，本质上是读取ThreadLocal对象
 AbstractSpan span = ContextManager.activeSpan();
 // 状态码，任意写，Tags也是个Skywalking的工具类，用来比较方便地操作tag
 Tags.STATUS_CODE.set(span, "20000");

 // 停止span(监控的结束)，本质上是清理ThreadLocal对象
 ContextManager.stopSpan();
 return retString;
    }

    @Override
    public void handleMethodException(Class aClass, Method method, Object[] objects, Class[] classes, Throwable throwable) {
 AbstractSpan activeSpan = ContextManager.activeSpan();
 
 // 记录日志
 activeSpan.log(throwable);
 activeSpan.errorOccurred();
    }
}

# Key=value的形式
# key随便写；value是Instrumentation类的包名类名全路径
my-string-replace-
plugin=org.apache.skywalking.apm.plugin.stringreplace.define.StringReplaceInstrumentation

mvn clean install

String replace = StringUtils.replace("oldString", "old","replaced");
System.out.println(replace);