Upgrade nats plugin to expand support to 2.16.5 (#711)

apache · Jul 27, 2024 · 24ec663 · 24ec663
1 parent 92b09c9
commit 24ec663
Show file tree

Hide file tree

Showing 46 changed files with 69 additions and 29 deletions.
diff --git a/.github/workflows/plugins-test.3.yaml b/.github/workflows/plugins-test.3.yaml
@@ -67,7 +67,7 @@ jobs:
           - vertx-web-3.6plus-scenario
           - mariadb-scenario
           - micronaut-http-scenario
-          - nats-2.14.x-2.15.x-scenario
+          - nats-2.14.x-2.16.5-scenario
           - quasar-scenario
           - baidu-brpc-scenario
           - baidu-brpc-3.x-scenario

diff --git a/CHANGES.md b/CHANGES.md
@@ -5,6 +5,7 @@ Release Notes.
 9.4.0
 ------------------
 
+* Upgrade nats plugin to support 2.16.5
 
 
 All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/222?closed=1)

diff --git a/...-plugin/nats-2.14.x-2.15.x-plugin/pom.xml → ...-plugin/nats-2.14.x-2.16.5-plugin/pom.xml b/...-plugin/nats-2.14.x-2.15.x-plugin/pom.xml → ...-plugin/nats-2.14.x-2.16.5-plugin/pom.xml
@@ -26,7 +26,7 @@
 
     <modelVersion>4.0.0</modelVersion>
 
-    <artifactId>nats-2.14.x-2.15.x-plugin</artifactId>
+    <artifactId>nats-2.14.x-2.16.5-plugin</artifactId>
     <packaging>jar</packaging>
 
     <properties>

diff --git a/...s/client/CreateDispatcherInterceptor.java → ...s/client/CreateDispatcherInterceptor.java b/...s/client/CreateDispatcherInterceptor.java → ...s/client/CreateDispatcherInterceptor.java
diff --git a/...gin/nats/client/CreateSubInterceptor.java → ...gin/nats/client/CreateSubInterceptor.java b/...gin/nats/client/CreateSubInterceptor.java → ...gin/nats/client/CreateSubInterceptor.java
diff --git a/.../nats/client/DeliverReplyInterceptor.java → .../nats/client/DeliverReplyInterceptor.java b/.../nats/client/DeliverReplyInterceptor.java → .../nats/client/DeliverReplyInterceptor.java
diff --git a/...g/apm/plugin/nats/client/NatsCommons.java → ...g/apm/plugin/nats/client/NatsCommons.java b/...g/apm/plugin/nats/client/NatsCommons.java → ...g/apm/plugin/nats/client/NatsCommons.java
diff --git a/...nnectionWriterConstructorInterceptor.java → ...nnectionWriterConstructorInterceptor.java b/...nnectionWriterConstructorInterceptor.java → ...nnectionWriterConstructorInterceptor.java
diff --git a/.../NatsJetStreamConstructorInterceptor.java → .../NatsJetStreamConstructorInterceptor.java b/.../NatsJetStreamConstructorInterceptor.java → .../NatsJetStreamConstructorInterceptor.java
diff --git a/...n/nats/client/NatsMessageInterceptor.java → ...n/nats/client/NatsMessageInterceptor.java b/...n/nats/client/NatsMessageInterceptor.java → ...n/nats/client/NatsMessageInterceptor.java
diff --git a/...tsSubscriptionConstructorInterceptor.java → ...tsSubscriptionConstructorInterceptor.java b/...tsSubscriptionConstructorInterceptor.java → ...tsSubscriptionConstructorInterceptor.java
diff --git a/...lient/SubscriptionNextMsgInterceptor.java → ...lient/SubscriptionNextMsgInterceptor.java b/...lient/SubscriptionNextMsgInterceptor.java → ...lient/SubscriptionNextMsgInterceptor.java
diff --git a/...n/nats/client/WriterQueueInterceptor.java → ...n/nats/client/WriterQueueInterceptor.java b/...n/nats/client/WriterQueueInterceptor.java → ...n/nats/client/WriterQueueInterceptor.java
diff --git a/...nt/WriterSendMessageBatchInterceptor.java → ...nt/WriterSendMessageBatchInterceptor.java b/...nt/WriterSendMessageBatchInterceptor.java → ...nt/WriterSendMessageBatchInterceptor.java
diff --git a/...a/org/apache/skywalking/apm/plugin/nats/client/define/AbstractWitnessInstrumentation.java b/...a/org/apache/skywalking/apm/plugin/nats/client/define/AbstractWitnessInstrumentation.java
@@ -0,0 +1,43 @@
+/*
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements.  See the NOTICE file distributed with
+ *   this work for additional information regarding copyright ownership.
+ *   The ASF licenses this file to You under the Apache License, Version 2.0
+ *   (the "License"); you may not use this file except in compliance with
+ *   the License.  You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+package org.apache.skywalking.apm.plugin.nats.client.define;
+
+import java.util.Collections;
+import java.util.List;
+import org.apache.skywalking.apm.agent.core.plugin.WitnessMethod;
+import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;
+
+import static net.bytebuddy.matcher.ElementMatchers.named;
+
+public abstract class AbstractWitnessInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
+
+    /*
+     * Currently, we only support 2.14.x-2.16.5, as there is no proper way and opportunity
+     * to change the message header and re-calculate the message length for 2.16.5+ yet.
+     * This method prevents users from applying this plugin to unsupported versions,
+     * which may cause unknown errors.
+     * For more information: https://github.com/apache/skywalking/discussions/11650
+     */
+    @Override
+    protected List<WitnessMethod> witnessMethods() {
+        return Collections.singletonList(new WitnessMethod(
+            "io.nats.client.impl.NatsMessage",
+            named("calculateIfDirty")
+        ));
+    }
+}
diff --git a/...define/NatsConnectionInstrumentation.java → ...define/NatsConnectionInstrumentation.java b/...define/NatsConnectionInstrumentation.java → ...define/NatsConnectionInstrumentation.java
@@ -21,14 +21,13 @@
 import net.bytebuddy.matcher.ElementMatcher;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
