Skip to content

Commit ca9350d

Browse files
adinaueradinauer
committed
Switch from span id attribute to property on SentryLogEvent
1 parent 94bff8d commit ca9350d

File tree

6 files changed

+130
-6
lines changed

6 files changed

+130
-6
lines changed

‎sentry/api/sentry.api‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3238,15 +3238,19 @@ public final class io/sentry/SentryLogEvent : io/sentry/JsonSerializable, io/sen
32383238
public fun getBody ()Ljava/lang/String;
32393239
public fun getLevel ()Lio/sentry/SentryLogLevel;
32403240
public fun getSeverityNumber ()Ljava/lang/Integer;
3241+
public fun getSpanId ()Lio/sentry/SpanId;
32413242
public fun getTimestamp ()Ljava/lang/Double;
3243+
public fun getTraceId ()Lio/sentry/protocol/SentryId;
32423244
public fun getUnknown ()Ljava/util/Map;
32433245
public fun serialize (Lio/sentry/ObjectWriter;Lio/sentry/ILogger;)V
32443246
public fun setAttribute (Ljava/lang/String;Lio/sentry/SentryLogEventAttributeValue;)V
32453247
public fun setAttributes (Ljava/util/Map;)V
32463248
public fun setBody (Ljava/lang/String;)V
32473249
public fun setLevel (Lio/sentry/SentryLogLevel;)V
32483250
public fun setSeverityNumber (Ljava/lang/Integer;)V
3251+
public fun setSpanId (Lio/sentry/SpanId;)V
32493252
public fun setTimestamp (Ljava/lang/Double;)V
3253+
public fun setTraceId (Lio/sentry/protocol/SentryId;)V
32503254
public fun setUnknown (Ljava/util/Map;)V
32513255
}
32523256

