getsentry / getsentry/sentry-java
feat(database): Capture query data behind dataCollection
- Ngôn ngữ chính
- Kotlin
- Star
- 1.4k
- Fork
- 478
- Merge trung bình
- 2 ngày 23 giờ
- Pull request đã merge (30 ngày)
- 67
Mô tả
## 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.
Hướng dẫn đóng góp
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- android, java, sqlite
- Lĩnh vực
- databases, mobile
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100