-import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;
 import org.apache.skywalking.apm.agent.core.plugin.match.ClassMatch;
 
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
 import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
 
-public class NatsConnectionInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
+public class NatsConnectionInstrumentation extends AbstractWitnessInstrumentation {
 
     private static final String ENHANCE_CLASS = "io.nats.client.impl.NatsConnection";
 
@@ -82,4 +81,4 @@ public boolean isOverrideArgs() {
                 }
         };
     }
-}
+}
diff --git a/.../NatsConnectionWriterInstrumentation.java → .../NatsConnectionWriterInstrumentation.java b/.../NatsConnectionWriterInstrumentation.java → .../NatsConnectionWriterInstrumentation.java
@@ -21,14 +21,13 @@
 import net.bytebuddy.matcher.ElementMatcher;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
-import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;
 import org.apache.skywalking.apm.agent.core.plugin.match.ClassMatch;
 
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
 import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
 
-public class NatsConnectionWriterInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
+public class NatsConnectionWriterInstrumentation extends AbstractWitnessInstrumentation {
 
     private static final String ENHANCE_CLASS = "io.nats.client.impl.NatsConnectionWriter";
     private static final String PUBLISH_INTERCEPTOR_CLASS_NAME = "org.apache.skywalking.apm.plugin.nats.client.WriterSendMessageBatchInterceptor";

diff --git a/.../define/NatsJetStreamInstrumentation.java → .../define/NatsJetStreamInstrumentation.java b/.../define/NatsJetStreamInstrumentation.java → .../define/NatsJetStreamInstrumentation.java
@@ -21,14 +21,13 @@
 import net.bytebuddy.matcher.ElementMatcher;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
-import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;
 import org.apache.skywalking.apm.agent.core.plugin.match.ClassMatch;
 
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
 import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
 
-public class NatsJetStreamInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
+public class NatsJetStreamInstrumentation extends AbstractWitnessInstrumentation {
 
     private static final String ENHANCE_CLASS = "io.nats.client.impl.NatsJetStream";
     private static final String CREATE_SUB_INTERCEPTOR = "org.apache.skywalking.apm.plugin.nats.client.CreateSubInterceptor";
@@ -78,4 +77,4 @@ public boolean isOverrideArgs() {
         };
     }
 
-}
+}
diff --git a/...nt/define/NatsMessageInstrumentation.java → ...nt/define/NatsMessageInstrumentation.java b/...nt/define/NatsMessageInstrumentation.java → ...nt/define/NatsMessageInstrumentation.java
@@ -21,7 +21,6 @@
 import net.bytebuddy.matcher.ElementMatcher;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
