HBASE-26471 Move tracing semantic attributes to their own class (#3896)

Signed-off-by: Duo Zhang <[email protected]>
Signed-off-by: Tak Lon (Stephen) Wu <[email protected]>

hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncConnectionImpl.java

@@ -1,4 +1,4 @@
-/**
+/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
@@ -25,6 +25,7 @@
 import static org.apache.hadoop.hbase.client.ConnectionUtils.getStubKey;
 import static org.apache.hadoop.hbase.client.MetricsConnection.CLIENT_SIDE_METRICS_ENABLED_KEY;
 import static org.apache.hadoop.hbase.client.NonceGenerator.CLIENT_NONCES_ENABLED_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.SERVER_NAME_KEY;
 import static org.apache.hadoop.hbase.util.FutureUtils.addListener;
 
 import io.opentelemetry.api.trace.Span;
@@ -371,7 +372,7 @@ public AsyncBufferedMutatorBuilder getBufferedMutatorBuilder(TableName tableName
   }
 
   private Hbck getHbckInternal(ServerName masterServer) {
-    Span.current().setAttribute(TraceUtil.SERVER_NAME_KEY, masterServer.getServerName());
+    Span.current().setAttribute(SERVER_NAME_KEY, masterServer.getServerName());
     // we will not create a new connection when creating a new protobuf stub, and for hbck there
     // will be no performance consideration, so for simplification we will create a new stub every
     // time instead of caching the stub here.

hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncRegionLocator.java

@@ -18,8 +18,8 @@
 package org.apache.hadoop.hbase.client;
 
 import static org.apache.hadoop.hbase.TableName.META_TABLE_NAME;
-import static org.apache.hadoop.hbase.trace.TraceUtil.REGION_NAMES_KEY;
-import static org.apache.hadoop.hbase.trace.TraceUtil.SERVER_NAME_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.REGION_NAMES_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.SERVER_NAME_KEY;
 import static org.apache.hadoop.hbase.trace.TraceUtil.createSpan;
 import static org.apache.hadoop.hbase.trace.TraceUtil.createTableSpan;
 import static org.apache.hadoop.hbase.util.FutureUtils.addListener;

hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionImplementation.java

@@ -78,6 +78,7 @@
 import org.apache.hadoop.hbase.log.HBaseMarkers;
 import org.apache.hadoop.hbase.regionserver.RegionServerStoppedException;
 import org.apache.hadoop.hbase.security.User;
+import org.apache.hadoop.hbase.trace.HBaseSemanticAttributes;
 import org.apache.hadoop.hbase.trace.TraceUtil;
 import org.apache.hadoop.hbase.util.Bytes;
 import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;
@@ -504,7 +505,7 @@ public Hbck getHbck(ServerName masterServer) throws IOException {
           return MasterProtos.HbckService.newBlockingStub(channel);
         }), rpcControllerFactory);
     }, () -> TraceUtil.createSpan(this.getClass().getSimpleName() + ".getHbck")
-      .setAttribute(TraceUtil.SERVER_NAME_KEY, masterServer.getServerName()));
+      .setAttribute(HBaseSemanticAttributes.SERVER_NAME_KEY, masterServer.getServerName()));
   }
 
   @Override

hbase-client/src/main/java/org/apache/hadoop/hbase/ipc/AbstractRpcClient.java

@@ -1,4 +1,4 @@
-/**
+/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
@@ -20,6 +20,10 @@
 
 import static org.apache.hadoop.hbase.ipc.IPCUtil.toIOE;
 import static org.apache.hadoop.hbase.ipc.IPCUtil.wrapException;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.REMOTE_HOST_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.REMOTE_PORT_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_METHOD_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_SERVICE_KEY;
 
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.StatusCode;
@@ -396,10 +400,10 @@ private Call callMethod(final Descriptors.MethodDescriptor md, final HBaseRpcCon
     final Message param, Message returnType, final User ticket, final Address addr,
     final RpcCallback<Message> callback) {
     Span span = TraceUtil.createClientSpan("RpcClient.callMethod")
-      .setAttribute(TraceUtil.RPC_SERVICE_KEY, md.getService().getName())
-      .setAttribute(TraceUtil.RPC_METHOD_KEY, md.getName())
-      .setAttribute(TraceUtil.REMOTE_HOST_KEY, addr.getHostName())
-      .setAttribute(TraceUtil.REMOTE_PORT_KEY, addr.getPort());
+      .setAttribute(RPC_SERVICE_KEY, md.getService().getName())
+      .setAttribute(RPC_METHOD_KEY, md.getName())
+      .setAttribute(REMOTE_HOST_KEY, addr.getHostName())
+      .setAttribute(REMOTE_PORT_KEY, addr.getPort());
     try (Scope scope = span.makeCurrent()) {
       final MetricsConnection.CallStats cs = MetricsConnection.newCallStats();
       cs.setStartTime(EnvironmentEdgeManager.currentTime());

hbase-client/src/test/java/org/apache/hadoop/hbase/client/TestAsyncConnectionTracing.java

@@ -33,7 +33,7 @@
 import org.apache.hadoop.hbase.security.UserProvider;
 import org.apache.hadoop.hbase.testclassification.ClientTests;
 import org.apache.hadoop.hbase.testclassification.MediumTests;
-import org.apache.hadoop.hbase.trace.TraceUtil;
+import org.apache.hadoop.hbase.trace.HBaseSemanticAttributes;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.ClassRule;
@@ -87,7 +87,9 @@ private void assertTrace(String methodName, ServerName serverName) {
       .filter(s -> s.getName().equals("AsyncConnection." + methodName)).findFirst().get();
     assertEquals(StatusCode.OK, data.getStatus().getStatusCode());
     if (serverName != null) {
-      assertEquals(serverName.getServerName(), data.getAttributes().get(TraceUtil.SERVER_NAME_KEY));
+      assertEquals(
+        serverName.getServerName(),
+        data.getAttributes().get(HBaseSemanticAttributes.SERVER_NAME_KEY));
     }
   }
 

hbase-client/src/test/java/org/apache/hadoop/hbase/client/TestAsyncRegionLocatorTracing.java

@@ -38,7 +38,7 @@
 import org.apache.hadoop.hbase.security.UserProvider;
 import org.apache.hadoop.hbase.testclassification.ClientTests;
 import org.apache.hadoop.hbase.testclassification.MediumTests;
-import org.apache.hadoop.hbase.trace.TraceUtil;
+import org.apache.hadoop.hbase.trace.HBaseSemanticAttributes;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.ClassRule;
@@ -107,7 +107,7 @@ public void testClearCacheServerName() {
     conn.getLocator().clearCache(sn);
     SpanData span = waitSpan("AsyncRegionLocator.clearCache");
     assertEquals(StatusCode.OK, span.getStatus().getStatusCode());
-    assertEquals(sn.toString(), span.getAttributes().get(TraceUtil.SERVER_NAME_KEY));
+    assertEquals(sn.toString(), span.getAttributes().get(HBaseSemanticAttributes.SERVER_NAME_KEY));
   }
 
   @Test
@@ -116,9 +116,9 @@ public void testClearCacheTableName() {
     SpanData span = waitSpan("AsyncRegionLocator.clearCache");
     assertEquals(StatusCode.OK, span.getStatus().getStatusCode());
     assertEquals(TableName.META_TABLE_NAME.getNamespaceAsString(),
-      span.getAttributes().get(TraceUtil.NAMESPACE_KEY));
+      span.getAttributes().get(HBaseSemanticAttributes.NAMESPACE_KEY));
     assertEquals(TableName.META_TABLE_NAME.getNameAsString(),
-      span.getAttributes().get(TraceUtil.TABLE_KEY));
+      span.getAttributes().get(HBaseSemanticAttributes.TABLE_KEY));
   }
 
   @Test
@@ -128,10 +128,10 @@ public void testGetRegionLocation() {
     SpanData span = waitSpan("AsyncRegionLocator.getRegionLocation");
     assertEquals(StatusCode.OK, span.getStatus().getStatusCode());
     assertEquals(TableName.META_TABLE_NAME.getNamespaceAsString(),
-      span.getAttributes().get(TraceUtil.NAMESPACE_KEY));
+      span.getAttributes().get(HBaseSemanticAttributes.NAMESPACE_KEY));
     assertEquals(TableName.META_TABLE_NAME.getNameAsString(),
-      span.getAttributes().get(TraceUtil.TABLE_KEY));
-    List<String> regionNames = span.getAttributes().get(TraceUtil.REGION_NAMES_KEY);
+      span.getAttributes().get(HBaseSemanticAttributes.TABLE_KEY));
+    List<String> regionNames = span.getAttributes().get(HBaseSemanticAttributes.REGION_NAMES_KEY);
     assertEquals(1, regionNames.size());
     assertEquals(locs.getDefaultRegionLocation().getRegion().getRegionNameAsString(),
       regionNames.get(0));
@@ -144,10 +144,10 @@ public void testGetRegionLocations() {
     SpanData span = waitSpan("AsyncRegionLocator.getRegionLocations");
     assertEquals(StatusCode.OK, span.getStatus().getStatusCode());
     assertEquals(TableName.META_TABLE_NAME.getNamespaceAsString(),
-      span.getAttributes().get(TraceUtil.NAMESPACE_KEY));
+      span.getAttributes().get(HBaseSemanticAttributes.NAMESPACE_KEY));
     assertEquals(TableName.META_TABLE_NAME.getNameAsString(),
-      span.getAttributes().get(TraceUtil.TABLE_KEY));
-    List<String> regionNames = span.getAttributes().get(TraceUtil.REGION_NAMES_KEY);
+      span.getAttributes().get(HBaseSemanticAttributes.TABLE_KEY));
+    List<String> regionNames = span.getAttributes().get(HBaseSemanticAttributes.REGION_NAMES_KEY);
     assertEquals(3, regionNames.size());
     for (int i = 0; i < 3; i++) {
       assertEquals(locs.getRegionLocation(i).getRegion().getRegionNameAsString(),

hbase-client/src/test/java/org/apache/hadoop/hbase/client/TestAsyncTableTracing.java

@@ -17,6 +17,8 @@
  */
 package org.apache.hadoop.hbase.client;
 
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.NAMESPACE_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.TABLE_KEY;
 import static org.junit.Assert.assertEquals;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyInt;
@@ -47,7 +49,6 @@
 import org.apache.hadoop.hbase.security.UserProvider;
 import org.apache.hadoop.hbase.testclassification.ClientTests;
 import org.apache.hadoop.hbase.testclassification.MediumTests;
-import org.apache.hadoop.hbase.trace.TraceUtil;
 import org.apache.hadoop.hbase.util.Bytes;
 import org.junit.After;
 import org.junit.Before;
@@ -227,9 +228,8 @@ private void assertTrace(String methodName) {
       .filter(s -> s.getName().equals("AsyncTable." + methodName)).findFirst().get();
     assertEquals(StatusCode.OK, data.getStatus().getStatusCode());
     TableName tableName = table.getName();
-    assertEquals(tableName.getNamespaceAsString(),
-      data.getAttributes().get(TraceUtil.NAMESPACE_KEY));
-    assertEquals(tableName.getNameAsString(), data.getAttributes().get(TraceUtil.TABLE_KEY));
+    assertEquals(tableName.getNamespaceAsString(), data.getAttributes().get(NAMESPACE_KEY));
+    assertEquals(tableName.getNameAsString(), data.getAttributes().get(TABLE_KEY));
   }
 
   @Test

hbase-client/src/test/java/org/apache/hadoop/hbase/client/TestTracingBase.java

@@ -23,6 +23,7 @@
 import io.opentelemetry.api.trace.StatusCode;
 import io.opentelemetry.sdk.testing.junit4.OpenTelemetryRule;
 import io.opentelemetry.sdk.trace.data.SpanData;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import org.apache.hadoop.conf.Configuration;
@@ -33,7 +34,7 @@
 import org.apache.hadoop.hbase.ServerName;
 import org.apache.hadoop.hbase.TableName;
 import org.apache.hadoop.hbase.Waiter;
-import org.apache.hadoop.hbase.trace.TraceUtil;
+import org.apache.hadoop.hbase.trace.HBaseSemanticAttributes;
 import org.junit.Before;
 import org.junit.ClassRule;
 
@@ -68,16 +69,20 @@ protected void assertTrace(String className, String methodName, ServerName serve
 
     if (serverName != null) {
       Optional<SpanData> foundServerName =
-        TRACE_RULE.getSpans().stream().filter(s -> s.getName().equals(expectedSpanName)).filter(
-          s -> serverName.getServerName().equals(s.getAttributes().get(TraceUtil.SERVER_NAME_KEY)))
+        TRACE_RULE.getSpans().stream()
+          .filter(s -> s.getName().equals(expectedSpanName))
+          .filter(s -> Objects.equals(
+            serverName.getServerName(),
+            s.getAttributes().get(HBaseSemanticAttributes.SERVER_NAME_KEY)))
           .findAny();
       assertTrue(foundServerName.isPresent());
     }
 
     if (tableName != null) {
       assertEquals(tableName.getNamespaceAsString(),
-        data.getAttributes().get(TraceUtil.NAMESPACE_KEY));
-      assertEquals(tableName.getNameAsString(), data.getAttributes().get(TraceUtil.TABLE_KEY));
+        data.getAttributes().get(HBaseSemanticAttributes.NAMESPACE_KEY));
+      assertEquals(tableName.getNameAsString(),
+        data.getAttributes().get(HBaseSemanticAttributes.TABLE_KEY));
     }
   }
 

