Generate low-cardinality SQL summaries for database spans

Abierto
#5,981 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
55/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
android, java, kotlin, sqlite
Área
backend, databases, mobile

Línea de trabajo

Comienza localizando los puntos de entrada de descripción de spans de JDBC y Android SQLite, y siguiendo cómo se aplica la política efectiva dataCollection.databaseQueryData. Revisa las pruebas existentes y, después, añade cobertura para operaciones compatibles, literales, marcadores de posición, SQL mal formado y sintaxis específica del dialecto. Se considera terminado cuando ambas integraciones usan resúmenes seguros con la recopilación de datos sin procesar deshabilitada, nunca exponen SQL sin procesar en caso de error y cualquier código de analyzer adaptado está atribuido en THIRD_PARTY_NOTICES.md.

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

Descripción

Feature Java Platform: Java Spans

Problem

When dataCollection.databaseQueryData disables raw SQL collection, database spans lose their SQL description entirely. Keeping the raw statement is not safe because inline literals and other query values can contain sensitive data and create high-cardinality span descriptions.

We should provide useful, low-cardinality descriptions without retaining query values, for example:

  • SELECT users
  • UPDATE orders
  • INSERT products

This is follow-up work from #5801 and supports #5666.

Proposed solution

Add a SQL summarizer that extracts only a safe operation and target from a statement. Use the summary for JDBC and Android SQLite span descriptions when raw database query data is disabled. Preserve the full statement only when the effective Data Collection policy allows it.

Consider adapting OpenTelemetry Java's Apache-2.0 SQL query analyzer instead of depending on its incubating API. If code is adapted, include the required source attribution and update THIRD_PARTY_NOTICES.md.

The summarizer must fail closed: malformed or unsupported SQL must never fall back to the raw statement.

Acceptance criteria

  • JDBC and Android SQLite spans use low-cardinality summaries when raw query collection is disabled.
  • Summaries do not contain inline literals, bound values, comments, or other query values.
  • Parsing covers common operations such as SELECT, INSERT, UPDATE, and DELETE.
  • Malformed and unsupported SQL produces a generic description or no description, never the raw statement.
  • Tests cover inline literals, placeholders, mixed literal-and-bound queries, malformed SQL, and representative dialect-specific syntax.
  • Any adapted third-party code includes complete license attribution.
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.