Support tracing the ClickHouse Java HTTP client #11660
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| plugins { | ||
| id("otel.javaagent-instrumentation") | ||
| } | ||
|
|
||
| muzzle { | ||
| pass { | ||
| group.set("com.clickhouse.client") | ||
| module.set("clickhouse-client") | ||
| versions.set("[0.5.0,)") | ||
| assertInverse.set(true) | ||
| } | ||
| } | ||
|
|
||
| dependencies { | ||
| compileOnly("com.clickhouse:clickhouse-client:0.5.0") | ||
| compileOnly("com.google.auto.value:auto-value-annotations") | ||
| annotationProcessor("com.google.auto.value:auto-value") | ||
|
|
||
| testLibrary("com.clickhouse:clickhouse-client:0.5.0") | ||
| testLibrary("com.clickhouse:clickhouse-http-client:0.5.0") | ||
| testLibrary("org.apache.httpcomponents.client5:httpclient5:5.2.3") | ||
| } | ||
|
|
||
| tasks { | ||
| test { | ||
| usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.clickhouse; | ||
|
|
||
| import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientAttributesGetter; | ||
| import io.opentelemetry.semconv.incubating.DbIncubatingAttributes; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| final class ClickHouseAttributesGetter implements DbClientAttributesGetter<ClickHouseDbRequest> { | ||
| @Nullable | ||
| @Override | ||
| public String getStatement(ClickHouseDbRequest request) { | ||
| if (request.getSqlStatementInfo() == null) { | ||
| return null; | ||
| } | ||
| return request.getSqlStatementInfo().getFullStatement(); | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public String getOperation(ClickHouseDbRequest request) { | ||
| if (request.getSqlStatementInfo() == null) { | ||
| return null; | ||
| } | ||
| return request.getSqlStatementInfo().getOperation(); | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public String getSystem(ClickHouseDbRequest request) { | ||
| return DbIncubatingAttributes.DbSystemValues.CLICKHOUSE; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public String getUser(ClickHouseDbRequest request) { | ||
| return null; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public String getName(ClickHouseDbRequest request) { | ||
| String dbName = request.getDbName(); | ||
| if (dbName == null || dbName.isEmpty()) { | ||
| return null; | ||
| } | ||
| return dbName; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public String getConnectionString(ClickHouseDbRequest request) { | ||
| return null; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.clickhouse; | ||
|
|
||
| import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext; | ||
| import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface; | ||
| import static io.opentelemetry.javaagent.instrumentation.clickhouse.ClickHouseSingletons.instrumenter; | ||
| import static net.bytebuddy.matcher.ElementMatchers.isMethod; | ||
| import static net.bytebuddy.matcher.ElementMatchers.named; | ||
| import static net.bytebuddy.matcher.ElementMatchers.namedOneOf; | ||
| import static net.bytebuddy.matcher.ElementMatchers.takesArgument; | ||
|
|
||
| import com.clickhouse.client.ClickHouseClient; | ||
| import com.clickhouse.client.ClickHouseRequest; | ||
| import io.opentelemetry.context.Context; | ||
| import io.opentelemetry.context.Scope; | ||
| import io.opentelemetry.javaagent.bootstrap.CallDepth; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer; | ||
| import net.bytebuddy.asm.Advice; | ||
| import net.bytebuddy.description.type.TypeDescription; | ||
| import net.bytebuddy.matcher.ElementMatcher; | ||
|
|
||
| public class ClickHouseClientInstrumentation implements TypeInstrumentation { | ||
| @Override | ||
| public ElementMatcher<TypeDescription> typeMatcher() { | ||
| return implementsInterface(named("com.clickhouse.client.ClickHouseClient")); | ||
| } | ||
|
|
||
| @Override | ||
| public void transform(TypeTransformer transformer) { | ||
| transformer.applyAdviceToMethod( | ||
| isMethod() | ||
| .and(namedOneOf("executeAndWait", "execute")) | ||
| .and(takesArgument(0, named("com.clickhouse.client.ClickHouseRequest"))), | ||
| this.getClass().getName() + "$ClickHouseExecuteAndWaitAdvice"); | ||
| } | ||
|
|
||
| @SuppressWarnings("unused") | ||
| public static class ClickHouseExecuteAndWaitAdvice { | ||
| @Advice.OnMethodEnter(suppress = Throwable.class) | ||
| public static void onEnter( | ||
| @Advice.Argument(0) ClickHouseRequest<?> clickHouseRequest, | ||
| @Advice.Local("otelContext") Context context, | ||
| @Advice.Local("otelScope") Scope scope, | ||
| @Advice.Local("otelCallDepth") CallDepth callDepth) { | ||
|
|
||
| callDepth = CallDepth.forClass(ClickHouseClient.class); | ||
| if (callDepth.getAndIncrement() > 0) { | ||
| return; | ||
| } | ||
|
|
||
| if (clickHouseRequest == null) { | ||
jaydeluca marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return; | ||
| } | ||
|
|
||
| Context parentContext = currentContext(); | ||
|
|
||
| ClickHouseDbRequest request = | ||
| ClickHouseDbRequest.create( | ||
| clickHouseRequest.getServer().getHost(), | ||
| clickHouseRequest.getServer().getPort(), | ||
| clickHouseRequest.getServer().getDatabase().get(), | ||
| clickHouseRequest.getPreparedQuery().getOriginalQuery()); | ||
|
|
||
| if (!instrumenter().shouldStart(parentContext, request)) { | ||
| return; | ||
| } | ||
|
|
||
| context = instrumenter().start(parentContext, request); | ||
| scope = context.makeCurrent(); | ||
| } | ||
|
|
||
| @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class) | ||
| public static void onExit( | ||
| @Advice.Thrown Throwable throwable, | ||
| @Advice.Local("otelRequest") ClickHouseDbRequest clickHouseRequest, | ||
| @Advice.Local("otelContext") Context context, | ||
| @Advice.Local("otelScope") Scope scope, | ||
| @Advice.Local("otelCallDepth") CallDepth callDepth) { | ||
|
|
||
| if (callDepth.decrementAndGet() > 0) { | ||
| return; | ||
| } | ||
|
|
||
| if (scope == null) { | ||
| return; | ||
| } | ||
|
|
||
| scope.close(); | ||
| instrumenter().end(context, clickHouseRequest, null, throwable); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.clickhouse; | ||
|
|
||
| import com.google.auto.value.AutoValue; | ||
| import io.opentelemetry.instrumentation.api.incubator.semconv.db.SqlStatementInfo; | ||
| import io.opentelemetry.instrumentation.api.incubator.semconv.db.SqlStatementSanitizer; | ||
| import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig; | ||
|
|
||
| @AutoValue | ||
| public abstract class ClickHouseDbRequest { | ||
|
|
||
| private static final SqlStatementSanitizer sanitizer = | ||
| SqlStatementSanitizer.create(CommonConfig.get().isStatementSanitizationEnabled()); | ||
|
|
||
| public static ClickHouseDbRequest create(String host, Integer port, String dbName, String sql) { | ||
| return new AutoValue_ClickHouseDbRequest(host, port, dbName, sanitizer.sanitize(sql)); | ||
| } | ||
|
|
||
| public abstract String getHost(); | ||
|
|
||
| public abstract Integer getPort(); | ||
|
|
||
| public abstract String getDbName(); | ||
|
|
||
| public abstract SqlStatementInfo getSqlStatementInfo(); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.clickhouse; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
||
| @AutoService(InstrumentationModule.class) | ||
| public class ClickHouseInstrumentationModule extends InstrumentationModule { | ||
|
|
||
| public ClickHouseInstrumentationModule() { | ||
| super("clickhouse", "clickhouse-client"); | ||
|
There was a problem hiding this comment. According to previous convention, the module should be named to |
||
| } | ||
|
|
||
| @Override | ||
| public List<TypeInstrumentation> typeInstrumentations() { | ||
| return Collections.singletonList(new ClickHouseClientInstrumentation()); | ||
|
There was a problem hiding this comment. Suggest to use static import here. |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.clickhouse; | ||
|
|
||
| import io.opentelemetry.instrumentation.api.semconv.network.ServerAttributesGetter; | ||
|
|
||
| final class ClickHouseNetworkAttributesGetter | ||
| implements ServerAttributesGetter<ClickHouseDbRequest> { | ||
|
|
||
| @Override | ||
| public String getServerAddress(ClickHouseDbRequest request) { | ||
| return request.getHost(); | ||
| } | ||
|
|
||
| @Override | ||
| public Integer getServerPort(ClickHouseDbRequest request) { | ||
| return request.getPort(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.clickhouse; | ||
|
|
||
| import io.opentelemetry.api.GlobalOpenTelemetry; | ||
| import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientAttributesExtractor; | ||
| import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientSpanNameExtractor; | ||
| import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; | ||
| import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor; | ||
| import io.opentelemetry.instrumentation.api.semconv.network.ServerAttributesExtractor; | ||
|
|
||
| public final class ClickHouseSingletons { | ||
|
|
||
| private static final Instrumenter<ClickHouseDbRequest, Void> INSTRUMENTER; | ||
|
|
||
| static { | ||
| ClickHouseAttributesGetter dbAttributesGetter = new ClickHouseAttributesGetter(); | ||
|
|
||
| INSTRUMENTER = | ||
| Instrumenter.<ClickHouseDbRequest, Void>builder( | ||
| GlobalOpenTelemetry.get(), | ||
| "io.opentelemetry.clickhouse-client", | ||
| DbClientSpanNameExtractor.create(dbAttributesGetter)) | ||
| .addAttributesExtractor(DbClientAttributesExtractor.create(dbAttributesGetter)) | ||
| .addAttributesExtractor( | ||
| ServerAttributesExtractor.create(new ClickHouseNetworkAttributesGetter())) | ||
| .buildInstrumenter(SpanKindExtractor.alwaysClient()); | ||
| } | ||
|
|
||
| public static Instrumenter<ClickHouseDbRequest, Void> instrumenter() { | ||
| return INSTRUMENTER; | ||
| } | ||
|
|
||
| private ClickHouseSingletons() {} | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.