Skip to content

Commit f1f23e1

Browse files
adinauerclaude
andcommitted
fix(database): Preserve query descriptions
Keep sanitized or parameterized query text independent of databaseQueryData. The option only controls bound parameters, write payloads, and result data, which the current JDBC and SQLite integrations do not collect. Remove the unused legacy resolver path and its policy-specific tests. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 79f9353 commit f1f23e1

9 files changed

Lines changed: 4 additions & 103 deletions

File tree

‎sentry-android-sqlite/src/main/java/io/sentry/android/sqlite/OpenHelperSpans.kt‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import io.sentry.IScopes
66
import io.sentry.ISpan
77
import io.sentry.Instrumenter
88
import io.sentry.ScopesAdapter
9-
import io.sentry.SentryDate
109
import io.sentry.SentryIntegrationPackageStorage
1110
import io.sentry.SentryStackTraceFactory
1211
import io.sentry.SpanDataConvention
@@ -47,12 +46,12 @@ internal class OpenHelperSpans(
4746
if (result is CrossProcessCursor) {
4847
return SentryCrossProcessCursor(result, this, sql) as T
4948
}
50-
span = startSpan(sql, startTimestamp)
49+
span = scopes.span?.startChild("db.sql.query", sql, startTimestamp, Instrumenter.SENTRY)
5150
span?.spanContext?.origin = TRACE_ORIGIN
5251
span?.status = SpanStatus.OK
5352
result
5453
} catch (e: Throwable) {
55-
span = startSpan(sql, startTimestamp)
54+
span = scopes.span?.startChild("db.sql.query", sql, startTimestamp, Instrumenter.SENTRY)
5655
span?.spanContext?.origin = TRACE_ORIGIN
5756
span?.status = SpanStatus.INTERNAL_ERROR
5857
span?.throwable = e
@@ -77,12 +76,4 @@ internal class OpenHelperSpans(
7776
}
7877
}
7978
}
80-
81-
private fun startSpan(sql: String, startTimestamp: SentryDate): ISpan? =
82-
scopes.span?.startChild(
83-
"db.sql.query",
84-
sql.takeIf { scopes.options.dataCollectionResolver.isDatabaseQueryDataWithLegacyAlways },
85-
startTimestamp,
86-
Instrumenter.SENTRY,
87-
)
8879
}