@@ -3261,6 +3265,7 @@ public final class io/sentry/SentryLogEvent$JsonKeys {
32613265
public static final field BODY Ljava/lang/String;
32623266
public static final field LEVEL Ljava/lang/String;
32633267
public static final field SEVERITY_NUMBER Ljava/lang/String;
3268+
public static final field SPAN_ID Ljava/lang/String;
32643269
public static final field TIMESTAMP Ljava/lang/String;
32653270
public static final field TRACE_ID Ljava/lang/String;
32663271
public fun <init> ()V

‎sentry/src/main/java/io/sentry/SentryLogEvent.java‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
public final class SentryLogEvent implements JsonUnknown, JsonSerializable {
1414

1515
private @NotNull SentryId traceId;
16+
private @Nullable SpanId spanId;
1617
private @NotNull Double timestamp;
1718
private @NotNull String body;
1819
private @NotNull SentryLogLevel level;
@@ -92,10 +93,27 @@ public void setSeverityNumber(final @Nullable Integer severityNumber) {
9293
this.severityNumber = severityNumber;
9394
}
9495

96+
public @Nullable SpanId getSpanId() {
97+
return spanId;
98+
}
99+
100+
public void setSpanId(final @Nullable SpanId spanId) {
101+
this.spanId = spanId;
102+
}
103+
104+
public @NotNull SentryId getTraceId() {
105+
return traceId;
106+
}
107+
108+
public void setTraceId(final @NotNull SentryId traceId) {
109+
this.traceId = traceId;
110+
}
111+
95112
// region json
96113
public static final class JsonKeys {
97114
public static final String TIMESTAMP = "timestamp";
98115
public static final String TRACE_ID = "trace_id";
116+
public static final String SPAN_ID = "span_id";
99117
public static final String LEVEL = "level";
100118
public static final String SEVERITY_NUMBER = "severity_number";
101119
public static final String BODY = "body";
@@ -109,6 +127,9 @@ public void serialize(final @NotNull ObjectWriter writer, final @NotNull ILogger
109127
writer.beginObject();
110128
writer.name(JsonKeys.TIMESTAMP).value(logger, doubleToBigDecimal(timestamp));
111129
writer.name(JsonKeys.TRACE_ID).value(logger, traceId);
130+
if (spanId != null) {
131+
writer.name(JsonKeys.SPAN_ID).value(logger, spanId);
132+
}
112133
writer.name(JsonKeys.BODY).value(body);
113134
writer.name(JsonKeys.LEVEL).value(logger, level);
114135
if (severityNumber != null) {
@@ -145,6 +166,7 @@ public static final class Deserializer implements JsonDeserializer<SentryLogEven
145166
final @NotNull ObjectReader reader, final @NotNull ILogger logger) throws Exception {
146167
@Nullable Map<String, Object> unknown = null;
147168
@Nullable SentryId traceId = null;
169+
@Nullable SpanId spanId = null;
148170
@Nullable Double timestamp = null;
149171
@Nullable String body = null;
150172
@Nullable SentryLogLevel level = null;
@@ -158,6 +180,9 @@ public static final class Deserializer implements JsonDeserializer<SentryLogEven
158180
case JsonKeys.TRACE_ID:
159181
traceId = reader.nextOrNull(logger, new SentryId.Deserializer());
160182
break;
183+
case JsonKeys.SPAN_ID:
184+
spanId = reader.nextOrNull(logger, new SpanId.Deserializer());
185+
break;
161186
case JsonKeys.TIMESTAMP:
162187
timestamp = reader.nextDoubleOrNull();
163188
break;
@@ -216,6 +241,7 @@ public static final class Deserializer implements JsonDeserializer<SentryLogEven
216241

217242
logEvent.setAttributes(attributes);
218243
logEvent.setSeverityNumber(severityNumber);
244+
logEvent.setSpanId(spanId);
219245
logEvent.setUnknown(unknown);
220246

221247
return logEvent;

‎sentry/src/main/java/io/sentry/logger/LoggerApi.java‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,8 @@ private void captureLog(
131131
span == null ? propagationContext.getSpanId() : span.getSpanContext().getSpanId();
132132
final SentryLogEvent logEvent =
133133
new SentryLogEvent(traceId, timestampToUse, messageToUse, level);
134-
logEvent.setAttributes(createAttributes(params, message, spanId, args));
134+
logEvent.setSpanId(spanId);
135+
logEvent.setAttributes(createAttributes(params, message, args));
135136
logEvent.setSeverityNumber(level.getSeverityNumber());
136137

137138
scopes.getClient().captureLog(logEvent, combinedScope);
@@ -160,7 +161,6 @@ private void captureLog(
160161
private @NotNull HashMap<String, SentryLogEventAttributeValue> createAttributes(
161162
final @NotNull SentryLogParameters params,
162163
final @NotNull String message,
163-
final @NotNull SpanId spanId,
164164
final @Nullable Object... args) {
165165
final @NotNull HashMap<String, SentryLogEventAttributeValue> attributes = new HashMap<>();
166166
final @NotNull String origin = params.getOrigin();
@@ -239,10 +239,6 @@ private void captureLog(
239239
"sentry.release", new SentryLogEventAttributeValue(SentryAttributeType.STRING, release));
240240
}
241241

242-
attributes.put(
243-
"sentry.trace.parent_span_id",
244-
new SentryLogEventAttributeValue(SentryAttributeType.STRING, spanId));
245-
246242
if (Platform.isJvm()) {
247243
setServerName(attributes);
248244
}

‎sentry/src/test/java/io/sentry/ScopesTest.kt‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3125,6 +3125,52 @@ class ScopesTest {
31253125
)
31263126
}
31273127

3128+
@Test
3129+
fun `log event has spanId from active span`() {
3130+
val (sut, mockClient) = getEnabledScopes { it.logs.isEnabled = true }
3131+
3132+
val transaction =
3133+
sut.startTransaction(
3134+
"test transaction",
3135+
"test.op",
3136+
TransactionOptions().also { it.isBindToScope = true },
3137+
)
3138+
3139+
sut.logger().log(SentryLogLevel.WARN, "log message")
3140+
3141+
verify(mockClient)
3142+
.captureLog(
3143+
check {
3144+
assertEquals("log message", it.body)
3145+
assertEquals(transaction.spanContext.traceId, it.traceId)
3146+
assertEquals(transaction.spanContext.spanId, it.spanId)
3147+
},
3148+
anyOrNull(),
3149+
)
3150+
3151+
transaction.finish()
3152+
}
3153+
3154+
@Test
3155+
fun `log event has spanId from propagation context when no active span`() {
3156+
val (sut, mockClient) = getEnabledScopes { it.logs.isEnabled = true }
3157+
3158+
var propagationContext: PropagationContext? = null
3159+
sut.configureScope { propagationContext = it.propagationContext }
3160+
3161+
sut.logger().log(SentryLogLevel.WARN, "log message")
3162+
3163+
verify(mockClient)
3164+
.captureLog(
3165+
check {
3166+
assertEquals("log message", it.body)
3167+
assertEquals(propagationContext!!.traceId, it.traceId)
3168+
assertEquals(propagationContext!!.spanId, it.spanId)
3169+
},
3170+
anyOrNull(),
3171+
)
3172+
}
3173+
31283174
// endregion
31293175

31303176
// region metrics
@@ -4043,6 +4089,54 @@ class ScopesTest {
40434089
)
40444090
}
40454091

4092+
@Test
4093+
fun `metric event has spanId from active span`() {
4094+
val (sut, mockClient) = getEnabledScopes { it.metrics.isEnabled = true }
4095+
4096+
val transaction =
4097+
sut.startTransaction(
4098+
"test transaction",
4099+
"test.op",
4100+
TransactionOptions().also { it.isBindToScope = true },
4101+
)
4102+
4103+
sut.metrics().count("metric name")
4104+
4105+
verify(mockClient)
4106+
.captureMetric(
4107+
check {
4108+
assertEquals("metric name", it.name)
4109+
assertEquals(transaction.spanContext.traceId, it.traceId)
4110+
assertEquals(transaction.spanContext.spanId, it.spanId)
4111+
},
4112+
anyOrNull(),
4113+
anyOrNull(),
4114+
)
4115+
4116+
transaction.finish()
4117+
}
4118+
4119+
@Test
4120+
fun `metric event has spanId from propagation context when no active span`() {
4121+
val (sut, mockClient) = getEnabledScopes { it.metrics.isEnabled = true }
4122+
4123+
var propagationContext: PropagationContext? = null
4124+
sut.configureScope { propagationContext = it.propagationContext }
4125+
4126+
sut.metrics().count("metric name")
4127+
4128+
verify(mockClient)
4129+
.captureMetric(
4130+
check {
4131+
assertEquals("metric name", it.name)
4132+
assertEquals(propagationContext!!.traceId, it.traceId)
4133+
assertEquals(propagationContext!!.spanId, it.spanId)
4134+
},
4135+
anyOrNull(),
4136+
anyOrNull(),
4137+
)
4138+
}
4139+
40464140
// endregion
40474141

40484142
@Test

‎sentry/src/test/java/io/sentry/protocol/SentryLogsSerializationTest.kt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import io.sentry.SentryLogEvent
1111
import io.sentry.SentryLogEventAttributeValue
1212
import io.sentry.SentryLogEvents
1313
import io.sentry.SentryLogLevel
14+
import io.sentry.SpanId
1415
import java.io.StringReader
1516
import java.io.StringWriter
1617
import kotlin.test.assertEquals
@@ -31,6 +32,7 @@ class SentryLogsSerializationTest {
3132
SentryLogLevel.INFO,
3233
)
3334
.also {
35+
it.spanId = SpanId("0a53026963414893")
3436
it.attributes =
3537
mutableMapOf(
3638
"sentry.sdk.name" to

‎sentry/src/test/resources/json/sentry_logs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
{
55
"timestamp": 1081621443.000000,
66
"trace_id": "5c1f73d39486827b9e60ceb1fc23277a",
7+
"span_id": "0a53026963414893",
78
"body": "42e6bd2a-c45e-414d-8066-ed5196fbc686",
89
"level": "info",
910
"severity_number": 10,

0 commit comments

Comments
 (0)