-import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;
 import org.apache.skywalking.apm.agent.core.plugin.match.ClassMatch;
 
 import static net.bytebuddy.matcher.ElementMatchers.named;
@@ -35,7 +34,7 @@
  *
  * BTW , ACK is done by publishing a message , So we needn't enhance ACK method
  */
-public class NatsMessageInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
+public class NatsMessageInstrumentation extends AbstractWitnessInstrumentation {
 
     private static final String ENHANCE_CLASS = "io.nats.client.impl.NatsMessage";
     private static final String PUBLISH_INTERCEPTOR = "org.apache.skywalking.apm.plugin.nats.client.NatsMessageInterceptor";

diff --git a/...fine/NatsSubscriptionInstrumentation.java → ...fine/NatsSubscriptionInstrumentation.java b/...fine/NatsSubscriptionInstrumentation.java → ...fine/NatsSubscriptionInstrumentation.java
@@ -21,14 +21,13 @@
 import net.bytebuddy.matcher.ElementMatcher;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
-import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;
 import org.apache.skywalking.apm.agent.core.plugin.match.ClassMatch;
 
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
 import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
 
-public class NatsSubscriptionInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
+public class NatsSubscriptionInstrumentation extends AbstractWitnessInstrumentation {
 
     private static final String ENHANCE_CLASS = "io.nats.client.impl.NatsSubscription";
     private static final String NEXT_MSG_INTERCEPTOR = "org.apache.skywalking.apm.plugin.nats.client.SubscriptionNextMsgInterceptor";

diff --git a/.../src/main/resources/skywalking-plugin.def → .../src/main/resources/skywalking-plugin.def b/.../src/main/resources/skywalking-plugin.def → .../src/main/resources/skywalking-plugin.def
@@ -14,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-nats-client-2.14.x-2.15.x=org.apache.skywalking.apm.plugin.nats.client.define.NatsMessageInstrumentation
-nats-client-2.14.x-2.15.x=org.apache.skywalking.apm.plugin.nats.client.define.NatsConnectionInstrumentation
-nats-client-2.14.x-2.15.x=org.apache.skywalking.apm.plugin.nats.client.define.NatsConnectionWriterInstrumentation
-nats-client-2.14.x-2.15.x=org.apache.skywalking.apm.plugin.nats.client.define.NatsSubscriptionInstrumentation
-nats-client-2.14.x-2.15.x=org.apache.skywalking.apm.plugin.nats.client.define.NatsJetStreamInstrumentation
+nats-client-2.14.x-2.16.5=org.apache.skywalking.apm.plugin.nats.client.define.NatsMessageInstrumentation
+nats-client-2.14.x-2.16.5=org.apache.skywalking.apm.plugin.nats.client.define.NatsConnectionInstrumentation
+nats-client-2.14.x-2.16.5=org.apache.skywalking.apm.plugin.nats.client.define.NatsConnectionWriterInstrumentation
+nats-client-2.14.x-2.16.5=org.apache.skywalking.apm.plugin.nats.client.define.NatsSubscriptionInstrumentation
+nats-client-2.14.x-2.16.5=org.apache.skywalking.apm.plugin.nats.client.define.NatsJetStreamInstrumentation
diff --git a/apm-sniffer/apm-sdk-plugin/pom.xml b/apm-sniffer/apm-sdk-plugin/pom.xml
@@ -123,7 +123,7 @@
         <module>guava-eventbus-plugin</module>
         <module>hutool-plugins</module>
         <module>micronaut-plugins</module>
-        <module>nats-2.14.x-2.15.x-plugin</module>
+        <module>nats-2.14.x-2.16.5-plugin</module>
         <module>jedis-plugins</module>
         <module>apm-armeria-plugins</module>
         <module>jetty-thread-pool-plugin</module>

diff --git a/docs/en/setup/service-agent/java-agent/Plugin-list.md b/docs/en/setup/service-agent/java-agent/Plugin-list.md
@@ -162,7 +162,7 @@
 - hutool-http-5.x
 - micronaut-http-client-3.2.x-3.6.x
 - micronaut-http-server-3.2.x-3.6.x
-- nats-client-2.14.x-2.15.x
+- nats-client-2.14.x-2.16.5
 - impala-jdbc-2.6.x
 - jdk-forkjoinpool-plugin
 - jetty-thread-pool
@@ -178,4 +178,4 @@
 - spring-webflux-6.x-webclient
 - activemq-artemis-jakarta-client-2.x
 - c3p0-0.9.x
-- solon-2.x
+- solon-2.x
diff --git a/docs/en/setup/service-agent/java-agent/Supported-list.md b/docs/en/setup/service-agent/java-agent/Supported-list.md
@@ -81,7 +81,7 @@ metrics based on the tracing data.
   * [ActiveMQ](https://github.com/apache/activemq) 5.10.0 -> 5.15.4
   * [RabbitMQ](https://www.rabbitmq.com/) 3.x-> 5.x
   * [Pulsar](http://pulsar.apache.org) 2.2.x -> 2.9.x
-  * [NATS](https://github.com/nats-io/nats.java) 2.14.x -> 2.15.x
+  * [NATS](https://github.com/nats-io/nats.java) 2.14.x -> 2.16.5
   * [ActiveMQ-Artemis](https://github.com/apache/activemq) 2.30.0 -> 2.31.2
   * Aliyun ONS 1.x (Optional¹)
 * NoSQL

diff --git a/...ats-2.14.x-2.15.x-scenario/bin/startup.sh → ...ats-2.14.x-2.16.5-scenario/bin/startup.sh b/...ats-2.14.x-2.15.x-scenario/bin/startup.sh → ...ats-2.14.x-2.16.5-scenario/bin/startup.sh
@@ -21,4 +21,4 @@ home="$(cd "$(dirname $0)"; pwd)"
 java -jar ${agent_opts} -Dserver.port=8080 \
   -Dskywalking.agent.service_name=scenario-8080- \
   -Dnats.server=nats-server \
-  ${home}/../libs/nats-2.14.x-2.15.x-scenario.jar &
+  ${home}/../libs/nats-2.14.x-2.16.5-scenario.jar &
diff --git a/...-2.15.x-scenario/config/expectedData.yaml → ...-2.16.5-scenario/config/expectedData.yaml b/...-2.15.x-scenario/config/expectedData.yaml → ...-2.16.5-scenario/config/expectedData.yaml
diff --git a/...-2.14.x-2.15.x-scenario/configuration.yml → ...-2.14.x-2.16.5-scenario/configuration.yml b/...-2.14.x-2.15.x-scenario/configuration.yml → ...-2.14.x-2.16.5-scenario/configuration.yml
diff --git a/...arios/nats-2.14.x-2.15.x-scenario/pom.xml → ...arios/nats-2.14.x-2.16.5-scenario/pom.xml b/...arios/nats-2.14.x-2.15.x-scenario/pom.xml → ...arios/nats-2.14.x-2.16.5-scenario/pom.xml
@@ -21,7 +21,7 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
     <groupId>org.apache.skywalking.apm.testcase</groupId>
-    <artifactId>nats-2.14.x-2.15.x-scenario</artifactId>
+    <artifactId>nats-2.14.x-2.16.5-scenario</artifactId>
     <version>1.0.0</version>
     <packaging>jar</packaging>
 
@@ -75,7 +75,7 @@
     </dependencies>
 
     <build>
-        <finalName>nats-2.14.x-2.15.x-scenario</finalName>
+        <finalName>nats-2.14.x-2.16.5-scenario</finalName>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
@@ -112,4 +112,4 @@
 
         </plugins>
     </build>
-</project>
+</project>
diff --git a/...x-scenario/src/main/assembly/assembly.xml → ...5-scenario/src/main/assembly/assembly.xml b/...x-scenario/src/main/assembly/assembly.xml → ...5-scenario/src/main/assembly/assembly.xml
@@ -33,7 +33,7 @@
 
     <files>
         <file>
-            <source>${project.build.directory}/nats-2.14.x-2.15.x-scenario.jar</source>
+            <source>${project.build.directory}/nats-2.14.x-2.16.5-scenario.jar</source>
             <outputDirectory>./libs</outputDirectory>
             <fileMode>0775</fileMode>
         </file>

diff --git a/...apm/testcase/nats/client/Application.java → ...apm/testcase/nats/client/Application.java b/...apm/testcase/nats/client/Application.java → ...apm/testcase/nats/client/Application.java
diff --git a/...ts/client/controller/StartController.java → ...ts/client/controller/StartController.java b/...ts/client/controller/StartController.java → ...ts/client/controller/StartController.java
diff --git a/.../client/publisher/JetStreamPublisher.java → .../client/publisher/JetStreamPublisher.java b/.../client/publisher/JetStreamPublisher.java → .../client/publisher/JetStreamPublisher.java
diff --git a/.../publisher/JetStreamPublisherFetcher.java → .../publisher/JetStreamPublisherFetcher.java b/.../publisher/JetStreamPublisherFetcher.java → .../publisher/JetStreamPublisherFetcher.java
diff --git a/...ats/client/publisher/NormalPublisher.java → ...ats/client/publisher/NormalPublisher.java b/...ats/client/publisher/NormalPublisher.java → ...ats/client/publisher/NormalPublisher.java
diff --git a/...case/nats/client/publisher/Publisher.java → ...case/nats/client/publisher/Publisher.java b/...case/nats/client/publisher/Publisher.java → ...case/nats/client/publisher/Publisher.java
diff --git a/...s/client/publisher/ReqReplyPublisher.java → ...s/client/publisher/ReqReplyPublisher.java b/...s/client/publisher/ReqReplyPublisher.java → ...s/client/publisher/ReqReplyPublisher.java
diff --git a/...case/nats/client/subscriber/Consumer.java → ...case/nats/client/subscriber/Consumer.java b/...case/nats/client/subscriber/Consumer.java → ...case/nats/client/subscriber/Consumer.java
diff --git a/.../subscriber/JetStreamFetcherConsumer.java → .../subscriber/JetStreamFetcherConsumer.java b/.../subscriber/JetStreamFetcherConsumer.java → .../subscriber/JetStreamFetcherConsumer.java
diff --git a/.../subscriber/JetStreamHandlerConsumer.java → .../subscriber/JetStreamHandlerConsumer.java b/.../subscriber/JetStreamHandlerConsumer.java → .../subscriber/JetStreamHandlerConsumer.java
diff --git a/...ts/client/subscriber/NextMsgConsumer.java → ...ts/client/subscriber/NextMsgConsumer.java b/...ts/client/subscriber/NextMsgConsumer.java → ...ts/client/subscriber/NextMsgConsumer.java
diff --git a/...s/client/subscriber/ReqReplyConsumer.java → ...s/client/subscriber/ReqReplyConsumer.java b/...s/client/subscriber/ReqReplyConsumer.java → ...s/client/subscriber/ReqReplyConsumer.java
diff --git a/...testcase/nats/client/work/StopSignal.java → ...testcase/nats/client/work/StopSignal.java b/...testcase/nats/client/work/StopSignal.java → ...testcase/nats/client/work/StopSignal.java
diff --git a/...testcase/nats/client/work/StreamUtil.java → ...testcase/nats/client/work/StreamUtil.java b/...testcase/nats/client/work/StreamUtil.java → ...testcase/nats/client/work/StreamUtil.java
diff --git a/...e/nats/client/work/TrackedConnection.java → ...e/nats/client/work/TrackedConnection.java b/...e/nats/client/work/TrackedConnection.java → ...e/nats/client/work/TrackedConnection.java
diff --git a/...estcase/nats/client/work/WorkBuilder.java → ...estcase/nats/client/work/WorkBuilder.java b/...estcase/nats/client/work/WorkBuilder.java → ...estcase/nats/client/work/WorkBuilder.java
diff --git a/...14.x-2.15.x-scenario/support-version.list → ...14.x-2.16.5-scenario/support-version.list b/...14.x-2.15.x-scenario/support-version.list → ...14.x-2.16.5-scenario/support-version.list
@@ -14,5 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+2.16.5
 2.15.6
-2.14.2
+2.14.2
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,7 @@ Release Notes. @@
 .4.0
     ------------------
+    * Upgrade nats plugin to support 2.16.5
     All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/222?closed=1)
@@ Expand Down @@