ref(replay): Use main thread to schedule capture #4542

romtsn · 2025-07-07T08:01:50Z

📜 Description

This reworks the logic to schedule screenshot + VH capture on the main thread using Handler.postDelayed
- We were anyway posting a message from the capturer thread to the main thread before, so this gets rid of thread context switch all the time, plus ensures we run view checks (like root.width/height) on the main thread right before we capture

A couple of replay examples with the new capture logic:

https://sentry-sdks.sentry.io/explore/replays/699aa0aff2e2496db716274d637f6a33
https://sentry-sdks.sentry.io/explore/replays/d043fb059023427b97fe54f4abf39832

💡 Motivation and Context

💚 How did you test it?

Manually

📝 Checklist

I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

github-actions · 2025-07-07T08:10:23Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	419.33 ms	439.25 ms	19.92 ms
Size	1.58 MiB	2.09 MiB	519.98 KiB

Previous results on branch: rz/ref/capturer-main-thread

Startup times

Revision	Plain	With Sentry	Diff
`19c0147`	376.06 ms	415.75 ms	39.69 ms
`ed11513`	414.06 ms	447.55 ms	33.49 ms
`fb2baf9`	401.23 ms	432.56 ms	31.33 ms
`f1fdc3f`	374.00 ms	421.76 ms	47.76 ms

App size

Revision	Plain	With Sentry	Diff
`19c0147`	1.58 MiB	2.09 MiB	519.30 KiB
`ed11513`	1.58 MiB	2.09 MiB	520.10 KiB
`fb2baf9`	1.58 MiB	2.09 MiB	519.89 KiB
`f1fdc3f`	1.58 MiB	2.09 MiB	519.76 KiB

sentry-android-replay/src/main/java/io/sentry/android/replay/util/MainLooperHandler.kt

stefanosiano

looks good
just a small renaming

Co-authored-by: roman.zavarnitsyn <roman.zavarnitsyn@sentry.io>

…e scheduling new ones

cursor · 2025-07-30T21:19:47Z

sentry-android-replay/src/main/java/io/sentry/android/replay/WindowRecorder.kt

+          "Posting the capture runnable again, frame rate is ${config?.frameRate ?: 1} fps.",
+        )
+      }
+      val posted = mainLooperHandler.postDelayed(this, 1000L / (config?.frameRate ?: 1))


Bug: Zero Frame Rate Causes Division Error

A division by zero ArithmeticException occurs in the expression 1000L / (config?.frameRate ?: 1) when config.frameRate is 0. The ?: 1 fallback only handles null values, not 0. This can lead to a runtime crash of the capture loop, as ScreenshotRecorderConfig can internally set frameRate to 0.

Locations (1)

sentry-android-replay/src/main/java/io/sentry/android/replay/WindowRecorder.kt#L99-L100

