feat: Add support for HBase versions 2.0.0 to 2.5.0. by YaoYingLong · Pull Request #18253 · open-telemetry/opentelemetry-java-instrumentation

YaoYingLong · 2026-04-24T03:43:29Z

Add support for HBase versions [2.0.0, 2.5.0)

trask · 2026-04-25T20:58:39Z

hi @YaoYingLong! I'm going to convert this PR to draft, once you get CI passing or have any questions for us, please mark it ready for review, thanks

Copilot

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

YaoYingLong · 2026-05-18T03:33:39Z

hi @YaoYingLong! I'm going to convert this PR to draft, once you get CI passing or have any questions for us, please mark it ready for review, thanks

@trask CI checks completed.

Copilot

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 5 comments.

+
+  @Test
+  @Order(1)
+  public void testCreateNameBase() {


+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void onEnter(
+        @Advice.This Object call, @Advice.FieldValue(value = "error") IOException error) {


+    Exception error = null;
+    boolean tableExists = false;
+    try {
+      Admin admin = connection.getAdmin();


+          .waitingFor(Wait.forHealthcheck().withStartupTimeout(Duration.ofMinutes(2)))
+          .withCreateContainerCmdModifier(cmd -> cmd.withHostName(HOSTNAME))
+          .waitingFor(Wait.forListeningPort())
+          .waitingFor(Wait.forLogMessage(".*Master has completed initialization.*\\n", 1));


+    transformer.applyAdviceToMethod(
+        isMethod().and(named("callComplete").or(named("setTimeout"))),
+        IpcCallInstrumentation.class.getName() + "$CallAdvice");


laurit · 2026-05-21T10:57:55Z

+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.hbase.client.v2_0_0;


usually we just use 2_0 instead of 2_0_0

laurit · 2026-05-21T11:33:05Z

+import org.apache.hadoop.hbase.security.User;
+import org.apache.hbase.thirdparty.com.google.protobuf.Descriptors;
+
+public final class AbstractRpcClientInstrumentation implements TypeInstrumentation {


could be package private

laurit · 2026-05-21T11:35:15Z

+                    named(
+                        "org.apache.hbase.thirdparty.com.google.protobuf.Descriptors$MethodDescriptor")))
+            .and(takesArgument(4, named("org.apache.hadoop.hbase.security.User")))
+            .and(takesArgument(5, named("org.apache.hadoop.hbase.net.Address"))),


As far as I can tell the only difference between the 2 advice is this argument. Perhaps the advice could accept Object and choose the correct behavior based on instanceof? Could that reduce the amount of code neede?

laurit · 2026-05-21T11:35:43Z

+                        "org.apache.hbase.thirdparty.com.google.protobuf.Descriptors$MethodDescriptor")))
+            .and(takesArgument(4, named("org.apache.hadoop.hbase.security.User")))
+            .and(takesArgument(5, named("java.net.InetSocketAddress"))),
+        AbstractRpcClientInstrumentation.class.getName() + "$CallMethodAdvice");


nowadays we prefer getClass().getNam()

laurit · 2026-05-21T11:36:17Z