hbase-common/src/main/java/org/apache/hadoop/hbase/trace/HBaseSemanticAttributes.java

@@ -0,0 +1,48 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.hadoop.hbase.trace;
+
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
+import java.util.List;
+import org.apache.yetus.audience.InterfaceAudience;
+
+/**
+ * The constants in this class correspond with the guidance outlined by the OpenTelemetry
+ * <a href="https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions">Semantic Conventions</a>.
+*/
+@InterfaceAudience.Private
+public final class HBaseSemanticAttributes {
+  public static final AttributeKey<String> NAMESPACE_KEY = SemanticAttributes.DB_HBASE_NAMESPACE;
+  public static final AttributeKey<String> TABLE_KEY = AttributeKey.stringKey("db.hbase.table");
+  public static final AttributeKey<List<String>> REGION_NAMES_KEY =
+    AttributeKey.stringArrayKey("db.hbase.regions");
+  public static final AttributeKey<String> RPC_SERVICE_KEY =
+    AttributeKey.stringKey("db.hbase.rpc.service");
+  public static final AttributeKey<String> RPC_METHOD_KEY =
+    AttributeKey.stringKey("db.hbase.rpc.method");
+  public static final AttributeKey<String> SERVER_NAME_KEY =
+    AttributeKey.stringKey("db.hbase.server.name");
+  public static final AttributeKey<String> REMOTE_HOST_KEY = SemanticAttributes.NET_PEER_NAME;
+  public static final AttributeKey<Long> REMOTE_PORT_KEY = SemanticAttributes.NET_PEER_PORT;
+  public static final AttributeKey<Boolean> ROW_LOCK_READ_LOCK_KEY =
+    AttributeKey.booleanKey("db.hbase.rowlock.readlock");
+  public static final AttributeKey<String> WAL_IMPL = AttributeKey.stringKey("db.hbase.wal.impl");
+
+  private HBaseSemanticAttributes() { }
+}

