Fix error span status for successful requests in Ktor (#12161)

open-telemetry · Sep 3, 2024 · 4af6a3d · 4af6a3d
1 parent 98bf183
commit 4af6a3d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/...ry/src/main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/client/KtorClientTracing.kt b/...ry/src/main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/client/KtorClientTracing.kt
@@ -98,7 +98,11 @@ class KtorClientTracing internal constructor(
         scope.launch {
           val job = it.call.coroutineContext.job
           job.join()
-          val cause = job.getCancellationException()
+          val cause = if (!job.isCancelled) {
+            null
+          } else {
+            kotlin.runCatching { job.getCancellationException() }.getOrNull()
+          }
 
           plugin.endSpan(openTelemetryContext, it.call, cause)
         }

diff --git a/...in/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/client/AbstractKtorHttpClientTest.kt b/...in/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/client/AbstractKtorHttpClientTest.kt
@@ -19,6 +19,7 @@ import io.opentelemetry.instrumentation.testing.junit.http.HttpClientTestOptions
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientTestOptions.DEFAULT_HTTP_ATTRIBUTES
 import io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat
 import io.opentelemetry.sdk.testing.assertj.TraceAssert
+import io.opentelemetry.sdk.trace.data.StatusData
 import io.opentelemetry.semconv.NetworkAttributes
 import kotlinx.coroutines.*
 import org.junit.jupiter.api.Test
@@ -89,7 +90,7 @@ abstract class AbstractKtorHttpClientTest : AbstractHttpClientTest<HttpRequestBu
     testing.waitAndAssertTraces(
       Consumer { trace: TraceAssert ->
         val span = trace.getSpan(0)
-        assertThat(span).hasKind(SpanKind.CLIENT)
+        assertThat(span).hasKind(SpanKind.CLIENT).hasStatus(StatusData.unset())
         assertThat(span.endEpochNanos - span.startEpochNanos >= 1_000_000_000)
           .describedAs("Span duration should be at least 1000ms")
           .isTrue()

diff --git a/...main/java/io/opentelemetry/instrumentation/testing/junit/http/AbstractHttpClientTest.java b/...main/java/io/opentelemetry/instrumentation/testing/junit/http/AbstractHttpClientTest.java
@@ -118,7 +118,10 @@ void successfulGetRequest(String path) throws Exception {
     testing.waitAndAssertTraces(
         trace ->
             trace.hasSpansSatisfyingExactly(
-                span -> assertClientSpan(span, uri, method, responseCode, null).hasNoParent(),
+                span ->
+                    assertClientSpan(span, uri, method, responseCode, null)
+                        .hasNoParent()
+                        .hasStatus(StatusData.unset()),
                 span -> assertServerSpan(span).hasParent(trace.getSpan(0))));
   }