Support tracing the ClickHouse Java HTTP client #11660

jaydeluca · 2024-06-23T15:12:48Z

Contributes to #11562

Instruments v1 of the clickhouse-client (https://github.com/ClickHouse/clickhouse-java/tree/main/clickhouse-client)

A few notes:

I used version 0.5.0 as the earliest version of the clickhouse client in the instrumentation (most recent version is 0.6.1), if we think we need to go back further I can do that, but it felt like the client changes frequently, and with the release of the new client it didn't feel necessary.
In 0.6.1 they have introduced an alpha of a v2 client. Once that stabilizes I can followup and instrument that as well

The tests cover all the same scenarios, but I also created a repo to experiment with the tracing and visualize with jaeger and all seems to work as expected:
https://github.com/jaydeluca/clickhouse-tracing

Example Async query (execute)

Example error:

docs/supported-libraries.md

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

...n/java/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseAttributesGetter.java

...a/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseClientInstrumentation.java

…ference to internal utility class, add call depth checking

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

...a/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseClientInstrumentation.java

… logic

steverao · 2024-07-01T12:17:16Z

...a/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseInstrumentationModule.java

+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return Collections.singletonList(new ClickHouseClientInstrumentation());


Suggest to use static import here.

steverao · 2024-07-01T12:19:19Z

...a/io/opentelemetry/javaagent/instrumentation/clickhouse/ClickHouseInstrumentationModule.java

+public class ClickHouseInstrumentationModule extends InstrumentationModule {
+
+  public ClickHouseInstrumentationModule() {
+    super("clickhouse", "clickhouse-client");


According to previous convention, the module should be named to clickhouse-client-0.5. Please pay attention to modify other places together.

steverao · 2024-07-01T12:22:50Z

settings.gradle.kts

@@ -204,6 +204,7 @@ include(":instrumentation:cassandra:cassandra-4.4:library")
 include(":instrumentation:cassandra:cassandra-4.4:testing")
 include(":instrumentation:cassandra:cassandra-4-common:testing")
 include(":instrumentation:cdi-testing")
+include(":instrumentation:clickhouse:clickhouse-client:javaagent")


If there is a module, according to convention, please remove extra clickhouse directory. use clickhouse-client-0.5 directly.

jaydeluca added 5 commits June 13, 2024 21:24

instrument clickhouserequest query

5193f8f

instrument parameterized queries

67d58e0

update tests

5d8d8cd

small updates

0189967

instrument execute and executeandwait

4460d7f

jaydeluca requested a review from a team as a code owner June 23, 2024 15:12

github-actions bot requested a review from theletterf June 23, 2024 15:13