-
-
Notifications
You must be signed in to change notification settings - Fork 432
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add capabilities to track jetpack compose composition/rendering time (#…
…2507) Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com> Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io>
- Loading branch information
3 people
committed
Mar 16, 2023
1 parent
e0df34f
commit 550d8ec
Showing
20 changed files
with
975 additions
and
286 deletions.
There are no files selected for viewing
This file contains 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 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 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
57 changes: 57 additions & 0 deletions
57
...sentry-uitest-android/src/androidTest/java/io/sentry/uitest/android/AutomaticSpansTest.kt
This file contains 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,57 @@ | ||
| package io.sentry.uitest.android | ||
|
|
||
| import androidx.lifecycle.Lifecycle | ||
| import androidx.test.core.app.launchActivity | ||
| import androidx.test.ext.junit.runners.AndroidJUnit4 | ||
| import io.sentry.Sentry | ||
| import io.sentry.SentryLevel | ||
| import io.sentry.SentryOptions | ||
| import io.sentry.android.core.SentryAndroidOptions | ||
| import io.sentry.protocol.SentryTransaction | ||
| import org.junit.runner.RunWith | ||
| import kotlin.test.Test | ||
| import kotlin.test.assertEquals | ||
| import kotlin.test.assertTrue | ||
|
|
||
| @RunWith(AndroidJUnit4::class) | ||
| class AutomaticSpansTest : BaseUiTest() { | ||
|
|
||
| @Test | ||
| fun ttidTtfdSpans() { | ||
| val transactions = mutableListOf<SentryTransaction>() | ||
|
|
||
| initSentry(false) { options: SentryAndroidOptions -> | ||
| options.isDebug = true | ||
| options.setDiagnosticLevel(SentryLevel.DEBUG) | ||
| options.tracesSampleRate = 1.0 | ||
| options.profilesSampleRate = 1.0 | ||
| options.isEnableAutoActivityLifecycleTracing = true | ||
| options.beforeSendTransaction | ||
| options.isEnableTimeToFullDisplayTracing = true | ||
| options.beforeSendTransaction = | ||
| SentryOptions.BeforeSendTransactionCallback { transaction, _ -> | ||
| transactions.add(transaction) | ||
| transaction | ||
| } | ||
| } | ||
|
|
||
| val activity = launchActivity<ComposeActivity>() | ||
| activity.moveToState(Lifecycle.State.RESUMED) | ||
| activity.onActivity { | ||
| Sentry.reportFullyDisplayed() | ||
| } | ||
| activity.moveToState(Lifecycle.State.DESTROYED) | ||
|
|
||
| assertEquals(1, transactions.size) | ||
| assertTrue("TTID span missing") { | ||
| transactions.first().spans.any { | ||
| it.op == "ui.load.initial_display" | ||
| } | ||
| } | ||
| assertTrue("TTFD span missing") { | ||
| transactions.first().spans.any { | ||
| it.op == "ui.load.full_display" | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains 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
98 changes: 98 additions & 0 deletions
98
sentry-compose/src/androidMain/kotlin/io/sentry/compose/SentryComposeTracing.kt
This file contains 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,98 @@ | ||
| package io.sentry.compose | ||
|
|
||
| import androidx.compose.foundation.layout.Box | ||
| import androidx.compose.foundation.layout.BoxScope | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.Immutable | ||
| import androidx.compose.runtime.compositionLocalOf | ||
| import androidx.compose.runtime.remember | ||
| import androidx.compose.ui.ExperimentalComposeUiApi | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.draw.drawWithContent | ||
| import androidx.compose.ui.platform.testTag | ||
| import io.sentry.ISpan | ||
| import io.sentry.Sentry | ||
| import io.sentry.SpanOptions | ||
|
|
||
| private const val OP_PARENT_COMPOSITION = "ui.compose.composition" | ||
| private const val OP_COMPOSE = "ui.compose" | ||
|
|
||
| private const val OP_PARENT_RENDER = "ui.compose.rendering" | ||
| private const val OP_RENDER = "ui.render" | ||
|
|
||
| @Immutable | ||
| private class ImmutableHolder<T>(var item: T) | ||
|
|
||
| private fun getRootSpan(): ISpan? { | ||
| var rootSpan: ISpan? = null | ||
| Sentry.configureScope { | ||
| rootSpan = it.transaction | ||
| } | ||
| return rootSpan | ||
| } | ||
|
|
||
| private val localSentryCompositionParentSpan = compositionLocalOf { | ||
| ImmutableHolder( | ||
| getRootSpan() | ||
| ?.startChild( | ||
| OP_PARENT_COMPOSITION, | ||
| "Jetpack Compose Initial Composition", | ||
| SpanOptions().apply { | ||
| isTrimStart = true | ||
| isTrimEnd = true | ||
| isIdle = true | ||
| } | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| private val localSentryRenderingParentSpan = compositionLocalOf { | ||
| ImmutableHolder( | ||
| getRootSpan() | ||
| ?.startChild( | ||
| OP_PARENT_RENDER, | ||
| "Jetpack Compose Initial Render", | ||
| SpanOptions().apply { | ||
| isTrimStart = true | ||
| isTrimEnd = true | ||
| isIdle = true | ||
| } | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| @ExperimentalComposeUiApi | ||
| @Composable | ||
| public fun SentryTraced( | ||
| tag: String, | ||
| modifier: Modifier = Modifier, | ||
| enableUserInteractionTracing: Boolean = true, | ||
| content: @Composable BoxScope.() -> Unit | ||
| ) { | ||
| val parentCompositionSpan = localSentryCompositionParentSpan.current | ||
| val parentRenderingSpan = localSentryRenderingParentSpan.current | ||
| val compositionSpan = parentCompositionSpan.item?.startChild(OP_COMPOSE, tag) | ||
| val firstRendered = remember { ImmutableHolder(false) } | ||
|
|
||
| val baseModifier = if (enableUserInteractionTracing) modifier.testTag(tag) else modifier | ||
|
|
||
| Box( | ||
| modifier = baseModifier | ||
| .drawWithContent { | ||
| val renderSpan = if (!firstRendered.item) { | ||
| parentRenderingSpan.item?.startChild( | ||
| OP_RENDER, | ||
| tag | ||
| ) | ||
| } else { | ||
| null | ||
| } | ||
| drawContent() | ||
| firstRendered.item = true | ||
| renderSpan?.finish() | ||
| } | ||
| ) { | ||
| content() | ||
| } | ||
| compositionSpan?.finish() | ||
| } |
Oops, something went wrong.