Support tracing the ClickHouse Java HTTP client

docs/supported-libraries.md

@@ -49,6 +49,7 @@ These are the supported libraries and frameworks:
 | [AWS SDK](https://aws.amazon.com/sdk-for-java/)                                                                                             | 1.11.x and 2.2+                    | [opentelemetry-aws-sdk-1.11](../instrumentation/aws-sdk/aws-sdk-1.11/library),<br>[opentelemetry-aws-sdk-1.11-autoconfigure](../instrumentation/aws-sdk/aws-sdk-1.11/library-autoconfigure),<br>[opentelemetry-aws-sdk-2.2](../instrumentation/aws-sdk/aws-sdk-2.2/library),<br>[opentelemetry-aws-sdk-2.2-autoconfigure](../instrumentation/aws-sdk/aws-sdk-2.2/library-autoconfigure) | [Messaging Spans], [Database Client Spans], [HTTP Client Spans]                                                                         |
 | [Azure Core](https://docs.microsoft.com/en-us/java/api/overview/azure/core-readme)                                                          | 1.14+                              | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Context propagation                                                                                                                     |
 | [Cassandra Driver](https://github.com/datastax/java-driver)                                                                                 | 3.0+                               | [opentelemetry-cassandra-4.4](../instrumentation/cassandra/cassandra-4.4/library)                                                                                                                                                                                                                                                                                                       | [Database Client Spans]                                                                                                                 |
+| [Clickhouse Client](https://github.com/ClickHouse/clickhouse-java)                                                                          | 0.5+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [Database Client Spans]                                                                                                                 |
 | [Couchbase Client](https://github.com/couchbase/couchbase-java-client)                                                                      | 2.0+ and 3.1+                      | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [Database Client Spans]                                                                                                                 |
 | [c3p0](https://github.com/swaldman/c3p0)                                                                                                    | 0.9.2+                             | [opentelemetry-c3p0-0.9](../instrumentation/c3p0-0.9/library)                                                                                                                                                                                                                                                                                                                           | [Database Pool Metrics]                                                                                                                 |
 | [Dropwizard Metrics](https://metrics.dropwizard.io/)                                                                                        | 4.0+ (disabled by default)         | N/A                                                                                                                                                                                                                                                                                                                                                                                     | none                                                                                                                                    |

instrumentation/clickhouse-client-0.5/javaagent/build.gradle.kts

@@ -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)
+  }
+}

instrumentation/clickhouse-client-0.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseAttributesGetter.java

@@ -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;
+  }
+}

instrumentation/clickhouse-client-0.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseClientInstrumentation.java

@@ -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) {
+        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);
+    }
+  }
+}

instrumentation/clickhouse-client-0.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseDbRequest.java

@@ -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();
+}

instrumentation/clickhouse-client-0.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseInstrumentationModule.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.clickhouse;
+
+import static java.util.Collections.singletonList;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import java.util.List;
+
+@AutoService(InstrumentationModule.class)
+public class ClickHouseInstrumentationModule extends InstrumentationModule {
+
+  public ClickHouseInstrumentationModule() {
+    super("clickhouse", "clickhouse-client-0.5");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return singletonList(new ClickHouseClientInstrumentation());
+  }
+}

instrumentation/clickhouse-client-0.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseNetworkAttributesGetter.java

@@ -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();
+  }
+}

instrumentation/clickhouse-client-0.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseSingletons.java

@@ -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-0.5",
+                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() {}
+}