Skip to content

fix(ktor): [Data Collection 20] Exclude query parameters from span descriptions #5983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
adinauer wants to merge 2 commits into
base: fix/data-collection-preserve-installation-id
Choose a base branch
from
+20 −9
Draft

fix(ktor): [Data Collection 20] Exclude query parameters from span descriptions #5983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc72c0c
fix(ktor): Exclude query parameters from span descriptions
adinauer Aug 24, 2026
cdf4101
merge: Update Data Collection stack
adinauer Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions sentry-ktor-client/src/main/java/io/sentry/ktorClient/SentryKtorClientPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import io.sentry.util.Platform
import io.sentry.util.PropagationTargetsUtils
import io.sentry.util.SpanUtils
import io.sentry.util.TracingUtils
import io.sentry.util.UrlUtils
import kotlinx.coroutines.withContext

/** Configuration for the Sentry Ktor client plugin. */
Expand Down Expand Up @@ -98,20 +99,20 @@ public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =
val requestSpanKey = AttributeKey<ISpan>("SentryRequestSpan")

onRequest { request, _ ->
val effectiveScopes = if (forceScopes) scopes else Sentry.getCurrentScopes()
request.attributes.put(
requestStartTimestampKey,
(if (forceScopes) scopes else Sentry.getCurrentScopes()).options.dateProvider.now(),
effectiveScopes.options.dateProvider.now(),
)

val parentSpan: ISpan? =
if (forceScopes) scopes.getSpan()
else {
val currentScopes = Sentry.getCurrentScopes()
if (Platform.isAndroid()) currentScopes.transaction else currentScopes.span
}
else if (Platform.isAndroid()) effectiveScopes.transaction else effectiveScopes.span

val spanOp = "http.client"
val spanDescription = "${request.method.value.toString()} ${request.url.buildString()}"
val rawUrl = request.url.buildString()
val urlDetails = UrlUtils.parse(rawUrl, effectiveScopes.options.dataCollectionResolver)
val spanDescription = "${request.method.value.toString()} ${urlDetails.urlOrFallback}"
val span: ISpan? = parentSpan?.startChild(spanOp, spanDescription)
if (span != null) {
span.spanContext.origin = TRACE_ORIGIN
Expand All @@ -120,13 +121,13 @@ public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =

if (
!SpanUtils.isIgnored(
(if (forceScopes) scopes else Sentry.getCurrentScopes()).options.getIgnoredSpanOrigins(),
effectiveScopes.options.getIgnoredSpanOrigins(),
TRACE_ORIGIN,
)
) {
TracingUtils.traceIfAllowed(
if (forceScopes) scopes else Sentry.getCurrentScopes(),
request.url.buildString(),
effectiveScopes,
rawUrl,
request.headers.getAll(BaggageHeader.BAGGAGE_HEADER),
span,
)
Expand Down
10 changes: 10 additions & 0 deletions sentry-ktor-client/src/test/java/io/sentry/ktorClient/SentryKtorClientPluginTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,16 @@ class SentryKtorClientPluginTest {
assertTrue(httpClientSpan.isFinished)
}

@Test
fun `span description excludes query parameters and fragment`(): Unit = runBlocking {
val sut = fixture.getSut()
sut.get(fixture.server.url("/hello?token=secret&page=1#results").toString())

val httpClientSpan = fixture.sentryTracer.children.first()
assertEquals("GET ${fixture.server.url("/hello")}", httpClientSpan.description)
assertNull(httpClientSpan.data[SpanDataConvention.HTTP_QUERY_KEY])
}

@Test
fun `finishes span setting throwable and status when request throws`(): Unit = runBlocking {
val sut = fixture.getSut(socketPolicy = SocketPolicy.DISCONNECT_DURING_REQUEST_BODY)
Expand Down
Loading