feat(database): Capture query data behind dataCollection

Abierto
#6,021 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
android, java, sqlite
Área
databases, mobile

Línea de trabajo

Comienza por la ruta JDBC P6Spy StatementInformation.getSql() y las integraciones de Android SupportSQLite y SQLiteDriver, siguiendo dónde está disponible databaseQueryData. Usa los casos enumerados de habilitado/deshabilitado, forma de los parámetros, tamaño, lote y argumentos de enlace de Android para definir la cobertura; terminado significa una recopilación acotada en tiempo de fuente sin cambiar los campos de consulta saneados, además de la documentación de las categorías compatibles.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Feature Java Platform: Java Spans

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.<key>.
  • 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.
Lenguaje dominante
Kotlin
Estrellas
1.4k
Forks
478
Merge medio
3 d 2 h
PR fusionados (30 d)
70

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de getsentry/sentry-java

Todos los issues de getsentry/sentry-java

Issues similares

Más issues de Kotlin

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.