Add data field to SentrySpan.

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Fix: Handling missing Spring Security on classpath on Java 8 (#1552)
 * Feat: Support transaction waiting for children to finish. (#1535) 
 * Feat: Capture logged marker in log4j2 and logback appenders (#1551)
+* Fix: Add data field to SentrySpan (#1555)
 
 ## 5.1.0-beta.1
 

sentry/api/sentry.api

@@ -1664,6 +1664,8 @@ public final class io/sentry/protocol/SentryRuntime : io/sentry/IUnknownProperti
 
 public final class io/sentry/protocol/SentrySpan {
 	public fun <init> (Lio/sentry/Span;)V
+	public fun <init> (Lio/sentry/Span;Ljava/util/Map;)V
+	public fun getData ()Ljava/util/Map;
 	public fun getDescription ()Ljava/lang/String;
 	public fun getOp ()Ljava/lang/String;
 	public fun getParentSpanId ()Lio/sentry/SpanId;

sentry/src/main/java/io/sentry/protocol/SentrySpan.java

@@ -23,8 +23,14 @@ public final class SentrySpan {
   private final @Nullable String description;
   private final @Nullable SpanStatus status;
   private final @NotNull Map<String, String> tags;
+  private final @Nullable Map<String, Object> data;
 
   public SentrySpan(final @NotNull Span span) {
+    this(span, null);
+  }
+
+  @ApiStatus.Internal
+  public SentrySpan(final @NotNull Span span, final @Nullable Map<String, Object> data) {
     Objects.requireNonNull(span, "span is required");
     this.description = span.getDescription();
     this.op = span.getOperation();
@@ -36,6 +42,7 @@ public SentrySpan(final @NotNull Span span) {
     this.tags = tagsCopy != null ? tagsCopy : new ConcurrentHashMap<>();
     this.timestamp = span.getTimestamp();
     this.startTimestamp = span.getStartTimestamp();
+    this.data = data;
   }
 
   public boolean isFinished() {
@@ -77,4 +84,8 @@ public boolean isFinished() {
   public @NotNull Map<String, String> getTags() {
     return tags;
   }
+
+  public @Nullable Map<String, Object> getData() {
+    return data;
+  }
 }

sentry/src/test/java/io/sentry/GsonSerializerTest.kt

@@ -13,6 +13,7 @@ import io.sentry.exception.SentryEnvelopeException
 import io.sentry.protocol.Device
 import io.sentry.protocol.SdkVersion
 import io.sentry.protocol.SentryId
+import io.sentry.protocol.SentrySpan
 import io.sentry.protocol.SentryTransaction
 import java.io.BufferedWriter
 import java.io.ByteArrayInputStream
@@ -523,6 +524,9 @@ class GsonSerializerTest {
                               "status": "aborted",
                               "tags": {
                                 "name": "value"
+                              },
+                              "data": {
+                                "key": "value"
                               }
                             }
                           ]
@@ -547,6 +551,9 @@ class GsonSerializerTest {
         val span = transaction.spans[0]
         assertNotNull(span.startTimestamp)
         assertNotNull(span.timestamp)
+        assertNotNull(span.data) {
+            assertEquals("value", it["key"])
+        }
         assertEquals("2b099185293344a5bfdd7ad89ebf9416", span.traceId.toString())
         assertEquals("5b95c29a5ded4281", span.spanId.toString())
         assertEquals("a3b2d1d58b344b07", span.parentSpanId.toString())
@@ -556,6 +563,21 @@ class GsonSerializerTest {
         assertEquals(mapOf("name" to "value"), span.tags)
     }
 
+    @Test
+    fun `serializes span data`() {
+        val sentrySpan = SentrySpan(createSpan() as Span, mapOf("data1" to "value1"))
+
+        val stringWriter = StringWriter()
+        fixture.serializer.serialize(sentrySpan, stringWriter)
+
+        val element = JsonParser().parse(stringWriter.toString()).asJsonObject
+        assertNotNull(element["data"]) {
+            assertNotNull(it.asJsonObject["data1"]) {
+                assertEquals("value1", it.asString)
+            }
+        }
+    }
+
     @Test
     fun `serializing user feedback`() {
         val actual = serializeToString(userFeedback)
@@ -696,4 +718,17 @@ class GsonSerializerTest {
             comments = "comment"
         }
     }
+
+    private fun createSpan(): ISpan {
+        val trace = TransactionContext("transaction-name", "http").apply {
+            description = "some request"
+            status = SpanStatus.OK
+            setTag("myTag", "myValue")
+        }
+        val tracer = SentryTracer(trace, fixture.hub)
+        val span = tracer.startChild("child")
+        span.finish(SpanStatus.OK)
+        tracer.finish()
+        return span
+    }
 }