* Do not report cached events as lost * E2E tests for OpenTelemetry based console sample (#4563) * e2e tests for console app * fix test failures by waiting for 10s after first try to find envelopes * add system-test-runner.py script to replace bash scripts for running e2e / system tests * use py script for ci, cleanup, makefile * Format code * remove bash scripts * install requests module * api * fix gh script * Implement E2E tests for OTel based console sample * fixes after merge * Format code * e2e tests for console app * Implement E2E tests for OTel based console sample * fixes after merge * Format code * api * Reduce scope forking when using OpenTelemetry (#4565) * Reduce scope forking in OpenTelemetry * Format code * api * changelog --------- Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io> * SDKs send queue is no longer shutdown immediately on re-init (#4564) * Let queue drain on a restart * Format code * Format code * Update sentry-samples/sentry-samples-console-opentelemetry-noagent/src/test/kotlin/sentry/systemtest/ConsoleApplicationSystemTest.kt * Let queue drain on a restart * Format code * Format code * Update sentry-samples/sentry-samples-console-opentelemetry-noagent/src/test/kotlin/sentry/systemtest/ConsoleApplicationSystemTest.kt * adapt tests * changelog --------- Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io> --------- Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io> * release: 8.18.0 * ref(replay): Use main thread to schedule capture (#4542) * perf(connectivity): Cache network capabilities and status to reduce IPC calls (#4560) * fix(breadcrumbs): Deduplicate battery breadcrumbs (#4561) * fix(ci): remove obsolete NDK debug symbols (#4581) As they don't exist anymore and this is done within sentry-native directly: https://github.com/getsentry/sentry-native/pull/1327/files * fix(android): Remove unused method (#4585) * fix(android): Remove unused method * Update Changelog * Add rules file for documenting SDK offline behaviour (#4572) #skip-changelog ## 📜 Description  Add rules file for documenting SDK offline behaviour ## 💡 Motivation and Context   Should help speed up AI reasoning about the SDK offline/retry behaviour. ## 💚 How did you test it? ## 📝 Checklist  - [ ] I added tests to verify the changes. - [ ] No new PII added or SDK only sends newly added PII if `sendDefaultPII` is enabled. - [ ] I updated the docs if needed. - [ ] I updated the wizard if needed. - [ ] Review from the native team if needed. - [ ] No breaking change or entry added to the changelog. - [ ] No breaking change for hybrid SDKs or communicated to hybrid SDKs. ## 🔮 Next steps * perf(connectivity): Have only one NetworkCallback active at a time (#4562) * fix(scripts): update-gradle script set-version (#4591) * fix: sentry-android-ndk proguard rule keeps all native class (#4427) * fix: sentry-androi-ndk proguard rule keeps all native class * docs: update CHANGELOG * fix: update CHANGELOG * Update CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: Markus Hintersteiner <m.hintersteiner@gmail.com> Co-authored-by: Markus Hintersteiner <markus.hintersteiner@sentry.io> * refactor(lifecycle): Use single lifecycle observer (#4567) * perf(connectivity): Cache network capabilities and status to reduce IPC calls * changelog * Changelog * revert * fix(breadcrumbs): Deduplicate battery breadcrumbs * ref * Changelog * Fix test * perf(connectivity): Have only one NetworkCallback active at a time * Changelog * perf(integrations): Use single lifecycle observer * Add tests * Changelog * Fix tests * Improve callback handling and test visibility (#4593) * Null-check lifecycleObserver --------- Co-authored-by: Markus Hintersteiner <markus.hintersteiner@sentry.io> * fix(sqlite): Fix abstract method error (#4597) * fix(sqlite): Fix abstract method error * Update CHANGELOG.md * Suppress metadata version checks * perf(integrations): Do not register for SystemEvents and NetworkCallbacks when launched with background importance (#4579) * fix(android): Ensure frame metrics listeners are registered/unregistered on the main thread (#4582) * fix(android): Ensure frame metrics listeners are registered/unregistered on the main thread * Fix race conditions * Update Changelog * Update CHANGELOG.md * Address PR feedback * perf(executor): Prewarm SentryExecutorService (#4606) * review feedback * changelog * pass through whether cache stored in AndroidEnvelopeCache + test * Format code --------- Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io> Co-authored-by: getsentry-bot <bot@sentry.io> Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com> Co-authored-by: Markus Hintersteiner <markus.hintersteiner@sentry.io> Co-authored-by: Ghasem Shirdel <shirdelghasem79@gmail.com> Co-authored-by: Markus Hintersteiner <m.hintersteiner@gmail.com>

romtsn added 4 commits June 30, 2025 12:12

WIP

dde1cf9

refactor(replay): Use main thread handler to schedule replay capture

ea48169

Remove logging in test

2ab706a

Merge branch 'main' into rz/ref/capturer-main-thread

6b45f95

romtsn requested review from adinauer, lcian, markushi and stefanosiano as code owners July 7, 2025 08:01

getsentry-bot and others added 3 commits July 7, 2025 08:04

Format code

55c69c0

Merge branch 'main' into rz/ref/capturer-main-thread

cda9443

Changelog

1fa757f

stefanosiano reviewed Jul 11, 2025

View reviewed changes

sentry-android-replay/src/main/java/io/sentry/android/replay/util/MainLooperHandler.kt Show resolved Hide resolved

stefanosiano approved these changes Jul 11, 2025

View reviewed changes

Merge branch 'main' into rz/ref/capturer-main-thread

2f91577

romtsn mentioned this pull request Jul 16, 2025

perf(connectivity): Cache network capabilities and status to reduce IPC calls #4560

Merged

7 tasks

markushi approved these changes Jul 30, 2025

View reviewed changes

Merge branch 'main' into rz/ref/capturer-main-thread

866aa6d

This comment was marked as outdated.

Sign in to view

cursoragent and others added 4 commits July 30, 2025 14:52

Fix race condition in WindowRecorder close method

f3b50b7

Co-authored-by: roman.zavarnitsyn <roman.zavarnitsyn@sentry.io>

Use lock for capturer insantiation, removeCallbacks of capturer befor…

221dc8a

…e scheduling new ones

Merge branch 'main' into rz/ref/capturer-main-thread

060da49

Changelog

7611320

romtsn enabled auto-merge (squash) July 30, 2025 21:15

romtsn disabled auto-merge July 30, 2025 21:15

romtsn enabled auto-merge (squash) July 30, 2025 21:16

cursor bot reviewed Jul 30, 2025

View reviewed changes

romtsn merged commit dfd5da0 into main Jul 30, 2025
34 of 35 checks passed

romtsn deleted the rz/ref/capturer-main-thread branch July 30, 2025 21:26

adinauer pushed a commit that referenced this pull request Aug 8, 2025

ref(replay): Use main thread to schedule capture (#4542)

c1cee9b

antonis mentioned this pull request Aug 11, 2025

chore(deps): v7: update Android SDK to v8.19.0 getsentry/sentry-react-native#5063

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ref(replay): Use main thread to schedule capture #4542

ref(replay): Use main thread to schedule capture #4542

Uh oh!

romtsn commented Jul 7, 2025

Uh oh!

github-actions bot commented Jul 7, 2025 •

edited

Loading

Previous results on branch: rz/ref/capturer-main-thread

Startup times

App size

Uh oh!

Uh oh!

stefanosiano left a comment

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot Jul 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

ref(replay): Use main thread to schedule capture #4542

ref(replay): Use main thread to schedule capture #4542

Uh oh!

Conversation

romtsn commented Jul 7, 2025

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

github-actions bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Previous results on branch: rz/ref/capturer-main-thread

Startup times

App size

Uh oh!

Uh oh!

stefanosiano left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot Jul 30, 2025

Choose a reason for hiding this comment

Bug: Zero Frame Rate Causes Division Error

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

github-actions bot commented Jul 7, 2025 •

edited

Loading