Add support for Nacos Client (#9961) #12849

wl2027 · 2024-12-08T05:22:08Z

Enhancement Methods

com.alibaba.nacos.common.remote.client.grpc.GrpcConnection#request
com.alibaba.nacos.common.remote.client.RpcClient#handleServerRequest

Enable Configuration

Configuration Items	Default Value
`otel.instrumentation.nacos-client.enabled`	`false`

Span Info Details

Request Child Class	SpanName	Additional Tags
InstanceRequest	Nacos/{$(lnstanceRequest.getType()}	nacos.namespace nacos.group nacos.service.name
ServiceQueryRequest	Nacos/queryService
SubscribeServiceRequest	Nacos/subscribeService Nacos/unsubscribeService
ServicelistRequest	Nacos/getServicelist
ConfigQueryRequest	Nacos/queryConfig
ConfigPublishRequest	Nacos/publishConfig	nacos.data.id nacos.group nacos.tenant
ConfigRemoveRequest	Nacos/removeConfig
ConfigChangeNotifyRequest	Nacos/notifyConfigChange
NotifySubscriberRequest	Nacos/notifySubscribeChange	nacos.group nacos.service.name

linux-foundation-easycla · 2024-12-08T05:22:13Z

The committers listed above are authorized under a signed CLA.

✅ login: wl2027 / name: weil (72e3a8e, 5af892d, 016e9d6, 366b75d, e376621, 4fb34dc, afa0080, ed8435b, e1f1ecb, 5bab791, c945508, ed446f6, 7e89a00, 1118094, e0c7daf, 37c5b02)
✅ login: otelbot[bot] (3dd9dbe)

- Improved code formatting - Enhanced muzzle validation - Managed dependency versions

docs/supported-libraries.md

instrumentation/nacos-client-2.0.3/javaagent/build.gradle.kts

...elemetry/javaagent/instrumentation/nacos/client/v2_0_3/NacosClientInstrumentationModule.java

...gent/instrumentation/nacos/client/v2_0_3/instrumentations/GrpcConnectionInstrumentation.java

laurit · 2024-12-18T14:00:49Z

...ient-2.0.3/javaagent/src/test/java/com/alibaba/nacos/common/remote/client/RpcClientTest.java

+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package com.alibaba.nacos.common.remote.client;


usually we place test classes in the same package as the instrumentation

I did this because com.alibaba.nacos.common.remote.client.RpcClient#handleServerRequest is a protected method. Is there a better way to handle this here?

...ient-2.0.3/javaagent/src/test/java/com/alibaba/nacos/common/remote/client/RpcClientTest.java

laurit · 2024-12-18T14:04:03Z

...gent/src/test/java/com/alibaba/nacos/shaded/com/google/errorprone/annotations/DoNotMock.java

+@Target(TYPE)
+@Retention(RUNTIME)
+@Documented
+public @interface DoNotMock {


is this used anywhere?

The class added here is to resolve a test compilation error in the nacos-client version 2.0.3 jar:

Compilation failed; see the compiler output below.
Error: Warning found, but specified -Werror
G:\temp.gradle\caches\modules-2\files-2.1\com.alibaba.nacos\nacos-client\2.0.3\a73c03b466a1f1565ee2b0e459c43046d6c8c15b\nacos-client-2.0.3.jar(/com/alibaba/nacos/shaded/com/google/common/util/concurrent/ListenableFuture.class): Warning: Unable to find class 'DoNotMock' annotation method 'value()': Can't find it com.alibaba.nacos.shaded.com.google.errorprone.annotations.DoNotMock class file.

This issue can be reproduced by removing the class file DoNotMock and then running ./gradlew :instrumentation:nacos-client-2.0.0:javaagent:test -PtestLatestDeps=true.

- Updated version to support Nacos client version 2.0.0 - Default the plugin to be disabled

...va/io/opentelemetry/javaagent/instrumentation/nacos/client/v2_0_0/NacosClientSingletons.java

...ient-2.0.0/javaagent/src/test/java/com/alibaba/nacos/common/remote/client/RpcClientTest.java

jaydeluca · 2025-06-23T10:11:27Z

...ient-2.0.0/javaagent/src/test/java/com/alibaba/nacos/common/remote/client/RpcClientTest.java

+    assertNotNull(response);
+    assertTrue(response.isSuccess());


in most of our tests, we use the assertThat() convention for consistency

Suggested change

assertNotNull(response);

assertTrue(response.isSuccess());

assertThat(response).isNotNull();

assertThat(response.isSuccess()).isTrue();

jaydeluca · 2025-06-23T10:12:11Z

...ient-2.0.0/javaagent/src/test/java/com/alibaba/nacos/common/remote/client/RpcClientTest.java

+                            rpcClient.getClass().getName(), "handleServerRequest", request));
+              });
+        });
+    testing.clearData();


i wouldn't expect these clearData() method calls to be needed. were they added due to some issue you encountered?

jaydeluca · 2025-06-23T10:18:04Z

instrumentation/nacos-client-2.0.0/javaagent/build.gradle.kts

