Skip to content

Overload withSentryObservableEffect to provide compose instrumentation hook #2320

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.

Sign up for GitHub

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
markushi merged 7 commits into from
Oct 28, 2022
Merged

Overload withSentryObservableEffect to provide compose instrumentation hook #2320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
110994b
Add rememberNavController to provide compose navigation hook
markushi Oct 24, 2022
f4673e9
Remove rememberNavController in favor of withSentryObservableEffect w…
markushi Oct 27, 2022
dc83ccd
Merge branch 'main' into feature/compose-navigation-instrumentation
markushi Oct 27, 2022
48df693
Mark withSentryObservableEffect as internal
markushi Oct 27, 2022
3f789a3
Add Changelog
markushi Oct 27, 2022
c5424a4
Add missing header for Changelog
markushi Oct 27, 2022
4441c5f
Update .api file
markushi Oct 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## Unreleased

### Features
- Provide hook for Jetpack Compose navigation instrumentation ([#2320](https://github.com/getsentry/sentry-java/pull/2320))

## 6.6.0

### Fixes
Expand Down
17 changes: 16 additions & 1 deletion sentry-compose/src/androidMain/kotlin/io/sentry/compose/SentryNavigationIntegration.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ internal class SentryLifecycleObserver(

/**
* A [DisposableEffect] that captures a [Breadcrumb] and starts an [ITransaction] and sends
* them to Sentry for when attached to the respective [NavHostController].
* them to Sentry for every navigation event when being attached to the respective [NavHostController].
*
* @param enableNavigationBreadcrumbs Whether the integration should capture breadcrumbs for
* navigation events.
Expand Down Expand Up @@ -73,3 +73,18 @@ public fun NavHostController.withSentryObservableEffect(
}
return this
}

/**
* A [DisposableEffect] that captures a [Breadcrumb] and starts an [ITransaction] and sends
* them to Sentry for every navigation event when being attached to the respective [NavHostController].
*
* Used by the sentry android gradle plugin for Jetpack Compose instrumentation.
*
*/
@Composable
internal fun NavHostController.withSentryObservableEffect(): NavHostController {
return withSentryObservableEffect(
enableNavigationBreadcrumbs = true,
enableNavigationTracing = true
)
}