getsentry / getsentry/sentry-java

feat(database): Capture query data behind dataCollection

未关闭
#6,021 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Feature Java Platform: Java Spans
主要语言
Kotlin
星标
1.4k
派生
478
平均合并
2 天 23 小时
30 天内合并 PR
67

描述

## Problem

The Java SDK exposes `dataCollection.databaseQueryData`, but the current first-party database integrations do not collect any of the value-bearing data controlled by that option:

- JDBC records the original statement text through P6Spy's `StatementInformation.getSql()`, not bound parameter values.
- Android SQLite receives bind arguments but does not attach them to spans.
- Neither integration captures write payloads or returned result data.

As a result, `databaseQueryData` currently has no production consumer in these integrations.

Sanitized or parameterized `db.query.text`, `db.query.summary`, and structural database metadata are intentionally outside this option and should continue to be collected independently.

## Proposal

In the next major version, add source-time collection of supported database query data and guard it with `dataCollection.databaseQueryData`.

Start with the value-bearing data already available to first-party instrumentation:

- JDBC prepared/callable statement bind values, where P6Spy exposes them safely.
- Android SQLite bind arguments in the SupportSQLite and SQLiteDriver integrations.

Evaluate write-operation payloads and returned result data separately; only add them where useful, bounded, and supported by established Sentry span conventions.

## Requirements

- Apply the policy when first-party instrumentation writes the data, not later during serialization or export.
- Do not put bound values into span descriptions, span names, `db.query.text`, or `db.query.summary`.
- Use standardized structured span attributes for parameters where available, such as `db.query.parameter.`.
- `databaseQueryData=false` must prevent value-bearing query data from being attached.
- Query text must remain sanitized/parameterized independently of this option.
- Add size/count limits and fail-closed handling for unsupported or malformed values.
- Preserve explicitly supplied customer span data.
- Add tests for enabled/disabled behavior, positional and named parameters, null/binary/large values, batch operations, and Android bind arguments.
- Document which integrations and database data categories are supported.

## Related

- Data Collection specification: `databaseQueryData` controls bound query parameters, write-operation payloads, and returned result data.
- SQL sanitization and `db.query.summary` generation are separate concerns and should not be made conditional on this option.

贡献指南

打开贡献指南

调研方向

Start at the JDBC P6Spy StatementInformation.getSql() path and the Android SupportSQLite and SQLiteDriver integrations, tracing where databaseQueryData is available. Use the listed enabled/disabled, parameter-shape, size, batch, and Android bind-argument cases to define coverage; done means bounded source-time collection without changing sanitized query fields, plus documentation of supported categories.

由索引模型根据 Issue 内容生成。

评估

技术栈
android, java, sqlite
领域
databases, mobile
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
活跃
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。