+  private static final String CALL_UTIL = "org.apache.hadoop.hbase.ipc.OpenTelemetryCallUtil";
+
+  public HbaseInstrumentationModule() {
+    super("hbase-client", "hbase-client-2.0.0");


elsewhere we use 2.0 instead of 2.0.0

laurit · 2026-05-21T11:37:05Z

+    return hasClassesNamed("org.apache.hadoop.hbase.ipc.RpcConnection")
+        .and(hasClassesNamed("org.apache.hadoop.hbase.client.AsyncAdmin"))


could replace with hasClassesNamed("firs", "second")

laurit · 2026-05-21T11:38:35Z

+  @Override
+  public List<String> getAdditionalHelperClassNames() {
+    return singletonList(CALL_UTIL);
+  }


is this needed?

laurit · 2026-05-21T11:39:54Z

+
+  private static final String INSTRUMENTATION_NAME = "io.opentelemetry.hbase-client-2.0.0";
+  private static final Instrumenter<HbaseRequest, Void> INSTRUMENTER =
+      HbaseInstrumenterFactory.instrumenter(INSTRUMENTATION_NAME);


we use separate factory classes to share code between agent and library instrumentations here you could just move the code to this class

This is because we still maintain the 1.x versions, and we haven't submitted the PR (Pull Request) yet.

laurit · 2026-05-21T11:40:40Z

+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        isMethod().and(named("callComplete").or(named("setTimeout"))),


isMethod() isn't needed. Instead of or you could use namedOneOf

laurit · 2026-05-21T11:42:28Z

+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return extendsClass(named("org.apache.hadoop.hbase.ipc.RpcConnection"));


when there are matcher that match based on class hierarchy we usually also add

@Override public ElementMatcher<ClassLoader> classLoaderOptimization() { return hasClassesNamed("org.apache.hadoop.hbase.ipc.RpcConnection"); }

laurit · 2026-05-21T11:43:21Z

+  implementation(project(":instrumentation:hbase:hbase-common:javaagent"))
+
+  library("org.apache.hbase:hbase-client:2.0.0")
+  testLibrary("org.apache.hbase:hbase-client:2.3.7")


so instead of 2.0.0 this is tested with 2.3.7

laurit · 2026-05-21T11:43:37Z

+    usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    systemProperty("collectMetadata", otelProps.collectMetadata)
+    jvmArgs(
+      "-Dotel.javaagent.exclude-classes=com.google.protobuf.*,com.fasterxml.jackson.*,com.google.common.*,ch.qos.logback.*,javax.xml.*",


why would you need this?

laurit · 2026-05-21T11:45:59Z

+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.hbase.common;


why do you need a common module, can't you put these into the javaagent module?

This is because we still maintain the 1.x versions, and we haven't submitted the PR (Pull Request) yet.

laurit · 2026-05-21T11:55:03Z

+
+  library("org.apache.hbase:hbase-client:2.0.0")
+  testLibrary("org.apache.hbase:hbase-client:2.3.7")
+  latestDepTestLibrary("org.apache.hbase:hbase-client:2.4.+") // documented limitation


I think it would help to mention that hbase 2.5 includes native otel instrumentation

…e/hbase-2.0.0

….yml

YaoYingLong · 2026-05-27T12:49:41Z

@trask @laurit All issues found in the review have been fixed. Please review again.

feat: Add support for HBase versions 2.0.0 to 2.5.0.

750e307

YaoYingLong requested a review from a team as a code owner April 24, 2026 03:43

otelbot-java-instrumentation Bot added the test native This label can be applied to PRs to trigger them to run native tests label Apr 24, 2026

YaoYingLong added 2 commits April 24, 2026 12:35

Merge branch 'main' into feature/hbase-2.0.0

6772032

feat: Code review issue optimization and repeated test code merging.

85e0cff

trask marked this pull request as draft April 25, 2026 20:58

YaoYingLong and others added 2 commits April 26, 2026 11:22

Merge branch 'main' into feature/hbase-2.0.0

074d553

Merge branch 'main' into feature/hbase-2.0.0

df40828

trask mentioned this pull request May 5, 2026

Pull Request Dashboard #18435

Open

YaoYingLong added 3 commits May 12, 2026 22:24

fix: Fix the bug causing the failed check

4101651

Fix: spotlessJavaCheck execution failure

bf11f65

Fix: Fix the issue where VirtualField has an overly broad scope.

dcd7d0b

YaoYingLong marked this pull request as ready for review May 13, 2026 09:47

Copilot AI review requested due to automatic review settings May 13, 2026 09:47

Copilot started reviewing on behalf of YaoYingLong May 13, 2026 09:48 View session

Copilot AI reviewed May 13, 2026

View reviewed changes

trask requested a review from Copilot May 18, 2026 16:06

Copilot started reviewing on behalf of trask May 18, 2026 16:07 View session

Copilot AI reviewed May 18, 2026

View reviewed changes

laurit reviewed May 21, 2026

View reviewed changes

YaoYingLong added 7 commits May 22, 2026 15:27

feat: Optimize code review issues

9b3fd85

Merge branch 'main' into feature/hbase-2.0.0

334e01c

fix: Fix fossa‑configuration‑check failure

bfba82a

Merge remote-tracking branch 'origin/feature/hbase-2.0.0' into featur…

1c9ef26

…e/hbase-2.0.0

fix: remove :instrumentation:hbase:hbase-common:javaagent from .fossa…

79d54f2

….yml

feat: Optimize code comments

0408afc

fix: document HBase latest dep test override

d07b69b

		return hasClassesNamed("org.apache.hadoop.hbase.ipc.RpcConnection")
		.and(hasClassesNamed("org.apache.hadoop.hbase.client.AsyncAdmin"))

Conversation

YaoYingLong commented Apr 24, 2026

Uh oh!

trask commented Apr 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

YaoYingLong commented May 18, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

YaoYingLong commented May 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants