docs(android): add Compose effect guidance - #19308
Open
0xadam-brown wants to merge 1 commit into
Open
Conversation
Add Compose-specific guidance about emitting custom telemetry from Effect APIs and other post-composition callbacks instead of from composable bodies. Cross-link the Android custom instrumentation page back to the Compose page so manual instrumentation guidance points readers to this recomposition caveat.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
coolguyzone
reviewed
Sep 10, 2026
|
|
||
| ## Custom Telemetry in Compose | ||
|
|
||
| Composable functions can run many times during recomposition. Don't emit custom Sentry spans, messages, |
Contributor
There was a problem hiding this comment.
Suggested change
| Composable functions can run many times during recomposition. Don't emit custom Sentry spans, messages, | |
| Composable functions can run many times during recomposition. Don't send custom Sentry spans, messages, |
Technically both are correct, just trying to keep the vocabulary simple to accommodate users with limited English.
coolguyzone
reviewed
Sep 10, 2026
| breadcrumbs, or other telemetry directly from a composable body, as it can duplicate telemetry or attach it | ||
| to the wrong UI lifecycle moment. | ||
|
|
||
| Prefer emitting telemetry from: |
Contributor
There was a problem hiding this comment.
Suggested change
| Prefer emitting telemetry from: | |
| Instead, send telemetry from: |
coolguyzone
reviewed
Sep 10, 2026
| } | ||
| ``` | ||
|
|
||
| Instead, capture state in the body as needed but emit it from an Effect API: |
Contributor
There was a problem hiding this comment.
Suggested change
| Instead, capture state in the body as needed but emit it from an Effect API: | |
| Instead, capture state in the body as needed but send it from an Effect API: |
coolguyzone
reviewed
Sep 10, 2026
|
|
||
| <Alert level="info" title="Using custom instrumentation in Jetpack Compose?"> | ||
|
|
||
| If you emit custom Sentry spans or other telemetry from Jetpack Compose code, use Compose Effect APIs such as |
Contributor
There was a problem hiding this comment.
Suggested change
| If you emit custom Sentry spans or other telemetry from Jetpack Compose code, use Compose Effect APIs such as | |
| If you send custom Sentry spans or other telemetry from Jetpack Compose code, use Compose Effect APIs such as |
coolguyzone
reviewed
Sep 10, 2026
| <Alert level="info" title="Using custom instrumentation in Jetpack Compose?"> | ||
|
|
||
| If you emit custom Sentry spans or other telemetry from Jetpack Compose code, use Compose Effect APIs such as | ||
| `LaunchedEffect`, `DisposableEffect`, or `SideEffect` instead of emitting from a composable body. Composable bodies |
Contributor
There was a problem hiding this comment.
Suggested change
| `LaunchedEffect`, `DisposableEffect`, or `SideEffect` instead of emitting from a composable body. Composable bodies | |
| `LaunchedEffect`, `DisposableEffect`, or `SideEffect` instead of sending from a composable body. Composable bodies |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
DESCRIBE YOUR PR
Add Compose-specific guidance about emitting custom telemetry from Effect APIs and other post-composition callbacks instead of from composable bodies.
Cross-link the Android custom instrumentation page back to the Compose page so manual instrumentation guidance points readers to this recomposition caveat.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES