Skip to content

Commit a32bc6e

Browse files
committed
feat(tracing): [Ignore HTTP Status 1] Add sentry.kind to server instrumentation
Classify incoming Spring and OpenTelemetry server spans with sentry.kind and record numeric HTTP response statuses for later filtering. Refs #4735 Refs #4736 Refs #6555
1 parent dd197b9 commit a32bc6e

22 files changed

Lines changed: 532 additions & 33 deletions

File tree

‎sentry-opentelemetry/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanExporter.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import static io.sentry.opentelemetry.OtelSpanUtils.maybeTransferOtelAttribute;
77

88
import io.opentelemetry.api.common.Attributes;
9+
import io.opentelemetry.api.trace.SpanKind;
910
import io.opentelemetry.api.trace.StatusCode;
1011
import io.opentelemetry.sdk.common.CompletableResultCode;
1112
import io.opentelemetry.sdk.trace.data.SpanData;
@@ -28,6 +29,7 @@
2829
import io.sentry.SentryLevel;
2930
import io.sentry.SentryLongDate;
3031
import io.sentry.SpanContext;
32+
import io.sentry.SpanDataConvention;
3133
import io.sentry.SpanId;
3234
import io.sentry.SpanOptions;
3335
import io.sentry.SpanStatus;
@@ -240,6 +242,7 @@ private void createAndFinishSpanForOtelSpan(
240242
setOtelInstrumentationInfo(spanData, sentryChildSpan);
241243
setOtelSpanKind(spanData, sentryChildSpan);
242244
transferSpanDetails(sentrySpanMaybe, sentryChildSpan);
245+
setSentrySpanKind(spanData, sentryChildSpan);
243246

244247
for (SpanNode childNode : spanNode.getChildren()) {
245248
createAndFinishSpanForOtelSpan(childNode, sentryChildSpan, remaining);
@@ -355,6 +358,10 @@ private void transferSpanDetails(
355358
setOtelInstrumentationInfo(span, sentryTransaction);
356359
setOtelSpanKind(span, sentryTransaction);
357360
transferSpanDetails(sentrySpanMaybe, sentryTransaction);
361+
setSentrySpanKind(span, sentryTransaction);
362+
if (SpanKind.SERVER.equals(span.getKind())) {
363+
maybeTransferOtelAttribute(span, sentryTransaction, HttpAttributes.HTTP_RESPONSE_STATUS_CODE);
364+
}
358365

359366
maybeTransferOtelAttribute(span, sentryTransaction, ThreadIncubatingAttributes.THREAD_ID);
360367
maybeTransferOtelAttribute(span, sentryTransaction, ThreadIncubatingAttributes.THREAD_NAME);
@@ -555,6 +562,13 @@ private void setOtelSpanKind(final @NotNull SpanData otelSpan, final @NotNull IS
555562
sentrySpan.setData("otel.kind", otelSpan.getKind().name());
556563
}
557564

565+
private void setSentrySpanKind(
566+
final @NotNull SpanData otelSpan, final @NotNull ISpan sentrySpan) {
567+
if (SpanKind.SERVER.equals(otelSpan.getKind())) {
568+
sentrySpan.setData(SpanDataConvention.SENTRY_KIND_KEY, "server");
569+
}
570+
}
571+
558572
@Override
559573
public CompletableResultCode flush() {
560574
scopes.flush(10000);
Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
package io.sentry.opentelemetry
2+
3+
import com.google.common.truth.Truth.assertThat
4+
import io.opentelemetry.api.trace.SpanKind
5+
import io.opentelemetry.context.Context
6+
import io.opentelemetry.sdk.OpenTelemetrySdk
7+
import io.opentelemetry.sdk.trace.SdkTracerProvider
8+
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor
9+
import io.opentelemetry.semconv.HttpAttributes
10+
import io.sentry.ISentryClient
11+
import io.sentry.NoOpScopes
12+
import io.sentry.Sentry
13+
import io.sentry.SentryOptions
14+
import io.sentry.SpanDataConvention
15+
import io.sentry.TransactionContext
16+
import io.sentry.TransactionOptions
17+
import io.sentry.protocol.SentryId
18+
import io.sentry.protocol.SentryTransaction
19+
import io.sentry.test.createSentryClientMock
20+
import io.sentry.test.createTestScopes
21+
import java.util.concurrent.TimeUnit
22+
import kotlin.test.AfterTest
23+
import kotlin.test.Test
24+
import org.mockito.kotlin.anyOrNull
25+
import org.mockito.kotlin.argumentCaptor
26+
import org.mockito.kotlin.atLeastOnce
27+
import org.mockito.kotlin.verify
28+
import org.mockito.kotlin.whenever
29+
30+
class SentrySpanExporterTest {
31+
private val options =
32+
SentryOptions().apply {
33+
dsn = "https://key@sentry.io/proj"
34+
tracesSampleRate = 1.0
35+
}
36+
private val client: ISentryClient = createSentryClientMock()
37+
private val scopes = createTestScopes(options).also { it.bindClient(client) }
38+
private val exporter = SentrySpanExporter(scopes)
39+
40+
init {
41+
whenever(
42+
client.captureTransaction(anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull())
43+
)
44+
.thenReturn(SentryId())
45+
Sentry.setCurrentScopes(scopes)
46+
}
47+
48+
@AfterTest
49+
fun tearDown() {
50+
Sentry.setCurrentScopes(NoOpScopes.getInstance())
51+
}
52+
53+
@Test
54+
fun `server roots and children get server kind and root response status`() {
55+
withOpenTelemetry { openTelemetry ->
56+
val tracer = openTelemetry.getTracer("test")
57+
val root =
58+
tracer
59+
.spanBuilder("server-root")
60+
.setSpanKind(SpanKind.SERVER)
61+
.setAttribute(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 404L)
62+
.startSpan()
63+
val child =
64+
tracer
65+
.spanBuilder("server-child")
66+
.setParent(root.storeInContext(Context.root()))
67+
.setSpanKind(SpanKind.SERVER)
68+
.startSpan()
69+
70+
child.end()
71+
root.end()
72+
}
73+
74+
val transaction = capturedTransactions().single()
75+
assertThat(transaction.contexts.trace!!.data[SpanDataConvention.SENTRY_KIND_KEY])
76+
.isEqualTo("server")
77+
assertThat(transaction.contexts.trace!!.data[SpanDataConvention.HTTP_STATUS_CODE_KEY])
78+
.isEqualTo(404L)
79+
assertThat(transaction.contexts.trace!!.data["otel.kind"]).isEqualTo("SERVER")
80+
assertThat(transaction.spans).hasSize(1)
81+
assertThat(transaction.spans.single().data!![SpanDataConvention.SENTRY_KIND_KEY])
82+
.isEqualTo("server")
83+
assertThat(transaction.spans.single().data!!["otel.kind"]).isEqualTo("SERVER")
84+
}
85+
86+
@Test
87+
fun `client and internal roots do not get server data`() {
88+
withOpenTelemetry { openTelemetry ->
89+
val tracer = openTelemetry.getTracer("test")
90+
tracer
91+
.spanBuilder("client-root")
92+
.setSpanKind(SpanKind.CLIENT)
93+
.setAttribute(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 404L)
94+
.startSpan()
95+
.end()
96+
tracer
97+
.spanBuilder("internal-root")
98+
.setSpanKind(SpanKind.INTERNAL)
99+
.setAttribute(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 500L)
100+
.startSpan()
101+
.end()
102+
}
103+
104+
val transactions = capturedTransactions().associateBy { it.transaction }
105+
assertThat(transactions.keys).containsExactly("client-root", "internal-root")
106+
assertThat(transactions["client-root"]!!.contexts.trace!!.data)
107+
.doesNotContainKey(SpanDataConvention.SENTRY_KIND_KEY)
108+
assertThat(transactions["client-root"]!!.contexts.trace!!.data)
109+
.doesNotContainKey(SpanDataConvention.HTTP_STATUS_CODE_KEY)
110+
assertThat(transactions["internal-root"]!!.contexts.trace!!.data)
111+
.doesNotContainKey(SpanDataConvention.SENTRY_KIND_KEY)
112+
assertThat(transactions["internal-root"]!!.contexts.trace!!.data)
113+
.doesNotContainKey(SpanDataConvention.HTTP_STATUS_CODE_KEY)
114+
}
115+
116+
@Test
117+
fun `rpc server root does not fabricate HTTP response status`() {
118+
withOpenTelemetry { openTelemetry ->
119+
openTelemetry
120+
.getTracer("test")
121+
.spanBuilder("rpc-server")
122+
.setSpanKind(SpanKind.SERVER)
123+
.startSpan()
124+
.end()
125+
}
126+
127+
val transaction = capturedTransactions().single()
128+
assertThat(transaction.contexts.trace!!.data[SpanDataConvention.SENTRY_KIND_KEY])
129+
.isEqualTo("server")
130+
assertThat(transaction.contexts.trace!!.data)
131+
.doesNotContainKey(SpanDataConvention.HTTP_STATUS_CODE_KEY)
132+
}
133+
134+
@Test
135+
fun `Sentry server marker survives default OTel internal kind`() {
136+
withOpenTelemetry(includeSentrySpanProcessor = true) { openTelemetry ->
137+
options.spanFactory = OtelSpanFactory(openTelemetry)
138+
val transaction =
139+
scopes.startTransaction(
140+
TransactionContext("native-server", "http.server"),
141+
TransactionOptions(),
142+
)
143+
transaction.setData(SpanDataConvention.SENTRY_KIND_KEY, "server")
144+
transaction.setData(SpanDataConvention.HTTP_STATUS_CODE_KEY, 404)
145+
transaction.finish()
146+
}
147+
148+
val transaction = capturedTransactions().single()
149+
assertThat(transaction.contexts.trace!!.data[SpanDataConvention.SENTRY_KIND_KEY])
150+
.isEqualTo("server")
151+
assertThat(transaction.contexts.trace!!.data[SpanDataConvention.HTTP_STATUS_CODE_KEY])
152+
.isEqualTo(404)
153+
assertThat(transaction.contexts.trace!!.data["otel.kind"]).isEqualTo("INTERNAL")
154+
}
155+
156+
private fun withOpenTelemetry(
157+
includeSentrySpanProcessor: Boolean = false,
158+
callback: (OpenTelemetrySdk) -> Unit,
159+
) {
160+
val providerBuilder = SdkTracerProvider.builder()
161+
if (includeSentrySpanProcessor) {
162+
providerBuilder.addSpanProcessor(OtelSentrySpanProcessor(scopes))
163+
}
164+
val provider = providerBuilder.addSpanProcessor(SimpleSpanProcessor.create(exporter)).build()
165+
val openTelemetry = OpenTelemetrySdk.builder().setTracerProvider(provider).build()
166+
try {
167+
callback(openTelemetry)
168+
provider.forceFlush().join(10, TimeUnit.SECONDS)
169+
} finally {
170+
provider.close()
171+
}
172+
}
173+
174+
private fun capturedTransactions(): List<SentryTransaction> {
175+
val transaction = argumentCaptor<SentryTransaction>()
176+
verify(client, atLeastOnce())
177+
.captureTransaction(
178+
transaction.capture(),
179+
anyOrNull(),
180+
anyOrNull(),
181+
anyOrNull(),
182+
anyOrNull(),
183+
)
184+
return transaction.allValues
185+
}
186+
}

‎sentry-spring-7/src/main/java/io/sentry/spring7/tracing/SentryTracingFilter.java‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import io.sentry.ITransaction;
1010
import io.sentry.ScopesAdapter;
1111
import io.sentry.SentryTraceHeader;
12+
import io.sentry.SpanDataConvention;
1213
import io.sentry.SpanStatus;
1314
import io.sentry.TransactionContext;
1415
import io.sentry.TransactionOptions;
@@ -164,6 +165,7 @@ private void doFilterWithTransaction(
164165
if (transactionName != null) {
165166
transaction.setName(transactionName, transactionNameSource);
166167
transaction.setOperation(TRANSACTION_OP);
168+
transaction.setData(SpanDataConvention.HTTP_STATUS_CODE_KEY, httpResponse.getStatus());
167169
// if exception has been thrown, transaction status is already set to INTERNAL_ERROR, and
168170
// httpResponse.getStatus() returns 200.
169171
if (transaction.getStatus() == null) {
@@ -240,15 +242,20 @@ private ITransaction startTransaction(
240242
transactionOptions.setBindToScope(true);
241243
transactionOptions.setOrigin(TRACE_ORIGIN);
242244

245+
final @NotNull ITransaction transaction;
243246
if (transactionContext != null) {
244247
transactionContext.setName(name);
245248
transactionContext.setTransactionNameSource(TransactionNameSource.URL);
246249
transactionContext.setOperation("http.server");
247250

248-
return scopes.startTransaction(transactionContext, transactionOptions);
251+
transaction = scopes.startTransaction(transactionContext, transactionOptions);
252+
} else {
253+
transaction =
254+
scopes.startTransaction(
255+
new TransactionContext(name, TransactionNameSource.URL, "http.server"),
256+
transactionOptions);
249257
}
250-
251-
return scopes.startTransaction(
252-
new TransactionContext(name, TransactionNameSource.URL, "http.server"), transactionOptions);
258+
transaction.setData(SpanDataConvention.SENTRY_KIND_KEY, "server");
259+
return transaction;
253260
}
254261
}

‎sentry-spring-7/src/main/java/io/sentry/spring7/webflux/AbstractSentryWebFilter.java‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
import io.sentry.NoOpScopes;
1414
import io.sentry.Sentry;
1515
import io.sentry.SentryTraceHeader;
16+
import io.sentry.SpanDataConvention;
1617
import io.sentry.SpanStatus;
1718
import io.sentry.TransactionContext;
1819
import io.sentry.TransactionOptions;
@@ -126,6 +127,7 @@ private void finishTransaction(ServerWebExchange exchange, ITransaction transact
126127
if (response != null) {
127128
final @Nullable HttpStatusCode statusCode = response.getStatusCode();
128129
if (statusCode != null) {
130+
transaction.setData(SpanDataConvention.HTTP_STATUS_CODE_KEY, statusCode.value());
129131
transaction
130132
.getContexts()
131133
.withResponse(
@@ -154,16 +156,20 @@ private void finishTransaction(ServerWebExchange exchange, ITransaction transact
154156
transactionOptions.setBindToScope(true);
155157
transactionOptions.setOrigin(origin);
156158

159+
final @NotNull ITransaction transaction;
157160
if (transactionContext != null) {
158161
transactionContext.setName(name);
159162
transactionContext.setTransactionNameSource(TransactionNameSource.URL);
160163
transactionContext.setOperation(TRANSACTION_OP);
161164

162-
return scopes.startTransaction(transactionContext, transactionOptions);
165+
transaction = scopes.startTransaction(transactionContext, transactionOptions);
166+
} else {
167+
transaction =
168+
scopes.startTransaction(
169+
new TransactionContext(name, TransactionNameSource.URL, TRANSACTION_OP),
170+
transactionOptions);
163171
}
164-
165-
return scopes.startTransaction(
166-
new TransactionContext(name, TransactionNameSource.URL, TRANSACTION_OP),
167-
transactionOptions);
172+
transaction.setData(SpanDataConvention.SENTRY_KIND_KEY, "server");
173+
return transaction;
168174
}
169175
}

‎sentry-spring-7/src/test/kotlin/io/sentry/spring7/tracing/SentryTracingFilterTest.kt‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import io.sentry.IScopes
55
import io.sentry.PropagationContext
66
import io.sentry.SentryOptions
77
import io.sentry.SentryTracer
8+
import io.sentry.SpanDataConvention
89
import io.sentry.SpanId
910
import io.sentry.SpanStatus
1011
import io.sentry.TraceContext
@@ -134,6 +135,10 @@ class SentryTracingFilterTest {
134135
assertThat(it.transaction).isEqualTo("POST /product/{id}")
135136
assertThat(it.contexts.trace!!.status).isEqualTo(SpanStatus.OK)
136137
assertThat(it.contexts.trace!!.operation).isEqualTo("http.server")
138+
assertThat(it.contexts.trace!!.data[SpanDataConvention.SENTRY_KIND_KEY])
139+
.isEqualTo("server")
140+
assertThat(it.contexts.trace!!.data[SpanDataConvention.HTTP_STATUS_CODE_KEY])
141+
.isEqualTo(200)
137142
},
138143
anyOrNull<TraceContext>(),
139144
anyOrNull(),
@@ -160,6 +165,26 @@ class SentryTracingFilterTest {
160165
)
161166
}
162167

168+
@Test
169+
fun `records not found response status`() {
170+
val filter = fixture.getSut(status = 404)
171+
172+
filter.doFilter(fixture.request, fixture.response, fixture.chain)
173+
174+
verify(fixture.scopes)
175+
.captureTransaction(
176+
check {
177+
assertThat(it.contexts.trace!!.data[SpanDataConvention.SENTRY_KIND_KEY])
178+
.isEqualTo("server")
179+
assertThat(it.contexts.trace!!.data[SpanDataConvention.HTTP_STATUS_CODE_KEY])
180+
.isEqualTo(404)
181+
},
182+
anyOrNull<TraceContext>(),
183+
anyOrNull(),
184+
anyOrNull(),
185+
)
186+
}
187+
163188
@Test
164189
fun `sets correct span status based on the response status`() {
165190
val filter = fixture.getSut(status = 500)
@@ -214,7 +239,13 @@ class SentryTracingFilterTest {
214239

215240
verify(fixture.scopes)
216241
.captureTransaction(
217-
check { assertThat(it.contexts.trace!!.parentSpanId).isEqualTo(parentSpanId) },
242+
check {
243+
assertThat(it.contexts.trace!!.parentSpanId).isEqualTo(parentSpanId)
244+
assertThat(it.contexts.trace!!.data[SpanDataConvention.SENTRY_KIND_KEY])
245+
.isEqualTo("server")
246+
assertThat(it.contexts.trace!!.data[SpanDataConvention.HTTP_STATUS_CODE_KEY])
247+
.isEqualTo(200)
248+
},
218249
anyOrNull<TraceContext>(),
219250
anyOrNull(),
220251
anyOrNull(),
@@ -429,6 +460,10 @@ class SentryTracingFilterTest {
429460
assertThat(it.transaction).isEqualTo("POST /product/{id}")
430461
assertThat(it.contexts.trace!!.status).isEqualTo(SpanStatus.OK)
431462
assertThat(it.contexts.trace!!.operation).isEqualTo("http.server")
463+
assertThat(it.contexts.trace!!.data[SpanDataConvention.SENTRY_KIND_KEY])
464+
.isEqualTo("server")
465+
assertThat(it.contexts.trace!!.data[SpanDataConvention.HTTP_STATUS_CODE_KEY])
466+
.isEqualTo(200)
432467
},
433468
anyOrNull<TraceContext>(),
434469
anyOrNull(),

0 commit comments

Comments
 (0)