Skip to content

Commit 26a202f

Browse files
committed
docs(flutter): Document Flutter iOS replay overhead
1 parent 454a04f commit 26a202f

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

docs/platforms/dart/guides/flutter/session-replay/performance-overhead.mdx

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "Learn about how enabling Session Replay impacts the performance of
77

88
If you're considering enabling Session Replay, it's important to understand the potential performance impact to your app. Learn more about Replay SDK optimizations in the [Replay Performance Overhead](/product/explore/session-replay/mobile/performance-overhead/) docs.
99

10-
Meaningful metrics require realistic testing where you apply typical access patterns and correlate the results with your business metrics. To provide a baseline, we measure replay overhead using this [Open Food Facts app](https://github.com/openfoodfacts/smooth-app/).
10+
Meaningful metrics require realistic testing where you apply typical access patterns and correlate the results with your business metrics. To provide a baseline, we measure replay overhead using this [Open Food Facts app](https://github.com/openfoodfacts/smooth-app/).
1111
We chose Open Food Facts because it's an actively maintained open source app that presents several scrollable, interactable lists of both text and images during onboarding. The app also includes native functionality like a default camera view for barcode scanning, making for a more comprehensive testing scenario.
1212

1313
## Benchmarking Setup
@@ -17,9 +17,23 @@ Here's how the benchmarks were conducted:
1717
- **Configuration:** Default (complete) masking was enabled, and optimized release builds were used.
1818
- **User Flow:** The same flow was executed 10 times to ensure consistency.
1919
- **Real-World Representation:** This approach closely mirrors performance in real-world scenarios.
20-
The benchmarks were run on a Pixel Fold (2023) running Android 15.
2120

22-
### Results
21+
The benchmarks were run on:
22+
- **iOS**: iPhone X with iOS 16.7.10 - Performance was measured using [py-ios-device](https://github.com/YueChen-C/py-ios-device) during manual onboarding flows.
23+
- **Android**: Pixel Fold (2023) running Android 15
24+
25+
Note that active Session Replay recording can introduce slow frames on older lower-end devices.
26+
27+
### iOS
28+
29+
Below are the results of the benchmarking tests, presented as average values across 10 runs.
30+
31+
| Metric | Sentry SDK only | Sentry + Replay SDK |
32+
| -------------------------------- | --------------- | ------------------- |
33+
| CPU Usage | 30.04% | 31.92% (+6.26%) |
34+
| Memory | 193.25 MiB | 193.1 MiB |
35+
36+
### Android
2337

2438
Below are the results of the benchmarking tests, presented as average values across all runs.
2539

@@ -45,7 +59,7 @@ Lowering the quality of captured screenshots and videos can significantly reduce
4559
await SentryFlutter.init(
4660
(options) {
4761
...
48-
options.replay.quality = SentryReplayQuality.low // defaults to medium
62+
options.replay.quality = SentryReplayQuality.low; // defaults to medium
4963
},
5064
...
5165
);

0 commit comments

Comments
 (0)