Skip to content

Commit afa0080

Browse files
committed
fix: Update version and code style
- Updated version to support Nacos client version 2.0.0 - Default the plugin to be disabled
1 parent 5af892d commit afa0080

File tree

25 files changed

+308
-335
lines changed

25 files changed

+308
-335
lines changed

docs/supported-libraries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ These are the supported libraries and frameworks:
101101
| [Micrometer](https://micrometer.io/) | 1.5+ | [opentelemetry-micrometer-1.5](../instrumentation/micrometer/micrometer-1.5/library) | none |
102102
| [MongoDB Driver](https://mongodb.github.io/mongo-java-driver/) | 3.1+ | [opentelemetry-mongo-3.1](../instrumentation/mongo/mongo-3.1/library) | [Database Client Spans] |
103103
| [MyBatis](https://mybatis.org/mybatis-3/) | 3.2+ | N/A | none |
104-
| [Nacos](https://nacos.io/) | 2.0.3+ | N/A | none |
104+
| [Nacos Client](https://nacos.io/) | 2.0.0+ | N/A | none |
105105
| [Netty HTTP codec [5]](https://github.com/netty/netty) | 3.8+ | [opentelemetry-netty-4.1](../instrumentation/netty/netty-4.1/library) | [HTTP Client Spans], [HTTP Client Metrics], [HTTP Server Spans], [HTTP Server Metrics] |
106106
| [OkHttp](https://github.com/square/okhttp/) | 2.2+ | [opentelemetry-okhttp-3.0](../instrumentation/okhttp/okhttp-3.0/library) | [HTTP Client Spans], [HTTP Client Metrics] |
107107
| [Oracle UCP](https://docs.oracle.com/database/121/JJUCP/) | 11.2+ | [opentelemetry-oracle-ucp-11.2](../instrumentation/oracle-ucp-11.2/library) | [Database Pool Metrics] |

instrumentation/nacos-client-2.0.3/README.md renamed to instrumentation/nacos-client-2.0.0/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
- `com.alibaba.nacos.common.remote.client.grpc.GrpcConnection#request`
33
- `com.alibaba.nacos.common.remote.client.RpcClient#handleServerRequest`
44

5+
## Enable Configuration
6+
7+
| Configuration Items | Default Value |
8+
|:----------------------------------------------------|:---------------|
9+
| `otel.instrumentation.nacos-client.default-enabled` | `false` |
10+
511
## Span Info Details
612
<table border="1">
713
<thead>
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
plugins {
2+
id("otel.javaagent-instrumentation")
3+
}
4+
5+
muzzle {
6+
pass {
7+
group.set("com.alibaba.nacos")
8+
module.set("nacos-client")
9+
versions.set("[2.0.0,)")
10+
skip("0.5.0", "0.6.1", "1.1.2", "1.1.4", "1.4.7")
11+
assertInverse.set(true)
12+
}
13+
}
14+
15+
dependencies {
16+
library("com.alibaba.nacos:nacos-client:2.0.0")
17+
testImplementation("javax.annotation:javax.annotation-api:1.3.2")
18+
}
19+
20+
tasks.withType<Test>().configureEach {
21+
jvmArgs("-Dotel.instrumentation.nacos-client.default-enabled=true")
22+
}
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3;
6+
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0;
77

88
import io.opentelemetry.api.common.AttributeKey;
99

1010
public class NacosClientConstants {
1111
private NacosClientConstants() {}
1212

13+
public static final String OTEL_NACOS_CLIENT_ENABLED =
14+
"otel.instrumentation.nacos-client.default-enabled";
15+
1316
public static final String NACOS_PREFIX = "Nacos/";
1417

1518
public static final String SERVER_CHECK = "serverCheck";
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3;
6+
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0;
77

88
import com.alibaba.nacos.api.config.remote.request.ConfigChangeNotifyRequest;
99
import com.alibaba.nacos.api.config.remote.request.ConfigPublishRequest;
Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,31 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3;
6+
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0;
7+
8+
import static java.util.Arrays.asList;
79

810
import com.google.auto.service.AutoService;
911
import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
1012
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
11-
import io.opentelemetry.javaagent.extension.instrumentation.internal.ExperimentalInstrumentationModule;
12-
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3.instrumentations.GrpcConnectionInstrumentation;
13-
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3.instrumentations.RpcClientInstrumentation;
14-
import java.util.Arrays;
13+
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0.instrumentations.GrpcConnectionInstrumentation;
14+
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0.instrumentations.RpcClientInstrumentation;
15+
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
1516
import java.util.List;
1617

1718
@AutoService(InstrumentationModule.class)
18-
public class NacosClientInstrumentationModule extends InstrumentationModule
19-
implements ExperimentalInstrumentationModule {
19+
public class NacosClientInstrumentationModule extends InstrumentationModule {
2020
public NacosClientInstrumentationModule() {
21-
super("nacos-client", "nacos-client-2.0.3");
21+
super("nacos-client", "nacos-client-2.0.0");
2222
}
2323

2424
@Override
2525
public List<TypeInstrumentation> typeInstrumentations() {
26-
return Arrays.asList(new GrpcConnectionInstrumentation(), new RpcClientInstrumentation());
26+
return asList(new GrpcConnectionInstrumentation(), new RpcClientInstrumentation());
27+
}
28+
29+
@Override
30+
public boolean defaultEnabled(ConfigProperties config) {
31+
return config.getBoolean(NacosClientConstants.OTEL_NACOS_CLIENT_ENABLED, false);
2732
}
2833
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3;
6+
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0;
77

88
import com.alibaba.nacos.api.remote.request.Request;
99
import io.opentelemetry.api.common.Attributes;
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3;
6+
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0;
77

88
import com.alibaba.nacos.api.remote.request.Request;
99
import io.opentelemetry.api.common.Attributes;
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3;
6+
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0;
77

88
import com.alibaba.nacos.api.remote.response.Response;
99
import io.opentelemetry.api.GlobalOpenTelemetry;
@@ -15,13 +15,13 @@
1515
import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
1616
import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
1717
import io.opentelemetry.instrumentation.api.instrumenter.SpanStatusExtractor;
18-
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3.extractors.NacosClientCodeAttributesGetter;
19-
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3.extractors.NacosClientExperimentalAttributeExtractor;
20-
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3.extractors.NacosClientSpanNameExtractor;
21-
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3.extractors.NacosClientSpanStatusExtractor;
18+
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0.extractors.NacosClientCodeAttributesGetter;
19+
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0.extractors.NacosClientExperimentalAttributeExtractor;
20+
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0.extractors.NacosClientSpanNameExtractor;
21+
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0.extractors.NacosClientSpanStatusExtractor;
2222

2323
public final class NacosClientSingletons {
24-
private static final String INSTRUMENTATION_NAME = "io.opentelemetry.nacos-client-2.0.3";
24+
private static final String INSTRUMENTATION_NAME = "io.opentelemetry.nacos-client-2.0.0";
2525
private static final Instrumenter<NacosClientRequest, Response> INSTRUMENTER = create();
2626

2727
public static Instrumenter<NacosClientRequest, Response> instrumenter() {
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3.extractors;
6+
package io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0.extractors;
77

88
import io.opentelemetry.instrumentation.api.incubator.semconv.code.CodeAttributesGetter;
9-
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_3.NacosClientRequest;
9+
import io.opentelemetry.javaagent.instrumentation.nacos.client.v2_0_0.NacosClientRequest;
1010
import javax.annotation.Nullable;
1111

1212
public class NacosClientCodeAttributesGetter implements CodeAttributesGetter<NacosClientRequest> {

0 commit comments

Comments
 (0)