Skip to content

Commit be3834c

Browse files
adinauerclaude
andcommitted
feat(database): Apply Data Collection query policy
Suppress SQL statement descriptions when database query data collection is disabled while retaining database system, name, timing, status, and other structural span metadata. Preserve existing statement collection when Data Collection is absent. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 9c7a845 commit be3834c

9 files changed

Lines changed: 103 additions & 4 deletions

File tree

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import io.sentry.IScopes
66
import io.sentry.ISpan
77
import io.sentry.Instrumenter
88
import io.sentry.ScopesAdapter
9+
import io.sentry.SentryDate
910
import io.sentry.SentryIntegrationPackageStorage
1011
import io.sentry.SentryStackTraceFactory
1112
import io.sentry.SpanDataConvention
@@ -46,12 +47,12 @@ internal class OpenHelperSpans(
4647
if (result is CrossProcessCursor) {
4748
return SentryCrossProcessCursor(result, this, sql) as T
4849
}
49-
span = scopes.span?.startChild("db.sql.query", sql, startTimestamp, Instrumenter.SENTRY)
50+
span = startSpan(sql, startTimestamp)
5051
span?.spanContext?.origin = TRACE_ORIGIN
5152
span?.status = SpanStatus.OK
5253
result
5354
} catch (e: Throwable) {
54-
span = scopes.span?.startChild("db.sql.query", sql, startTimestamp, Instrumenter.SENTRY)
55+
span = startSpan(sql, startTimestamp)
5556
span?.spanContext?.origin = TRACE_ORIGIN
5657
span?.status = SpanStatus.INTERNAL_ERROR
5758
span?.throwable = e
@@ -76,4 +77,12 @@ internal class OpenHelperSpans(
7677
}
7778
}
7879
}
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+
)
7988
}

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

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

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

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,28 @@ 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+
6991
@Test
7092
fun `performSql does not create a span if no span is running`() {
7193
val sut = fixture.getSut(isSpanActive = false)

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,28 @@ 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+
132154
@Test
133155
fun `record method sets finishDate equal to startDate + durationNanos`() {
134156
val sut = fixture.getSut()

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

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

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

5357
@Override

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,29 @@ 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+
93116
@Test
94117
fun `creates spans for calls resulting in error`() {
95118
val sut = fixture.getSut(existingRow = 1)

‎sentry/api/sentry.api‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,7 @@ public final class io/sentry/DataCollectionResolver {
424424
public fun getQueryParams ()Lio/sentry/KeyValueCollectionBehavior;
425425
public fun isDataCollectionConfigured ()Z
426426
public fun isDatabaseQueryData ()Z
427+
public fun isDatabaseQueryDataWithLegacyAlways ()Z
427428
public fun isGraphqlDocument ()Z
428429
public fun isGraphqlDocumentWithLegacyAlways ()Z
429430
public fun isGraphqlDocumentWithLegacyBodyGate ()Z

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ 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+
3438
public boolean isGraphqlDocument() {
3539
return explicitOrSendDefaultPii(options.getDataCollection().getGraphql().getDocument(), true);
3640
}

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,17 @@ 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+
8192
@Test
8293
fun `GraphQL document falls back to sendDefaultPii and override takes precedence`() {
8394
val options = SentryOptions().apply { isSendDefaultPii = true }

0 commit comments

Comments
 (0)