getsentry / getsentry/sentry-java

Generate low-cardinality SQL summaries for database spans

オープン
#5,981 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
Feature Java Platform: Java Spans
主要言語
Kotlin
スター
1.4k
フォーク
478
平均マージ
2日 23時間
マージ済み PR(30日)
67

説明

## 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.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Start by locating the JDBC and Android SQLite span-description entry points and how the effective dataCollection.databaseQueryData policy is applied. Trace the existing tests, then add coverage for supported operations, literals, placeholders, malformed SQL, and dialect-specific syntax. Done means both integrations use safe summaries when raw collection is disabled, never expose raw SQL on failure, and any adapted analyzer code is attributed in THIRD_PARTY_NOTICES.md.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
android, java, kotlin, sqlite
領域
backend, databases, mobile
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。