SkyWalking 自定义插件(Spring RabbitMQ)具体分析过程

以下是“SkyWalking 自定义插件(Spring RabbitMQ)具体分析过程”的完整攻略，包含两个示例。

简介

在本攻略中，我们将介绍如何使用SkyWalking自定义插件来监控Spring RabbitMQ。通过本攻略的学习，您将掌握如何使用SkyWalking自定义插件来监控Spring RabbitMQ。

示例一：创建SkyWalking自定义插件

以下是创建SkyWalking自定义插件的示例：

1. 创建插件项目

在创建插件项目时，可以使用以下命令：

bash
mvn archetype:generate -DgroupId=org.apache.skywalking.plugin -DartifactId=skywalking-rabbitmq-plugin -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

这里我们使用了mvn命令创建了一个名为skywalking-rabbitmq-plugin的Maven项目。

1. 添加依赖

在添加依赖时，可以使用以下代码：

xml
<dependency>
<groupId>org.apache.skywalking</groupId>
<artifactId>apm-toolkit-trace</artifactId>
<version>${skywalking.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.amqp</groupId>
<artifactId>spring-rabbit</artifactId>
<version>${spring.rabbit.version}</version>
</dependency>

这里我们添加了apm-toolkit-trace和spring-rabbit两个依赖。

1. 实现插件

在实现插件时，可以使用以下代码：

```java
@Component
public class RabbitMQPlugin extends AbstractClassEnhancePluginDefine {

   private static final String ENHANCE_CLASS = "org.springframework.amqp.rabbit.core.RabbitTemplate";

   private static final String ENHANCE_METHOD = "doSend";

   private static final String INTERCEPTOR_CLASS = "org.apache.skywalking.apm.plugin.rabbitmq.RabbitMQInterceptor";

   @Override
   protected ClassMatch enhanceClass() {
       return NameMatch.byName(ENHANCE_CLASS);
   }

   @Override
   public ConstructorInterceptor[] getConstructorsInterceptors() {
       return new ConstructorInterceptor[0];
   }

   @Override
   public InstanceMethodsInterceptPoint[] getInstanceMethodsInterceptPoints() {
       return new InstanceMethodsInterceptPoint[] {
               new InstanceMethodsInterceptPoint() {
                   @Override
                   public ElementMatcher<MethodDescription> getMethodsMatcher() {
                       return named(ENHANCE_METHOD);
                   }

                   @Override
                   public String getMethodsInterceptor() {
                       return INTERCEPTOR_CLASS;
                   }

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

}
```

这里我们创建了一个名为RabbitMQPlugin的类，并继承了AbstractClassEnhancePluginDefine类。在RabbitMQPlugin类中，我们实现了enhanceClass、getConstructorsInterceptors和getInstanceMethodsInterceptPoints三个方法。其中，enhanceClass方法用于指定需要增强的类，getConstructorsInterceptors方法用于指定需要增强的构造方法，getInstanceMethodsInterceptPoints方法用于指定需要增强的实例方法。

在创建SkyWalking自定义插件时，我们使用了mvn命令创建了一个名为skywalking-rabbitmq-plugin的Maven项目，并添加了apm-toolkit-trace和spring-rabbit两个依赖。同时，我们创建了一个名为RabbitMQPlugin的类，并继承了AbstractClassEnhancePluginDefine类。在RabbitMQPlugin类中，我们实现了enhanceClass、getConstructorsInterceptors和getInstanceMethodsInterceptPoints三个方法，用于指定需要增强的类、构造方法和实例方法。

示例二：实现SkyWalking自定义插件

以下是实现SkyWalking自定义插件的示例：

1. 创建拦截器

在创建拦截器时，可以使用以下代码：

```java
public class RabbitMQInterceptor implements InstanceMethodsAroundInterceptor {

   @Override
   public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, MethodInterceptResult result) throws Throwable {
       TracingContext tracingContext = ContextManager.getTracingContext();
       AbstractSpan span = ContextManager.createExitSpan("RabbitMQ/doSend", tracingContext.getReadableGlobalTraceId(), "localhost:5672");
       Tags.MQ_BROKER.set(span, "localhost:5672");
       Tags.MQ_TOPIC.set(span, allArguments[0].toString());
       Tags.MQ_MESSAGE_ID.set(span, allArguments[2].toString());
       Tags.MQ_MESSAGE_BODY.set(span, allArguments[3].toString());
       span.setComponent(ComponentsDefine.RABBITMQ);
   }

   @Override
   public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, Object ret) throws Throwable {
       ContextManager.stopSpan();
       return ret;
   }

   @Override
   public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, Throwable t) {

   }

}
```

这里我们创建了一个名为RabbitMQInterceptor的类，并实现了InstanceMethodsAroundInterceptor接口。在RabbitMQInterceptor类中，我们实现了beforeMethod、afterMethod和handleMethodException三个方法。其中，beforeMethod方法用于在方法执行前创建Span，afterMethod方法用于在方法执行后结束Span，handleMethodException方法用于处理方法执行异常。

1. 配置插件

在配置插件时，可以使用以下代码：

yaml
plugin:
rabbitmq:
enabled: true

这里我们在skywalking-agent-config.yaml文件中添加了一个名为rabbitmq的插件，并将enabled属性设置为true。

在实现SkyWalking自定义插件时，我们创建了一个名为RabbitMQInterceptor的类，并实现了InstanceMethodsAroundInterceptor接口。在RabbitMQInterceptor类中，我们实现了beforeMethod、afterMethod和handleMethodException三个方法，用于创建Span、结束Span和处理方法执行异常。同时，我们在skywalking-agent-config.yaml文件中添加了一个名为rabbitmq的插件，并将enabled属性设置为true。

结论

通过使用SkyWalking自定义插件，我们可以很方便地监控Spring RabbitMQ。在本攻略中，我们介绍了如何创建和实现SkyWalking自定义插件，并提供了示例代码。