‎sentry-android-sqlite/src/main/java/io/sentry/sqlite/DriverSpans.kt‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,7 @@ internal class DriverSpans(private val scopes: IScopes, private val dbMetadata:
5050
val startTimestamp = SentryLongDate(startTimestampNanos)
5151
val endTimestamp = SentryLongDate(startTimestampNanos + durationNanos)
5252

53-
val description = sql.takeIf {
54-
scopes.options.dataCollectionResolver.isDatabaseQueryDataWithLegacyAlways
55-
}
56-
parent.startChild("db.sql.query", description, startTimestamp, Instrumenter.SENTRY).apply {
53+
parent.startChild("db.sql.query", sql, startTimestamp, Instrumenter.SENTRY).apply {
5754
spanContext.origin = SQLITE_TRACE_ORIGIN
5855
throwable?.let { this.throwable = it }
5956

‎sentry-android-sqlite/src/test/java/io/sentry/android/sqlite/OpenHelperSpansTest.kt‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -66,28 +66,6 @@ class OpenHelperSpansTest {
6666
assertTrue(span.isFinished)
6767
}
6868

69-
@Test
70-
fun `performSql omits description when database query data is disabled`() {
71-
val sut = fixture.getSut()
72-
fixture.options.dataCollection.setDatabaseQueryData(false)
73-
74-
sut.performSql("SELECT secret FROM users") {}
75-
76-
val span = fixture.sentryTracer.children.first()
77-
assertNull(span.description)
78-
assertEquals("in-memory", span.data[SpanDataConvention.DB_SYSTEM_KEY])
79-
}
80-
81-
@Test
82-
fun `performSql keeps description in legacy mode`() {
83-
val sut = fixture.getSut()
84-
fixture.options.isSendDefaultPii = false
85-
86-
sut.performSql("SELECT secret FROM users") {}
87-
88-
assertEquals("SELECT secret FROM users", fixture.sentryTracer.children.first().description)
89-
}
90-
9169
@Test
9270
fun `performSql does not create a span if no span is running`() {
9371
val sut = fixture.getSut(isSpanActive = false)

‎sentry-android-sqlite/src/test/java/io/sentry/sqlite/DriverSpansTest.kt‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -129,28 +129,6 @@ class DriverSpansTest {
129129
assertTrue(span.isFinished)
130130
}
131131

132-
@Test
133-
fun `record method omits description when database query data is disabled`() {
134-
val sut = fixture.getSut()
135-
fixture.options.dataCollection.setDatabaseQueryData(false)
136-
137-
sut.record("SELECT secret FROM users", sut.startTimestamp(), 1_000_000, SpanStatus.OK)
138-
139-
val span = fixture.sentryTracer.children.first()
140-
assertNull(span.description)
141-
assertEquals("in-memory", span.data[SpanDataConvention.DB_SYSTEM_KEY])
142-
}
143-
144-
@Test
145-
fun `record method keeps description in legacy mode`() {
146-
val sut = fixture.getSut()
147-
fixture.options.isSendDefaultPii = false
148-
149-
sut.record("SELECT secret FROM users", sut.startTimestamp(), 1_000_000, SpanStatus.OK)
150-
151-
assertEquals("SELECT secret FROM users", fixture.sentryTracer.children.first().description)
152-
}
153-
154132
@Test
155133
fun `record method sets finishDate equal to startDate + durationNanos`() {
156134
val sut = fixture.getSut()

‎sentry-jdbc/src/main/java/io/sentry/jdbc/SentryJdbcEventListener.java‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,7 @@ public SentryJdbcEventListener() {
4747

4848
@Override
4949
public void onBeforeAnyExecute(final @NotNull StatementInformation statementInformation) {
50-
final @Nullable String description =
51-
scopes.getOptions().getDataCollectionResolver().isDatabaseQueryDataWithLegacyAlways()
52-
? statementInformation.getSql()
53-
: null;
54-
startSpan(CURRENT_QUERY_SPAN, "db.query", description);
50+
startSpan(CURRENT_QUERY_SPAN, "db.query", statementInformation.getSql());
5551
}
5652

5753
@Override

‎sentry-jdbc/src/test/kotlin/io/sentry/jdbc/SentryJdbcEventListenerTest.kt‎

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -90,29 +90,6 @@ class SentryJdbcEventListenerTest {
9090
assertEquals("INSERT INTO foo VALUES (2)", fixture.tx.children[1].description)
9191
}
9292

93-
@Test
94-
fun `omits query description when database query data is disabled`() {
95-
val sut = fixture.getSut()
96-
fixture.options.dataCollection.setDatabaseQueryData(false)
97-
98-
sut.connection.use { it.prepareStatement("INSERT INTO foo VALUES (1)").executeUpdate() }
99-
100-
assertEquals(1, fixture.tx.children.size)
101-
assertEquals(null, fixture.tx.children.first().description)
102-
assertEquals("hsqldb", fixture.tx.children.first().data[DB_SYSTEM_KEY])
103-
assertEquals("testdb", fixture.tx.children.first().data[DB_NAME_KEY])
104-
}
105-
106-
@Test
107-
fun `legacy mode keeps query description when sendDefaultPii is false`() {
108-
val sut = fixture.getSut()
109-
fixture.options.isSendDefaultPii = false
110-
111-
sut.connection.use { it.prepareStatement("INSERT INTO foo VALUES (1)").executeUpdate() }
112-
113-
assertEquals("INSERT INTO foo VALUES (1)", fixture.tx.children.first().description)
114-
}
115-
11693
@Test
11794
fun `creates spans for calls resulting in error`() {
11895
val sut = fixture.getSut(existingRow = 1)

‎sentry/api/sentry.api‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,6 @@ public final class io/sentry/DataCollectionResolver {
422422
public fun getUrlQueryParams ()Lio/sentry/KeyValueCollectionBehavior;
423423
public fun isDataCollectionConfigured ()Z
424424
public fun isDatabaseQueryData ()Z
425-
public fun isDatabaseQueryDataWithLegacyAlways ()Z
426425
public fun isGraphqlDocument ()Z
427426
public fun isGraphqlDocumentWithLegacyAlways ()Z
428427
public fun isGraphqlDocumentWithLegacyBodyGate ()Z

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,6 @@ public boolean isDatabaseQueryData() {
3131
return explicitOrSendDefaultPii(options.getDataCollection().getDatabaseQueryData(), true);
3232
}
3333

34-
public boolean isDatabaseQueryDataWithLegacyAlways() {
35-
return explicitOrDefault(options.getDataCollection().getDatabaseQueryData(), true, true);
36-
}
37-
3834
public boolean isGraphqlDocument() {
3935
return explicitOrSendDefaultPii(options.getDataCollection().getGraphql().getDocument(), true);
4036
}

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

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -78,17 +78,6 @@ class DataCollectionResolverTest {
7878
assertThat(options.dataCollectionResolver.isDatabaseQueryData).isFalse()
7979
}
8080

81-
@Test
82-
fun `database query data legacy always variant preserves collection when namespace is absent`() {
83-
val options = SentryOptions().apply { isSendDefaultPii = false }
84-
85-
assertThat(options.dataCollectionResolver.isDatabaseQueryDataWithLegacyAlways).isTrue()
86-
87-
options.dataCollection.setDatabaseQueryData(false)
88-
89-
assertThat(options.dataCollectionResolver.isDatabaseQueryDataWithLegacyAlways).isFalse()
90-
}
91-
9281
@Test
9382
fun `GraphQL document falls back to sendDefaultPii and override takes precedence`() {
9483
val options = SentryOptions().apply { isSendDefaultPii = true }

0 commit comments

Comments
 (0)