#6207 Ensure Span Status Cannot Be Updated After StatusCode.OK Is Set (…

…#6209)
open-telemetry · Feb 8, 2024 · c0b73f5 · c0b73f5
1 parent c12779d
commit c0b73f5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkSpan.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkSpan.java
@@ -394,6 +394,9 @@ public ReadWriteSpan setStatus(StatusCode statusCode, @Nullable String descripti
       if (hasEnded) {
         logger.log(Level.FINE, "Calling setStatus() on an ended Span.");
         return this;
+      } else if (this.status.getStatusCode() == StatusCode.OK) {
+        logger.log(Level.FINE, "Calling setStatus() on a Span that is already set to OK.");
+        return this;
       }
       this.status = StatusData.create(statusCode, description);
     }

diff --git a/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/SdkSpanTest.java b/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/SdkSpanTest.java
@@ -1178,6 +1178,17 @@ void onStartOnEndNotRequired() {
     verify(spanProcessor, never()).onEnd(any());
   }
 
+  @Test
+  void setStatusCannotOverrideStatusOK() {
+    SdkSpan testSpan = createTestRootSpan();
+    testSpan.setStatus(StatusCode.OK);
+    assertThat(testSpan.toSpanData().getStatus().getStatusCode()).isEqualTo(StatusCode.OK);
+    testSpan.setStatus(StatusCode.ERROR);
+    assertThat(testSpan.toSpanData().getStatus().getStatusCode()).isEqualTo(StatusCode.OK);
+    testSpan.setStatus(StatusCode.UNSET);
+    assertThat(testSpan.toSpanData().getStatus().getStatusCode()).isEqualTo(StatusCode.OK);
+  }
+
   private SdkSpan createTestSpanWithAttributes(Map<AttributeKey, Object> attributes) {
     SpanLimits spanLimits = SpanLimits.getDefault();
     AttributesMap attributesMap =