hbase-common/src/main/java/org/apache/hadoop/hbase/trace/TraceUtil.java

@@ -1,4 +1,4 @@
-/**
+/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
@@ -17,15 +17,15 @@
  */
 package org.apache.hadoop.hbase.trace;
 
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.NAMESPACE_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.TABLE_KEY;
 import io.opentelemetry.api.GlobalOpenTelemetry;
-import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.SpanKind;
 import io.opentelemetry.api.trace.StatusCode;
 import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.Scope;
-import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 import java.io.IOException;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
@@ -38,31 +38,6 @@
 @InterfaceAudience.Private
 public final class TraceUtil {
 
-  public static final AttributeKey<String> NAMESPACE_KEY = SemanticAttributes.DB_HBASE_NAMESPACE;
-
-  public static final AttributeKey<String> TABLE_KEY = AttributeKey.stringKey("db.hbase.table");
-
-  public static final AttributeKey<List<String>> REGION_NAMES_KEY =
-    AttributeKey.stringArrayKey("db.hbase.regions");
-
-  public static final AttributeKey<String> RPC_SERVICE_KEY =
-    AttributeKey.stringKey("db.hbase.rpc.service");
-
-  public static final AttributeKey<String> RPC_METHOD_KEY =
-    AttributeKey.stringKey("db.hbase.rpc.method");
-
-  public static final AttributeKey<String> SERVER_NAME_KEY =
-    AttributeKey.stringKey("db.hbase.server.name");
-
-  public static final AttributeKey<String> REMOTE_HOST_KEY = SemanticAttributes.NET_PEER_NAME;
-
-  public static final AttributeKey<Long> REMOTE_PORT_KEY = SemanticAttributes.NET_PEER_PORT;
-
-  public static final AttributeKey<Boolean> ROW_LOCK_READ_LOCK_KEY =
-    AttributeKey.booleanKey("db.hbase.rowlock.readlock");
-
-  public static final AttributeKey<String> WAL_IMPL = AttributeKey.stringKey("db.hbase.wal.impl");
-
   private TraceUtil() {
   }
 
@@ -81,7 +56,8 @@ public static Span createSpan(String name) {
    * Create a {@link SpanKind#INTERNAL} span and set table related attributes.
    */
   public static Span createTableSpan(String spanName, TableName tableName) {
-    return createSpan(spanName).setAttribute(NAMESPACE_KEY, tableName.getNamespaceAsString())
+    return createSpan(spanName)
+      .setAttribute(NAMESPACE_KEY, tableName.getNamespaceAsString())
       .setAttribute(TABLE_KEY, tableName.getNameAsString());
   }
 

hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/CallRunner.java

@@ -1,4 +1,4 @@
-/**
+/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
@@ -17,6 +17,8 @@
  */
 package org.apache.hadoop.hbase.ipc;
 
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_METHOD_KEY;
+import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_SERVICE_KEY;
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.StatusCode;
 import io.opentelemetry.context.Context;
@@ -124,8 +126,8 @@ public void run() {
       String methodName = getMethodName();
       Span span = TraceUtil.getGlobalTracer().spanBuilder("RpcServer.callMethod")
         .setParent(Context.current().with(((ServerCall<?>) call).getSpan())).startSpan()
-        .setAttribute(TraceUtil.RPC_SERVICE_KEY, serviceName)
-        .setAttribute(TraceUtil.RPC_METHOD_KEY, methodName);
+        .setAttribute(RPC_SERVICE_KEY, serviceName)
+        .setAttribute(RPC_METHOD_KEY, methodName);
       try (Scope traceScope = span.makeCurrent()) {
         if (!this.rpcServer.isStarted()) {
           InetSocketAddress address = rpcServer.getListenerAddress();