+    versions.set("[2.0.0,)")
+    skip("0.5.0", "0.6.1", "1.1.2", "1.1.4", "1.4.7")


you have the versions.set() to only include versions 2.0.0 and above of the nacos-client module, so I wouldn't expect to need to skip anything below 2.x ?

jaydeluca · 2025-06-23T10:19:05Z

docs/supported-libraries.md

 | [Micrometer](https://micrometer.io/)                                                                                                        | 1.5+ (disabled by default)         | [opentelemetry-micrometer-1.5](../instrumentation/micrometer/micrometer-1.5/library)                                                                                                                                                                                                                                                                                                    | none                                                                                                                                    |
 | [MongoDB Driver](https://mongodb.github.io/mongo-java-driver/)                                                                              | 3.1+                               | [opentelemetry-mongo-3.1](../instrumentation/mongo/mongo-3.1/library)                                                                                                                                                                                                                                                                                                                   | [Database Client Spans], [Database Client Metrics]&nbsp;[6]                                                                             |
 | [MyBatis](https://mybatis.org/mybatis-3/)                                                                                                   | 3.2+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | none                                                                                                                                    |
+| [Nacos Client](https://nacos.io/)                                                                                                           | 2.0.0+                             | N/A                                                                                                                                                                                                                                                                                                                                                                                     | none                                                                                                                                    |


could you put a note in here that indicates it's disabled by default? similar to how Micrometer does it

…opentelemetry/javaagent/instrumentation/nacos/client/v2_0_0/NacosClientSingletons.java Co-authored-by: Jay DeLuca <[email protected]>

…/alibaba/nacos/common/remote/client/RpcClientTest.java Co-authored-by: Jay DeLuca <[email protected]>

otelbot-java-instrumentation · 2025-07-04T05:44:57Z

🔧 The result from spotlessApply was committed to the PR branch.

Add support for Nacos Client (open-telemetry#9961)

72e3a8e

wl2027 requested a review from a team as a code owner December 8, 2024 05:22

github-actions bot requested a review from theletterf December 8, 2024 05:22

wl2027 added 2 commits December 8, 2024 14:50

refactor(nacos-client): Improve code formatting and muzzle validation

016e9d6

- Improved code formatting - Enhanced muzzle validation - Managed dependency versions

Update(nacos-client): Improve code formatting and muzzle validation

5af892d

123liuziming mentioned this pull request Dec 12, 2024

[Proposal] Semantic conventions for config/registry center open-telemetry/semantic-conventions#1678

Open

laurit reviewed Dec 18, 2024

View reviewed changes

wl2027 and others added 3 commits December 21, 2024 13:00

fix: Update version and code style

afa0080

- Updated version to support Nacos client version 2.0.0 - Default the plugin to be disabled

Merge branch 'open-telemetry:main' into main

ed8435b

fix ci

e376621

wl2027 requested a review from laurit December 21, 2024 08:49

wl2027 and others added 6 commits March 23, 2025 10:20

fix configuration

37c5b02

Merge branch 'open-telemetry:main' into main

366b75d

fix-ci

7e89a00

fix-ci

5bab791

fix-ci: retigger workflow

4fb34dc

update comments

e0c7daf

jaydeluca reviewed Jun 23, 2025

View reviewed changes

wl2027 and others added 5 commits July 4, 2025 13:23

Merge branch 'open-telemetry:main' into main

ed446f6

Update instrumentation/nacos-client-2.0.0/javaagent/src/main/java/io/…

e1f1ecb

…opentelemetry/javaagent/instrumentation/nacos/client/v2_0_0/NacosClientSingletons.java Co-authored-by: Jay DeLuca <[email protected]>

Update instrumentation/nacos-client-2.0.0/javaagent/src/test/java/com…

1118094

…/alibaba/nacos/common/remote/client/RpcClientTest.java Co-authored-by: Jay DeLuca <[email protected]>

Update instrumentation/nacos-client-2.0.0/javaagent/src/test/java/com…

c945508

…/alibaba/nacos/common/remote/client/RpcClientTest.java Co-authored-by: Jay DeLuca <[email protected]>

./gradlew spotlessApply

3dd9dbe

		versions.set("[2.0.0,)")
		skip("0.5.0", "0.6.1", "1.1.2", "1.1.4", "1.4.7")

Add support for Nacos Client (#9961) #12849

Are you sure you want to change the base?

Add support for Nacos Client (#9961) #12849

Uh oh!

Conversation

wl2027 commented Dec 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Enhancement Methods

Enable Configuration

Span Info Details

Uh oh!

linux-foundation-easycla bot commented Dec 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

laurit Dec 18, 2024

Choose a reason for hiding this comment

Uh oh!

wl2027 Dec 21, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

laurit Dec 18, 2024

Choose a reason for hiding this comment

Uh oh!

wl2027 Dec 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jaydeluca Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

jaydeluca Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

jaydeluca Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

jaydeluca Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

otelbot-java-instrumentation bot commented Jul 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wl2027 commented Dec 8, 2024 •

edited

Loading

linux-foundation-easycla bot commented Dec 8, 2024 •

edited

Loading

wl2027 Dec 21, 2024 •

edited

Loading