This is an automated email from the ASF dual-hosted git repository.
sumitagrawl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new 5425ee3f86c HDDS-15781. Adding Spankind information to ozone sh
commands (#10695)
5425ee3f86c is described below
commit 5425ee3f86cd3f7086c27b7c70ebff134f14abc0
Author: sravani <[email protected]>
AuthorDate: Tue Aug 11 14:30:26 2026 +0530
HDDS-15781. Adding Spankind information to ozone sh commands (#10695)
---
hadoop-hdds/client/pom.xml | 4 +
.../apache/hadoop/hdds/scm/XceiverClientGrpc.java | 5 +-
.../apache/hadoop/hdds/scm/XceiverClientRatis.java | 3 +-
.../hadoop/hdds/tracing/GrpcServerInterceptor.java | 4 +-
.../hadoop/hdds/tracing/InternalSpanKind.java | 33 ++++++++
.../apache/hadoop/hdds/tracing/TraceAllMethod.java | 9 ++-
.../apache/hadoop/hdds/tracing/TracingUtil.java | 56 ++++++++++++--
.../hadoop/hdds/tracing/TestTraceAllMethod.java | 20 +++++
.../hdds/tracing/TestTracingAnnotations.java | 88 ++++++++++++++++++++++
.../hadoop/hdds/tracing/TestTracingUtil.java | 77 +++++++++++--------
.../common/transport/server/XceiverServerGrpc.java | 4 +-
.../transport/server/ratis/XceiverServerRatis.java | 4 +-
.../server/OzoneProtocolMessageDispatcher.java | 3 +-
hadoop-ozone/cli-shell/pom.xml | 4 +
.../java/org/apache/hadoop/ozone/shell/Shell.java | 3 +-
...OzoneManagerProtocolClientSideTranslatorPB.java | 3 +
16 files changed, 271 insertions(+), 49 deletions(-)
diff --git a/hadoop-hdds/client/pom.xml b/hadoop-hdds/client/pom.xml
index d32178ff5fe..15d82468283 100644
--- a/hadoop-hdds/client/pom.xml
+++ b/hadoop-hdds/client/pom.xml
@@ -36,6 +36,10 @@
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
</dependency>
+ <dependency>
+ <groupId>io.opentelemetry</groupId>
+ <artifactId>opentelemetry-api</artifactId>
+ </dependency>
<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
diff --git
a/hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientGrpc.java
b/hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientGrpc.java
index bf8374f5e3a..93e7c005934 100644
---
a/hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientGrpc.java
+++
b/hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientGrpc.java
@@ -20,6 +20,7 @@
import static org.apache.hadoop.hdds.HddsUtils.processForDebug;
import com.google.common.annotations.VisibleForTesting;
+import io.opentelemetry.api.trace.SpanKind;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.io.UncheckedIOException;
@@ -412,7 +413,7 @@ private XceiverClientReply sendCommandWithTraceIDAndRetry(
String spanName = "XceiverClientGrpc." + request.getCmdType().name();
- return TracingUtil.executeInNewSpan(spanName,
+ return TracingUtil.executeInNewSpan(spanName, SpanKind.CLIENT,
() -> {
ContainerCommandRequestProto.Builder builder =
ContainerCommandRequestProto.newBuilder(request)
@@ -680,7 +681,7 @@ public XceiverClientReply sendCommandAsync(
throws IOException, ExecutionException, InterruptedException {
try (TracingUtil.TraceCloseable ignored = TracingUtil.createActivatedSpan(
- "XceiverClientGrpc." + request.getCmdType().name())) {
+ "XceiverClientGrpc." + request.getCmdType().name(), SpanKind.CLIENT)) {
ContainerCommandRequestProto.Builder builder =
ContainerCommandRequestProto.newBuilder(request)
diff --git
a/hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientRatis.java
b/hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientRatis.java
index 08ad7298e2a..e24e326920c 100644
---
a/hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientRatis.java
+++
b/hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientRatis.java
@@ -19,6 +19,7 @@
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
+import io.opentelemetry.api.trace.SpanKind;
import java.io.IOException;
import java.util.Collection;
import java.util.Comparator;
@@ -253,7 +254,7 @@ private CompletableFuture<RaftClientReply> sendRequestAsync(
}
}
return TracingUtil.executeInNewSpan(
- "XceiverClientRatis." + request.getCmdType().name(),
+ "XceiverClientRatis." + request.getCmdType().name(), SpanKind.CLIENT,
() -> {
final ContainerCommandRequestMessage message
= ContainerCommandRequestMessage.toMessage(
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/GrpcServerInterceptor.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/GrpcServerInterceptor.java
index af1b77facd1..5deea9f8b0c 100644
---
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/GrpcServerInterceptor.java
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/GrpcServerInterceptor.java
@@ -18,6 +18,7 @@
package org.apache.hadoop.hdds.tracing;
import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.context.Scope;
import
org.apache.ratis.thirdparty.io.grpc.ForwardingServerCallListener.SimpleForwardingServerCallListener;
import org.apache.ratis.thirdparty.io.grpc.Metadata;
@@ -44,7 +45,8 @@ public void onMessage(ReqT message) {
Span span = TracingUtil
.importAndCreateSpan(
call.getMethodDescriptor().getFullMethodName(),
- headers.get(GrpcClientInterceptor.TRACING_HEADER));
+ headers.get(GrpcClientInterceptor.TRACING_HEADER),
+ SpanKind.SERVER);
try (Scope ignored = span.makeCurrent()) {
super.onMessage(message);
} finally {
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/InternalSpanKind.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/InternalSpanKind.java
new file mode 100644
index 00000000000..de34d8fa25d
--- /dev/null
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/InternalSpanKind.java
@@ -0,0 +1,33 @@
+/*
+ * 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.hdds.tracing;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation that marks a proxied client method as SpanKind.INTERNAL.
+ * Used for methods that do not send an outbound RPC.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+public @interface InternalSpanKind {
+}
+
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/TraceAllMethod.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/TraceAllMethod.java
index 623e004a96e..b2d4f8ade73 100644
---
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/TraceAllMethod.java
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/TraceAllMethod.java
@@ -19,6 +19,7 @@
import static java.util.Collections.emptyMap;
+import io.opentelemetry.api.trace.SpanKind;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.util.Arrays;
@@ -77,7 +78,13 @@ public Object invoke(Object proxy, Method method, Object[]
args)
}
}
- try (TracingUtil.TraceCloseable ignored =
TracingUtil.createActivatedSpan(name + "." + method.getName())) {
+ // if a call is within a process, not an outbound RPC to other processes
(OM/SCM/DN) , it is marked as INTERNAL.
+ SpanKind spanKind =
delegateMethod.isAnnotationPresent(InternalSpanKind.class)
+ ? SpanKind.INTERNAL
+ : SpanKind.CLIENT;
+
+ try (TracingUtil.TraceCloseable ignored = TracingUtil.createActivatedSpan(
+ name + "." + method.getName(), spanKind)) {
try {
return delegateMethod.invoke(delegate, args);
} catch (Exception ex) {
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/TracingUtil.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/TracingUtil.java
index c5624c3c214..3684775d019 100644
---
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/TracingUtil.java
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/tracing/TracingUtil.java
@@ -22,6 +22,7 @@
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
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.api.trace.propagation.W3CTraceContextPropagator;
@@ -133,9 +134,18 @@ public static <R, E extends Exception> R execute(
String spanName,
ConfigurationSource conf,
CheckedSupplier<R, E> supplier) throws E {
+ return execute(serviceName, spanName, SpanKind.INTERNAL, conf, supplier);
+ }
+
+ public static <R, E extends Exception> R execute(
+ String serviceName,
+ String spanName,
+ SpanKind spanKind,
+ ConfigurationSource conf,
+ CheckedSupplier<R, E> supplier) throws E {
initTracing(serviceName, conf);
try {
- return executeInNewSpan(spanName, supplier);
+ return executeInNewSpan(spanName, spanKind, supplier);
} finally {
flushTracing();
}
@@ -311,6 +321,11 @@ public static String exportCurrentSpan() {
* @return Tracing scope.
*/
public static Span importAndCreateSpan(String name, String encodedParent) {
+ return importAndCreateSpan(name, encodedParent, SpanKind.INTERNAL);
+ }
+
+ public static Span importAndCreateSpan(String name, String encodedParent,
+ SpanKind spanKind) {
if (!hasUsableTracer()) {
return Span.getInvalid();
}
@@ -318,13 +333,17 @@ public static Span importAndCreateSpan(String name,
String encodedParent) {
if (!canStartSpanWithoutParent()) {
return Span.getInvalid();
}
- return tracer.spanBuilder(name).setNoParent().startSpan();
+ return tracer.spanBuilder(name)
+ .setNoParent()
+ .setSpanKind(spanKind)
+ .startSpan();
}
W3CTraceContextPropagator propagator =
W3CTraceContextPropagator.getInstance();
Context extract = propagator.extract(Context.current(), encodedParent, new
TextExtractor());
return tracer.spanBuilder(name)
.setParent(extract)
+ .setSpanKind(spanKind)
.startSpan();
}
@@ -423,7 +442,12 @@ static Map<String, LoopSampler>
parseSpanSamplingConfig(String configStr) {
*/
public static <E extends Exception> void executeInNewSpan(String spanName,
CheckedRunnable<E> runnable) throws E {
- Span span = buildSpan(spanName);
+ executeInNewSpan(spanName, SpanKind.INTERNAL, runnable);
+ }
+
+ public static <E extends Exception> void executeInNewSpan(String spanName,
+ SpanKind spanKind, CheckedRunnable<E> runnable) throws E {
+ Span span = buildSpan(spanName, spanKind);
executeInSpan(span, runnable);
}
@@ -432,7 +456,12 @@ public static <E extends Exception> void
executeInNewSpan(String spanName,
*/
public static <R, E extends Exception> R executeInNewSpan(String spanName,
CheckedSupplier<R, E> supplier) throws E {
- Span span = buildSpan(spanName);
+ return executeInNewSpan(spanName, SpanKind.INTERNAL, supplier);
+ }
+
+ public static <R, E extends Exception> R executeInNewSpan(String spanName,
+ SpanKind spanKind, CheckedSupplier<R, E> supplier) throws E {
+ Span span = buildSpan(spanName, spanKind);
return executeInSpan(span, supplier);
}
@@ -486,7 +515,11 @@ public static <E extends Exception> void
executeAsChildSpan(String spanName,
* in case of Exceptions.
*/
public static TraceCloseable createActivatedSpan(String spanName) {
- Span span = buildSpan(spanName);
+ return createActivatedSpan(spanName, SpanKind.INTERNAL);
+ }
+
+ public static TraceCloseable createActivatedSpan(String spanName, SpanKind
spanKind) {
+ Span span = buildSpan(spanName, spanKind);
Scope scope = span.makeCurrent();
return () -> {
scope.close();
@@ -547,17 +580,23 @@ private void parse(String carrier) {
* Otherwise starts a root span only when {@code ozone.tracing.enabled=true};
* if not, returns an invalid span so application-aware mode never starts a
new trace.
*/
- private static Span buildSpan(String spanName) {
+ private static Span buildSpan(String spanName, SpanKind spanKind) {
Context currentContext = Context.current();
Span parentSpan = Span.fromContext(currentContext);
if (parentSpan.getSpanContext().isValid()) {
- return
tracer.spanBuilder(spanName).setParent(currentContext).startSpan();
+ return tracer.spanBuilder(spanName)
+ .setParent(currentContext)
+ .setSpanKind(spanKind)
+ .startSpan();
}
if (!canStartSpanWithoutParent()) {
return Span.getInvalid();
}
- return tracer.spanBuilder(spanName).setNoParent().startSpan();
+ return tracer.spanBuilder(spanName)
+ .setNoParent()
+ .setSpanKind(spanKind)
+ .startSpan();
}
/**
@@ -595,6 +634,7 @@ public static TraceCloseable
createActivatedSpanFromW3cHttpHeaders(
Span span = tracer.spanBuilder(spanName)
.setParent(remote)
+ .setSpanKind(SpanKind.SERVER)
.startSpan();
Scope scope = span.makeCurrent();
diff --git
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTraceAllMethod.java
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTraceAllMethod.java
index f24a54367b3..8c10861d931 100644
---
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTraceAllMethod.java
+++
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTraceAllMethod.java
@@ -21,6 +21,8 @@
import static org.junit.jupiter.api.Assertions.assertThrows;
import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.sdk.trace.ReadableSpan;
import java.io.IOException;
import org.junit.jupiter.api.Test;
@@ -54,6 +56,8 @@ default String defaultMethod() {
return otherMethod("default");
}
+ String localMethod();
+
String skippedMethod();
void throwingMethod() throws IOException;
@@ -69,6 +73,11 @@ default String defaultMethod() {
public static class ServiceImpl implements Service {
private boolean spanActive = false;
+ private SpanKind spanKind;
+
+ public SpanKind lastSpanKind() {
+ return spanKind;
+ }
@Override
public String otherMethod(String name) {
@@ -95,6 +104,17 @@ public String normalMethod() {
return "normal";
}
+ @Override
+ @InternalSpanKind
+ public String localMethod() {
+ Span span = Span.current();
+ this.spanActive = span.getSpanContext().isValid();
+ if (spanActive) {
+ this.spanKind = ((ReadableSpan) span).getKind();
+ }
+ return "local";
+ }
+
public boolean wasSpanActive() {
return spanActive;
}
diff --git
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTracingAnnotations.java
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTracingAnnotations.java
new file mode 100644
index 00000000000..823758ff93e
--- /dev/null
+++
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTracingAnnotations.java
@@ -0,0 +1,88 @@
+/*
+ * 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.hdds.tracing;
+
+import static org.apache.hadoop.hdds.tracing.TracingUtil.createProxy;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import io.opentelemetry.api.trace.SpanKind;
+import java.io.IOException;
+import org.apache.hadoop.hdds.conf.InMemoryConfigurationForTesting;
+import org.apache.hadoop.hdds.conf.MutableConfigurationSource;
+import org.apache.hadoop.hdds.tracing.TestTraceAllMethod.Service;
+import org.apache.hadoop.hdds.tracing.TestTraceAllMethod.ServiceImpl;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test for Tracing related annotations.
+ * {@link SkipTracing} , {@link InternalSpanKind}.
+ */
+public class TestTracingAnnotations {
+
+ private static MutableConfigurationSource tracingEnabled() {
+ MutableConfigurationSource config = new InMemoryConfigurationForTesting();
+ config.setBoolean("ozone.tracing.enabled", true);
+ return config;
+ }
+
+ @Test
+ public void testSkipTracingNoSpan() {
+ TracingUtil.initTracing("TestService", tracingEnabled());
+ ServiceImpl impl = new ServiceImpl();
+ Service serviceProxy = createProxy(impl, Service.class, tracingEnabled());
+
+ serviceProxy.skippedMethod();
+ assertFalse(impl.wasSpanActive(), "Span should NOT be created for
@SkipTracing methods.");
+ }
+
+ @Test
+ public void testSkipTracingExceptionUnwrapped() {
+ TracingUtil.initTracing("TestService", tracingEnabled());
+ ServiceImpl impl = new ServiceImpl();
+ Service serviceProxy = createProxy(impl, Service.class, tracingEnabled());
+
+ IOException ex = assertThrows(IOException.class,
+ () -> serviceProxy.throwingMethod());
+ assertEquals("Original Exception", ex.getMessage());
+ assertFalse(impl.wasSpanActive(), "Span should NOT have been created for a
@SkipTracing throwing method.");
+ }
+
+ @Test
+ public void testProxyNormalVsSkipped() {
+ TracingUtil.initTracing("TestService", tracingEnabled());
+ ServiceImpl impl = new ServiceImpl();
+ Service serviceProxy = createProxy(impl, Service.class, tracingEnabled());
+
+ serviceProxy.normalMethod();
+ assertTrue(impl.wasSpanActive(), "Normal method should have an active
span.");
+ }
+
+ @Test
+ public void testInternalSpanKind() {
+ TracingUtil.initTracing("TestService", tracingEnabled());
+ ServiceImpl impl = new ServiceImpl();
+ Service serviceProxy = createProxy(impl, Service.class, tracingEnabled());
+ serviceProxy.localMethod();
+ assertTrue(impl.wasSpanActive(), "Local method should have an active
span.");
+ assertEquals(SpanKind.INTERNAL, impl.lastSpanKind(), "@InternalSpanKind
method should use INTERNAL.");
+ }
+
+}
diff --git
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTracingUtil.java
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTracingUtil.java
index 4474e8a42c4..49bb7a45178 100644
---
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTracingUtil.java
+++
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/tracing/TestTracingUtil.java
@@ -29,7 +29,9 @@
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
+import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.context.Scope;
+import io.opentelemetry.sdk.trace.ReadableSpan;
import java.io.IOException;
import org.apache.hadoop.hdds.conf.InMemoryConfigurationForTesting;
import org.apache.hadoop.hdds.conf.MutableConfigurationSource;
@@ -67,6 +69,10 @@ private static String parentSpanIdFromExportedCarrier(String
parentCarrier) {
return parts[2];
}
+ private static SpanKind spanKind(Span span) {
+ return ((ReadableSpan) span).getKind();
+ }
+
@Test
public void testDefaultMethod() {
Service subject = createProxy(new ServiceImpl(), Service.class,
@@ -85,38 +91,6 @@ public void testInitTracing() {
}
}
- @Test
- public void testSkipTracingNoSpan() {
- TracingUtil.initTracing("TestService", tracingEnabled());
- ServiceImpl impl = new ServiceImpl();
- Service serviceProxy = createProxy(impl, Service.class, tracingEnabled());
-
- serviceProxy.skippedMethod();
- assertFalse(impl.wasSpanActive(), "Span should NOT be created for
@SkipTracing methods.");
- }
-
- @Test
- public void testSkipTracingExceptionUnwrapped() {
- TracingUtil.initTracing("TestService", tracingEnabled());
- ServiceImpl impl = new ServiceImpl();
- Service serviceProxy = createProxy(impl, Service.class, tracingEnabled());
-
- IOException ex = assertThrows(IOException.class,
- () -> serviceProxy.throwingMethod());
- assertEquals("Original Exception", ex.getMessage());
- assertFalse(impl.wasSpanActive(), "Span should NOT have been created for a
@SkipTracing throwing method.");
- }
-
- @Test
- public void testProxyNormalVsSkipped() {
- TracingUtil.initTracing("TestService", tracingEnabled());
- ServiceImpl impl = new ServiceImpl();
- Service serviceProxy = createProxy(impl, Service.class, tracingEnabled());
-
- serviceProxy.normalMethod();
- assertTrue(impl.wasSpanActive(), "Normal method should have an active
span.");
- }
-
@Test
public void testImportAndCreateSpanNullOrEmptyParent() {
TracingUtil.initTracing("NoParentService",
tracingEnabled().getObject(TracingConfig.class));
@@ -214,4 +188,43 @@ public void testTextExtractorEmptyAndMalformedEntries() {
assertEquals("00-a-b-01", ex2.get(carrier, "traceparent"));
assertEquals("00-a-b-01", ex2.get(carrier, "traceparent"));
}
+
+ @Test
+ public void testImportAndCreateSpanDefaultsToInternal() {
+ TracingUtil.initTracing("serviceTestKind",
+ tracingEnabled().getObject(TracingConfig.class));
+
+ Span root = TracingUtil.importAndCreateSpan("rootspan", null);
+ try {
+ assertEquals(SpanKind.INTERNAL, spanKind(root));
+ } finally {
+ root.end();
+ }
+
+ String parent;
+ try (TracingUtil.TraceCloseable ignored =
+ TracingUtil.createActivatedSpan("parentSpan")) {
+ parent = TracingUtil.exportCurrentSpan();
+ }
+ Span child = TracingUtil.importAndCreateSpan("childSpan", parent);
+ try {
+ assertEquals(SpanKind.INTERNAL, spanKind(child));
+ } finally {
+ child.end();
+ }
+ }
+
+ @Test
+ public void testImportAndCreateSpanUsesExplicitKind() {
+ TracingUtil.initTracing("span-kind-explicit",
+ tracingEnabled().getObject(TracingConfig.class));
+
+ Span server = TracingUtil.importAndCreateSpan(
+ "server", null, SpanKind.SERVER);
+ try {
+ assertEquals(SpanKind.SERVER, spanKind(server));
+ } finally {
+ server.end();
+ }
+ }
}
diff --git
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/transport/server/XceiverServerGrpc.java
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/transport/server/XceiverServerGrpc.java
index 3eedbecf389..27d697fea75 100644
---
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/transport/server/XceiverServerGrpc.java
+++
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/transport/server/XceiverServerGrpc.java
@@ -20,6 +20,7 @@
import com.google.common.annotations.VisibleForTesting;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.context.Scope;
import java.io.IOException;
import java.net.BindException;
@@ -253,7 +254,8 @@ public void submitRequest(ContainerCommandRequestProto
request,
Span span = TracingUtil
.importAndCreateSpan(
"XceiverServerGrpc." + request.getCmdType().name(),
- request.getTraceID());
+ request.getTraceID(),
+ SpanKind.SERVER);
try (Scope ignore = span.makeCurrent()) {
ContainerProtos.ContainerCommandResponseProto response =
storageContainer.dispatch(request, null);
diff --git
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/transport/server/ratis/XceiverServerRatis.java
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/transport/server/ratis/XceiverServerRatis.java
index 2fd065cf6be..90c413088e8 100644
---
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/transport/server/ratis/XceiverServerRatis.java
+++
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/transport/server/ratis/XceiverServerRatis.java
@@ -31,6 +31,7 @@
import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.context.Scope;
import java.io.File;
import java.io.IOException;
@@ -663,7 +664,8 @@ public void submitRequest(ContainerCommandRequestProto
request,
Span span = TracingUtil
.importAndCreateSpan(
"XceiverServerRatis." + request.getCmdType().name(),
- request.getTraceID());
+ request.getTraceID(),
+ SpanKind.SERVER);
try (Scope ignored = span.makeCurrent()) {
RaftClientRequest raftClientRequest =
createRaftClientRequest(request, pipelineID,
diff --git
a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/server/OzoneProtocolMessageDispatcher.java
b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/server/OzoneProtocolMessageDispatcher.java
index 94a35d488ab..29fc54642eb 100644
---
a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/server/OzoneProtocolMessageDispatcher.java
+++
b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/server/OzoneProtocolMessageDispatcher.java
@@ -19,6 +19,7 @@
import com.google.protobuf.ServiceException;
import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.context.Scope;
import java.util.function.Function;
import org.apache.hadoop.hdds.tracing.TracingUtil;
@@ -71,7 +72,7 @@ public RESPONSE processRequest(
CheckedFunction<REQUEST, RESPONSE, ServiceException> methodCall,
TYPE type,
String traceId) throws ServiceException {
- Span span = TracingUtil.importAndCreateSpan(type.toString(), traceId);
+ Span span = TracingUtil.importAndCreateSpan(type.toString(), traceId,
SpanKind.SERVER);
try (Scope currentScope = span.makeCurrent()) {
if (logger.isTraceEnabled()) {
logger.trace(
diff --git a/hadoop-ozone/cli-shell/pom.xml b/hadoop-ozone/cli-shell/pom.xml
index b03bbe033d6..ef7394ca469 100644
--- a/hadoop-ozone/cli-shell/pom.xml
+++ b/hadoop-ozone/cli-shell/pom.xml
@@ -55,6 +55,10 @@
<groupId>info.picocli</groupId>
<artifactId>picocli-shell-jline3</artifactId>
</dependency>
+ <dependency>
+ <groupId>io.opentelemetry</groupId>
+ <artifactId>opentelemetry-api</artifactId>
+ </dependency>
<dependency>
<groupId>jakarta.xml.bind</groupId>
<artifactId>jakarta.xml.bind-api</artifactId>
diff --git
a/hadoop-ozone/cli-shell/src/main/java/org/apache/hadoop/ozone/shell/Shell.java
b/hadoop-ozone/cli-shell/src/main/java/org/apache/hadoop/ozone/shell/Shell.java
index f3e5efdd98a..0ae6c5b850f 100644
---
a/hadoop-ozone/cli-shell/src/main/java/org/apache/hadoop/ozone/shell/Shell.java
+++
b/hadoop-ozone/cli-shell/src/main/java/org/apache/hadoop/ozone/shell/Shell.java
@@ -17,6 +17,7 @@
package org.apache.hadoop.ozone.shell;
+import io.opentelemetry.api.trace.SpanKind;
import java.util.Collections;
import java.util.List;
import org.apache.hadoop.hdds.cli.GenericCli;
@@ -100,7 +101,7 @@ private int execute(CommandLine.ParseResult parseResult) {
}
String spanName = spec.name() + " " + String.join(" ",
parseResult.originalArgs());
- return TracingUtil.execute("shell", spanName, getOzoneConf(),
+ return TracingUtil.execute("shell", spanName, SpanKind.INTERNAL,
getOzoneConf(),
() -> new CommandLine.RunLast().execute(parseResult));
}
diff --git
a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/protocolPB/OzoneManagerProtocolClientSideTranslatorPB.java
b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/protocolPB/OzoneManagerProtocolClientSideTranslatorPB.java
index 2826239f02e..3a2007d774a 100644
---
a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/protocolPB/OzoneManagerProtocolClientSideTranslatorPB.java
+++
b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/protocolPB/OzoneManagerProtocolClientSideTranslatorPB.java
@@ -49,6 +49,7 @@
import
org.apache.hadoop.hdds.protocol.proto.HddsProtos.TransferLeadershipRequestProto;
import
org.apache.hadoop.hdds.protocol.proto.HddsProtos.UpgradeFinalizationStatus;
import org.apache.hadoop.hdds.scm.container.common.helpers.ExcludeList;
+import org.apache.hadoop.hdds.tracing.InternalSpanKind;
import org.apache.hadoop.hdds.tracing.SkipTracing;
import org.apache.hadoop.hdds.tracing.TracingUtil;
import org.apache.hadoop.io.Text;
@@ -302,6 +303,7 @@ public
OzoneManagerProtocolClientSideTranslatorPB(OmTransport omTransport,
* @throws IOException if an I/O error occurs
*/
@Override
+ @InternalSpanKind
public void close() throws IOException {
//transport is not reusable
transport.close();
@@ -2191,6 +2193,7 @@ public void clearThreadLocalS3Auth() {
}
@Override
+ @SkipTracing
public ThreadLocal<S3Auth> getS3CredentialsProvider() {
return this.threadLocalS3Auth;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
