feat(replay): Mobile Replay performance overhead #11989

romtsn · 2024-11-28T15:23:39Z

DESCRIBE YOUR PR

Adds docs on Mobile Replay overhead to the product section as well as each of the respective SDKs (Flutter currently missing as we don't have the benchmarks yet).

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

Urgent deadline (GA date, etc.):
Other deadline:
None: Not urgent, can wait up to 1 week+

SLA

Teamwork makes the dream work, so please add a reviewer to your PRs.
Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

Checked Vercel preview for correctness, including links
PR was reviewed and approved by any necessary SMEs (subject matter experts)
PR was reviewed and approved by a member of the Sentry docs team

vercel · 2024-11-28T15:23:45Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sentry-docs	🛑 Canceled (Inspect)			Dec 4, 2024 3:07pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
changelog	⬜️ Ignored (Inspect)	Visit Preview		Dec 4, 2024 3:07pm
develop-docs	⬜️ Ignored (Inspect)	Visit Preview		Dec 4, 2024 3:07pm

codecov · 2024-11-28T15:25:43Z

Bundle Report

Changes will increase total bundle size by 966 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
sentry-docs-server-cjs	10.2MB	972 bytes (0.01%) ⬆️
sentry-docs-client-array-push	9.11MB	6 bytes (-0.0%) ⬇️

docs/product/explore/session-replay/mobile/performance-overhead.mdx

jas-kas · 2024-11-28T21:32:18Z

docs/product/explore/session-replay/mobile/performance-overhead.mdx

+
+- The Session Replay SDK works by capturing screenshots, encoding them into small video segments and transmitting the content to Sentry’s servers. To reduce the amount of data transferred, multiple optimization strategies are employed:
+  - The SDK captures at most one screenshot per second at a 1:1 pixel density (commonly referred to as `@1x` on iOS and `mdpi` on Android). This significantly speeds up the screenshot screenshot capture process while maintaining acceptable quality.
+  - Screenshots are compressed into lossy `jpeg` files to reduce disk space usage and enable replay recovery in the event of a crash or an ANR.


what do we mean by 'replay recovery', its not clear to me?

recovering last segment/frames of a replay in case a crash happened. Not sure how to phrase this better

tried to rephrase it - let me know if it's clearer now

docs/product/explore/session-replay/mobile/performance-overhead.mdx

docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx

jas-kas · 2024-11-28T21:54:10Z

docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx

+| Network Bandwidth                | -               | 50 KB               |
+
+
+The benchmarks were run on an iPhone 14 Pro.


Can we bring this up to the main paragraph above here? I don't think it needs to be isolated

docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx

docs/platforms/react-native/session-replay/performance-overhead.mdx

jas-kas · 2024-11-28T21:58:09Z

docs/product/explore/session-replay/mobile/performance-overhead.mdx

+
+The only way to get accurate metrics is to measure performance overhead yourself. You can apply realistic access patterns against your own application, and correlate that to your own topline business metrics.
+
+We measured the overhead of the Replay SDK on various open-source apps that have millions of users in production (i.e. real-world apps that have a big set of different components and features), such as [Bluesky](https://github.com/bluesky-social/social-app) or [Pocket Casts](https://github.com/Automattic/pocket-casts-android). You can check the results on the respective SDK's docs:


Why do we mention Bluesky when both iOS and Android examples are Pocket Casts based? Am I missing something? 👁️

yeah we used it for benchmarking as well, but here it's just an example as we don't provide those numbers anywhere. Can remove it, but also don't think it hurts

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

…rhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

docs/product/explore/session-replay/mobile/performance-overhead.mdx

…d.mdx

brustolin

Regarding data and behavior is all good. I will let people with better English review the wording and organization.

lizokm

Thanks so much for adding this! I've made some language recommendations :)

docs/platforms/android/session-replay/performance-overhead.mdx

docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx

docs/product/explore/session-replay/mobile/performance-overhead.mdx

Co-authored-by: Liza Mock <liza.mock@sentry.io>

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

…rhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Co-authored-by: Liza Mock <liza.mock@sentry.io>

docs/platforms/react-native/session-replay/performance-overhead.mdx

…d.mdx

* feat(replay): Mobile Replay performance overhead * Fix links * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/platforms/react-native/session-replay/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx * Address PR feedback * Address PR feedback * Update docs/platforms/android/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/product/explore/session-replay/mobile/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/react-native/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/react-native/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/react-native/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/react-native/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/android/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/android/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/android/session-replay/performance-overhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/react-native/session-replay/performance-overhead.mdx --------- Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com> Co-authored-by: Liza Mock <liza.mock@sentry.io>

romtsn added 2 commits November 28, 2024 16:19

feat(replay): Mobile Replay performance overhead

4059ca2

Merge branch 'master' into rz/feat/session-replay-perf-overehead

3a53bf0

romtsn requested review from a team, bruno-garcia, brustolin, jas-kas, kahest and krystofwoldrich November 28, 2024 15:23

vercel bot deployed to Preview – develop-docs November 28, 2024 15:26 View deployment

vercel bot deployed to Preview – sentry-docs November 28, 2024 15:52 View deployment

Fix links

735fcf7

vercel bot deployed to Preview – sentry-docs November 28, 2024 16:37 View deployment

jas-kas approved these changes Nov 28, 2024

View reviewed changes

romtsn and others added 11 commits November 29, 2024 09:00

Update docs/product/explore/session-replay/mobile/performance-overhea…

7c8c7e3

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/platforms/react-native/session-replay/performance-overhea…

6252573

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/product/explore/session-replay/mobile/performance-overhea…

1d6646a

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/product/explore/session-replay/mobile/performance-overhea…

9b324fd

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/product/explore/session-replay/mobile/performance-overhea…

5e34e6c

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/platforms/apple/guides/ios/session-replay/performance-ove…

5cde0be

…rhead.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/product/explore/session-replay/mobile/performance-overhea…

272ba00

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/product/explore/session-replay/mobile/performance-overhea…

ea752e5

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/product/explore/session-replay/mobile/performance-overhea…

2e8acfb

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/product/explore/session-replay/mobile/performance-overhea…

ea4d452

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

Update docs/product/explore/session-replay/mobile/performance-overhea…

5ba12f9

…d.mdx Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

romtsn commented Nov 29, 2024

View reviewed changes

docs/product/explore/session-replay/mobile/performance-overhead.mdx Outdated Show resolved Hide resolved

Update docs/product/explore/session-replay/mobile/performance-overhea…

3ca4d9d

…d.mdx

vercel bot deployed to Preview – sentry-docs November 29, 2024 08:39 View deployment

brustolin approved these changes Nov 29, 2024

View reviewed changes

lizokm approved these changes Dec 3, 2024

View reviewed changes

kahest mentioned this pull request Dec 3, 2024

chore: Add new SDK overhead page for Android #12031

Merged

6 tasks

romtsn and others added 2 commits December 4, 2024 13:50

Update docs/platforms/android/session-replay/performance-overhead.mdx

17f19ea

Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/product/explore/session-replay/mobile/performance-overhea…

9b9453c

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

vercel bot deployed to Preview – sentry-docs December 4, 2024 13:16 View deployment

romtsn and others added 3 commits December 4, 2024 14:47

Update docs/product/explore/session-replay/mobile/performance-overhea…

f0de54d

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/product/explore/session-replay/mobile/performance-overhea…

e8fc586

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/product/explore/session-replay/mobile/performance-overhea…

2b8441b

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

vercel bot deployed to Preview – sentry-docs December 4, 2024 14:15 View deployment

romtsn and others added 14 commits December 4, 2024 15:26

Update docs/product/explore/session-replay/mobile/performance-overhea…

01be474

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/product/explore/session-replay/mobile/performance-overhea…

c634e6e

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/product/explore/session-replay/mobile/performance-overhea…

f96d1ab

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/product/explore/session-replay/mobile/performance-overhea…

a0ec705

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/react-native/session-replay/performance-overhea…

b24170c

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/react-native/session-replay/performance-overhea…

c6e8e3e

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/react-native/session-replay/performance-overhea…

06dfb69

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/react-native/session-replay/performance-overhea…

3360c7d

…d.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/apple/guides/ios/session-replay/performance-ove…

19be384

…rhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/apple/guides/ios/session-replay/performance-ove…

800e00d

…rhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/apple/guides/ios/session-replay/performance-ove…

c6d5210

…rhead.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/android/session-replay/performance-overhead.mdx

b7eab55

Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/android/session-replay/performance-overhead.mdx

e11cb9c

Co-authored-by: Liza Mock <liza.mock@sentry.io>

Update docs/platforms/android/session-replay/performance-overhead.mdx

77d80e6

Co-authored-by: Liza Mock <liza.mock@sentry.io>

romtsn commented Dec 4, 2024

View reviewed changes

docs/platforms/react-native/session-replay/performance-overhead.mdx Outdated Show resolved Hide resolved

Update docs/platforms/react-native/session-replay/performance-overhea…

47fe5fd

…d.mdx

vercel bot deployed to Preview – sentry-docs December 4, 2024 15:07 View deployment

romtsn merged commit 7609dca into master Dec 4, 2024
11 checks passed

romtsn deleted the rz/feat/session-replay-perf-overehead branch December 4, 2024 15:12

github-actions bot locked and limited conversation to collaborators Dec 20, 2024

		\| Network Bandwidth \| - \| 50 KB \|


		The benchmarks were run on an iPhone 14 Pro.


		The only way to get accurate metrics is to measure performance overhead yourself. You can apply realistic access patterns against your own application, and correlate that to your own topline business metrics.

		We measured the overhead of the Replay SDK on various open-source apps that have millions of users in production (i.e. real-world apps that have a big set of different components and features), such as [Bluesky](https://github.com/bluesky-social/social-app) or [Pocket Casts](https://github.com/Automattic/pocket-casts-android). You can check the results on the respective SDK's docs:

Uh oh!

feat(replay): Mobile Replay performance overhead #11989

feat(replay): Mobile Replay performance overhead #11989

Uh oh!

Conversation

romtsn commented Nov 28, 2024

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

Uh oh!

vercel bot commented Nov 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Nov 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jas-kas Nov 28, 2024

Choose a reason for hiding this comment

Uh oh!

romtsn Nov 29, 2024

Choose a reason for hiding this comment

Uh oh!

romtsn Nov 29, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jas-kas Nov 28, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jas-kas Nov 28, 2024

Choose a reason for hiding this comment

Uh oh!

romtsn Dec 2, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brustolin left a comment

Choose a reason for hiding this comment

Uh oh!

lizokm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vercel bot commented Nov 28, 2024 •

edited

Loading

codecov bot commented Nov 28, 2024 •

edited

Loading