[release/v1.44.x] Fix regression in event attributes (#6866)

Co-authored-by: Trask Stalnaker <[email protected]>
open-telemetry · Nov 9, 2024 · d694852 · d694852
1 parent 08349dc
commit d694852
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 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
@@ -445,8 +445,7 @@ public ReadWriteSpan setStatus(StatusCode statusCode, @Nullable String descripti
 
   @Override
   public ReadWriteSpan recordException(Throwable exception) {
-    Attributes attributes = this.getAttributes();
-    recordException(exception, attributes);
+    recordException(exception, Attributes.empty());
     return this;
   }
 

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
@@ -878,6 +878,7 @@ void attributeLength() {
       assertThat(event.getAttributes().get(stringKey("exception.message"))).isEqualTo(strVal);
       assertThat(event.getAttributes().get(stringKey("exception.stacktrace")).length())
           .isLessThanOrEqualTo(maxLength);
+      assertThat(event.getAttributes().size()).isEqualTo(3);
     } finally {
       span.end();
     }
@@ -1159,6 +1160,9 @@ void recordException() {
     testClock.advance(Duration.ofNanos(1000));
     long timestamp = testClock.now();
 
+    // make sure that span attributes don't leak down to the exception event
+    span.setAttribute("spankey", "val");
+
     span.recordException(exception);
 
     List<EventData> events = span.toSpanData().getEvents();
@@ -1171,6 +1175,7 @@ void recordException() {
     assertThat(event.getAttributes().get(stringKey("exception.type")))
         .isEqualTo(exception.getClass().getName());
     assertThat(event.getAttributes().get(stringKey("exception.stacktrace"))).isEqualTo(stacktrace);
+    assertThat(event.getAttributes().size()).isEqualTo(3);
     assertThat(event)
         .isInstanceOfSatisfying(
             ExceptionEventData.class,
@@ -1184,12 +1189,20 @@ void recordException_noMessage() {
     IllegalStateException exception = new IllegalStateException();
     SdkSpan span = createTestRootSpan();
 
+    StringWriter writer = new StringWriter();
+    exception.printStackTrace(new PrintWriter(writer));
+    String stacktrace = writer.toString();
+
     span.recordException(exception);
 
     List<EventData> events = span.toSpanData().getEvents();
     assertThat(events).hasSize(1);
     EventData event = events.get(0);
     assertThat(event.getAttributes().get(stringKey("exception.message"))).isNull();
+    assertThat(event.getAttributes().get(stringKey("exception.type")))
+        .isEqualTo("java.lang.IllegalStateException");
+    assertThat(event.getAttributes().get(stringKey("exception.stacktrace"))).isEqualTo(stacktrace);
+    assertThat(event.getAttributes().size()).isEqualTo(2);
   }
 
   private static class InnerClassException extends Exception {}
@@ -1199,13 +1212,19 @@ void recordException_innerClassException() {
     InnerClassException exception = new InnerClassException();
     SdkSpan span = createTestRootSpan();
 
+    StringWriter writer = new StringWriter();
+    exception.printStackTrace(new PrintWriter(writer));
+    String stacktrace = writer.toString();
+
     span.recordException(exception);
 
     List<EventData> events = span.toSpanData().getEvents();
     assertThat(events).hasSize(1);
     EventData event = events.get(0);
     assertThat(event.getAttributes().get(stringKey("exception.type")))
         .isEqualTo("io.opentelemetry.sdk.trace.SdkSpanTest.InnerClassException");
+    assertThat(event.getAttributes().get(stringKey("exception.stacktrace"))).isEqualTo(stacktrace);
+    assertThat(event.getAttributes().size()).isEqualTo(2);
   }
 
   @Test
@@ -1220,6 +1239,9 @@ void recordException_additionalAttributes() {
     testClock.advance(Duration.ofNanos(1000));
     long timestamp = testClock.now();
 
+    // make sure that span attributes don't leak down to the exception event
+    span.setAttribute("spankey", "val");
+
     span.recordException(
         exception,
         Attributes.of(
@@ -1240,6 +1262,7 @@ void recordException_additionalAttributes() {
     assertThat(event.getAttributes().get(stringKey("exception.type")))
         .isEqualTo("java.lang.IllegalStateException");
     assertThat(event.getAttributes().get(stringKey("exception.stacktrace"))).isEqualTo(stacktrace);
+    assertThat(event.getAttributes().size()).isEqualTo(4);
 
     assertThat(event)
         .isInstanceOfSatisfying(