-
-
Notifications
You must be signed in to change notification settings - Fork 471
chore(android-sqlite): Add SQLite samples to sentry-samples-android #5504
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+1,542
−13
Merged
Changes from 7 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
4c67ea9
feat(android-sqlite): Add SentrySQLiteDriver (JAVA-275)
0xadam-brown 02edd2a
Use lambda for nanoTimeProvider default
0xadam-brown 37591e7
Address Roman's comments
0xadam-brown e689907
Bump androidx.sqlite to 2.6.2 to pick up new hasConnectionPool method
0xadam-brown d4ab6b7
Merge branch 'main' into feat/support-sqlite-driver
0xadam-brown f2207a5
Guard SQLiteDriver.hasConnectionPool for sqlite 2.5.x delegates
0xadam-brown d4ffab7
chore(android-sqlite): Add SQLite samples to sentry-samples-android
0xadam-brown 0b1a52e
Prevent db reset while statement is in flight; warm up Room3 db upon …
0xadam-brown 8b3c175
Serialize demo SQL and block concurrent taps
0xadam-brown a16a9da
Guard UiLoadActivity against missing demo extra
0xadam-brown 407616f
Bump KSP to 2.3.9
0xadam-brown 008be6f
Merge branch 'main' into feat/add-sqlite-to-android-sample-app
0xadam-brown cc15a32
Merge branch 'main' into feat/add-sqlite-to-android-sample-app
0xadam-brown bd18243
Merge branch 'main' into feat/add-sqlite-to-android-sample-app
0xadam-brown File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # sentry-android-sqlite | ||
|
|
||
| This module provides automatic SQLite query instrumentation for Android. | ||
|
|
||
| Two instrumentation paths are supported, matching the two SQLite APIs offered by AndroidX: | ||
|
|
||
| - **`androidx.sqlite.SQLiteDriver`** — used by Room 2.7+ via `Room.databaseBuilder(...).setDriver(...)` and by SQLDelight via its AndroidX SQLite driver. | ||
| - **`androidx.sqlite.db.SupportSQLiteOpenHelper`** — used by legacy Room via `Room.databaseBuilder(...).openHelperFactory(...)`, or applied automatically by the Sentry Android Gradle plugin. | ||
|
|
||
| Please consult the [Sentry Docs](https://docs.sentry.io/platforms/android/integrations/room-and-sqlite/) for usage and migration guidance, as well as how to avoid duplicate spans when using Room's `SupportSQLiteDriver` adapter. | ||
|
|
||
| ## Package layout | ||
|
|
||
| This module is organized as two separate packages: | ||
|
|
||
| - **`io.sentry.android.sqlite`**: Android-specific code. Classes here depend on `android.database.*` (e.g., `CrossProcessCursor`, `SQLException`) and/or on `androidx.sqlite.db.*`, the Android-only compatibility layer over the platform's SQLite. The `SentrySupportSQLiteOpenHelper` path and its `SQLiteSpanManager` wrapper live here. | ||
| - **`io.sentry.sqlite`**: Code whose contract depends only on the multiplatform `androidx.sqlite.*` interfaces (e.g., `SQLiteDriver` and `SQLiteConnection`). `SentrySQLiteDriver` and shared span instrumentation via `SQLiteSpanInstrumentation` live here. | ||
|
|
||
| The split anticipates the possibility of future Kotlin Multiplatform support. The `androidx.sqlite.*` driver interfaces are defined in the library's `commonMain` source set and are reused by Room across Android, JVM, and native targets. Classes in `io.sentry.sqlite` are written against those portable interfaces and are intended to lift cleanly into a KMP `commonMain` source set if/when the `sentry` core gains multiplatform targets. Classes in `io.sentry.android.sqlite` are Android-only by construction and will stay where they are. | ||
|
|
||
| Note that the module artifact itself (`sentry-android-sqlite`) is currently an Android-only AAR regardless of package layout. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
sentry-android-sqlite/src/main/java/io/sentry/sqlite/DbMetadata.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| package io.sentry.sqlite | ||
|
|
||
| /** | ||
| * Value associated with [DB_SYSTEM_KEY][io.sentry.SpanDataConvention.DB_SYSTEM_KEY] for in-memory | ||
| * databases. | ||
| */ | ||
| internal const val DB_SYSTEM_IN_MEMORY = "in-memory" | ||
|
|
||
| /** | ||
| * Value associated with [DB_SYSTEM_KEY][io.sentry.SpanDataConvention.DB_SYSTEM_KEY] for SQLite | ||
| * databases. | ||
| */ | ||
| internal const val DB_SYSTEM_SQLITE = "sqlite" | ||
|
|
||
| /** | ||
| * Sentinel file name that [SQLiteDriver.open][androidx.sqlite.SQLiteDriver.open] interprets as an | ||
| * in-memory database: | ||
| * https://developer.android.com/reference/androidx/sqlite/driver/AndroidSQLiteDriver. | ||
| */ | ||
| private const val IN_MEMORY_DB_FILENAME = ":memory:" | ||
|
|
||
| /** Path separators matching [File.separatorChar][java.io.File.separatorChar]. */ | ||
| private val FILE_NAME_PATH_SEPARATORS = charArrayOf('/', '\\') | ||
|
|
||
| internal data class DbMetadata(val name: String?, val system: String) | ||
|
|
||
| /** | ||
| * Resolves metadata from the [fileName] argument to | ||
| * [SQLiteDriver.open][androidx.sqlite.SQLiteDriver.open]. | ||
| */ | ||
| internal fun dbMetadataFromFileName(fileName: String): DbMetadata { | ||
| if (fileName == IN_MEMORY_DB_FILENAME) { | ||
| return DbMetadata(name = null, system = DB_SYSTEM_IN_MEMORY) | ||
| } | ||
|
|
||
| val trimmed = fileName.trimEnd { it in FILE_NAME_PATH_SEPARATORS } | ||
| if (trimmed.isEmpty()) { | ||
| return DbMetadata(name = null, system = DB_SYSTEM_SQLITE) | ||
| } | ||
|
|
||
| val index = trimmed.lastIndexOfAny(FILE_NAME_PATH_SEPARATORS) | ||
| val basename = if (index >= 0) trimmed.substring(index + 1) else trimmed | ||
| return DbMetadata(name = basename.ifEmpty { null }, system = DB_SYSTEM_SQLITE) | ||
| } | ||
|
|
||
| /** | ||
| * Resolves metadata from | ||
| * [SupportSQLiteOpenHelper.databaseName][androidx.sqlite.db.SupportSQLiteOpenHelper.databaseName]. | ||
| */ | ||
| internal fun dbMetadataFromDatabaseName(databaseName: String?): DbMetadata = | ||
| if (databaseName == null) { | ||
| DbMetadata(name = null, system = DB_SYSTEM_IN_MEMORY) | ||
| } else { | ||
| DbMetadata(name = databaseName, system = DB_SYSTEM_SQLITE) | ||
| } |
85 changes: 85 additions & 0 deletions
85
sentry-android-sqlite/src/main/java/io/sentry/sqlite/SQLiteSpanInstrumentation.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| package io.sentry.sqlite | ||
|
|
||
| import io.sentry.IScopes | ||
| import io.sentry.Instrumenter | ||
| import io.sentry.ScopesAdapter | ||
| import io.sentry.SentryDate | ||
| import io.sentry.SentryLongDate | ||
| import io.sentry.SentryStackTraceFactory | ||
| import io.sentry.SpanDataConvention | ||
| import io.sentry.SpanStatus | ||
|
|
||
| private const val SQLITE_TRACE_ORIGIN = "auto.db.sqlite" | ||
|
|
||
| /** Shared span creation and metadata for SQLite instrumentation. */ | ||
| internal class SQLiteSpanInstrumentation( | ||
| private val scopes: IScopes, | ||
| private val dbMetadata: DbMetadata, | ||
| ) { | ||
|
|
||
| private val stackTraceFactory = SentryStackTraceFactory(scopes.options) | ||
|
|
||
| /** | ||
| * Returns a start timestamp for a `db.sql.query` span. | ||
| * | ||
| * Exposed so callers can capture a wall-clock start before accumulating database time. | ||
| * Internalizing the start time in [recordSpan] would shift spans to end-of-work on the trace | ||
| * timeline, which is less desirable. | ||
| */ | ||
| fun startTimestamp(): SentryDate = scopes.options.dateProvider.now() | ||
|
|
||
| /** Records a `db.sql.query` span from [startTimestamp] to the moment of invocation. */ | ||
| fun recordSpan( | ||
| sql: String, | ||
| startTimestamp: SentryDate, | ||
| status: SpanStatus, | ||
| throwable: Throwable? = null, | ||
| ) { | ||
| recordSpan(sql, startTimestamp, endTimestamp = null, status, throwable) | ||
| } | ||
|
|
||
| /** Records a `db.sql.query` span from [startTimestamp] to [startTimestamp] + [durationNanos]. */ | ||
| fun recordSpan( | ||
| sql: String, | ||
| startTimestamp: SentryDate, | ||
| durationNanos: Long, | ||
| status: SpanStatus, | ||
| throwable: Throwable? = null, | ||
| ) { | ||
| val endTimestamp = SentryLongDate(startTimestamp.nanoTimestamp() + durationNanos) | ||
| recordSpan(sql, startTimestamp, endTimestamp, status, throwable) | ||
| } | ||
|
|
||
| private fun recordSpan( | ||
| sql: String, | ||
| startTimestamp: SentryDate, | ||
| endTimestamp: SentryDate?, | ||
| status: SpanStatus, | ||
| throwable: Throwable?, | ||
| ) { | ||
| scopes.span?.startChild("db.sql.query", sql, startTimestamp, Instrumenter.SENTRY)?.apply { | ||
| spanContext.origin = SQLITE_TRACE_ORIGIN | ||
| throwable?.let { this.throwable = it } | ||
|
|
||
| val isMainThread = scopes.options.threadChecker.isMainThread | ||
| setData(SpanDataConvention.BLOCKED_MAIN_THREAD_KEY, isMainThread) | ||
|
|
||
| if (isMainThread) { | ||
| setData(SpanDataConvention.CALL_STACK_KEY, stackTraceFactory.inAppCallStack) | ||
| } | ||
|
|
||
| dbMetadata.name?.let { setData(SpanDataConvention.DB_NAME_KEY, it) } | ||
| setData(SpanDataConvention.DB_SYSTEM_KEY, dbMetadata.system) | ||
| finish(status, endTimestamp) | ||
| } | ||
| } | ||
|
|
||
| companion object { | ||
|
|
||
| fun fromDatabaseName(databaseName: String?, scopes: IScopes = ScopesAdapter.getInstance()) = | ||
| SQLiteSpanInstrumentation(scopes, dbMetadataFromDatabaseName(databaseName)) | ||
|
|
||
| fun fromFileName(fileName: String, scopes: IScopes = ScopesAdapter.getInstance()) = | ||
| SQLiteSpanInstrumentation(scopes, dbMetadataFromFileName(fileName)) | ||
| } | ||
| } |
15 changes: 15 additions & 0 deletions
15
sentry-android-sqlite/src/main/java/io/sentry/sqlite/SentrySQLiteConnection.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| package io.sentry.sqlite | ||
|
|
||
| import androidx.sqlite.SQLiteConnection | ||
| import androidx.sqlite.SQLiteStatement | ||
|
|
||
| internal class SentrySQLiteConnection( | ||
| private val delegate: SQLiteConnection, | ||
| private val spans: SQLiteSpanInstrumentation, | ||
| ) : SQLiteConnection by delegate { | ||
|
|
||
| override fun prepare(sql: String): SQLiteStatement { | ||
| val statement = delegate.prepare(sql) | ||
| return statement as? SentrySQLiteStatement ?: SentrySQLiteStatement(statement, spans, sql) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.