fix(frame-tracking): app lag when long running span finishes#2311
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2311 +/- ##
==========================================
+ Coverage 88.07% 90.82% +2.74%
==========================================
Files 247 73 -174
Lines 8603 2386 -6217
==========================================
- Hits 7577 2167 -5410
+ Misses 1026 219 -807 ☔ View full report in Codecov by Sentry. |
ueman
reviewed
Sep 26, 2024
| /// If the number of frames exceeds the maximum, the frame tracking is cancelled | ||
| /// and frame metrics are cleared for the current active spans. | ||
| /// Default value is 3 minutes. | ||
| int framesTrackingRetentionPeriod = 3; |
Collaborator
There was a problem hiding this comment.
Why don't you use Duration? That way you will not have any confusion regarding the unit:
Suggested change
| int framesTrackingRetentionPeriod = 3; | |
| Duration framesTrackingRetentionPeriod = Duration(minutes: 3); |
Also, your calculations further down below will also be simpler :D
Contributor
Author
There was a problem hiding this comment.
I think I'll just use a fixed number like 10800 as default, it's a pretty confusing option tbh
Contributor
Android Performance metrics 🚀
|
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 7f14ddd | 428.38 ms | 511.90 ms | 83.51 ms |
| e2d89fc | 323.84 ms | 376.23 ms | 52.39 ms |
| b0811cc | 580.00 ms | 675.69 ms | 95.69 ms |
| d089990 | 361.67 ms | 442.50 ms | 80.83 ms |
| 7f75f32 | 347.36 ms | 419.58 ms | 72.22 ms |
| 5e8d2b3 | 342.17 ms | 375.83 ms | 33.66 ms |
| 55cc6ef | 300.98 ms | 351.98 ms | 51.00 ms |
| 559d28f | 302.35 ms | 339.53 ms | 37.18 ms |
| d5fb969 | 420.83 ms | 490.88 ms | 70.05 ms |
| 683fd34 | 336.53 ms | 418.10 ms | 81.57 ms |
App size
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 7f14ddd | 6.35 MiB | 7.40 MiB | 1.05 MiB |
| e2d89fc | 6.06 MiB | 7.03 MiB | 989.37 KiB |
| b0811cc | 6.33 MiB | 7.27 MiB | 954.02 KiB |
| d089990 | 6.34 MiB | 7.28 MiB | 967.79 KiB |
| 7f75f32 | 6.26 MiB | 7.20 MiB | 959.18 KiB |
| 5e8d2b3 | 6.15 MiB | 7.13 MiB | 1000.11 KiB |
| 55cc6ef | 6.06 MiB | 7.03 MiB | 995.45 KiB |
| 559d28f | 5.94 MiB | 6.92 MiB | 1001.70 KiB |
| d5fb969 | 6.35 MiB | 7.35 MiB | 1021.16 KiB |
| 683fd34 | 6.27 MiB | 7.20 MiB | 960.43 KiB |
Previous results on branch: fix/app-lag-sff
Startup times
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 6ddb24e | 457.34 ms | 496.57 ms | 39.23 ms |
| 45ab9fc | 459.51 ms | 514.98 ms | 55.47 ms |
| b3716ec | 477.39 ms | 558.53 ms | 81.14 ms |
App size
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 6ddb24e | 6.49 MiB | 7.56 MiB | 1.07 MiB |
| 45ab9fc | 6.49 MiB | 7.56 MiB | 1.07 MiB |
| b3716ec | 6.49 MiB | 7.56 MiB | 1.07 MiB |
buenaflor
marked this pull request as ready for review
September 26, 2024 12:07
buenaflor
requested review from
krystofwoldrich,
martinhaintz and
stefanosiano
as code owners
September 26, 2024 12:07
buenaflor
changed the title
brustolin
approved these changes
Sep 26, 2024
brustolin
left a comment
brustolin
left a comment
Contributor
There was a problem hiding this comment.
One suggestion, but not blocking
| /// Maximum number of frames to track at a time before clearing. | ||
| /// Clearing cancels frame tracking for all active spans. | ||
| /// Default is 10800 frames, this equals to 3 minutes of frames at 60fps. | ||
| int maxFramesToTrack = 10800; |
Contributor
There was a problem hiding this comment.
l: I think a duration would be more easy to understand instead of number of frames
Contributor
Author
There was a problem hiding this comment.
the confusing part is that the callback we use from flutter doesn't actually trigger every x fps, it triggers only when new frames are drawn.
If the user doesn't do anything no scrolling etc... after 3 minutes the frames tracked might be 100 or so which doesnt align with a Duration option
Contributor
iOS Performance metrics 🚀
|
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| dd933d4 | 1238.73 ms | 1252.43 ms | 13.70 ms |
| 3e5ee37 | 1248.25 ms | 1265.38 ms | 17.13 ms |
| 6034b0a | 1244.89 ms | 1270.22 ms | 25.33 ms |
| 824df58 | 1235.72 ms | 1259.02 ms | 23.30 ms |
| 3e4b523 | 1260.53 ms | 1270.06 ms | 9.53 ms |
| 33d0587 | 1262.16 ms | 1270.50 ms | 8.34 ms |
| ca7f531 | 1242.51 ms | 1282.61 ms | 40.10 ms |
| a5031f1 | 1244.14 ms | 1268.79 ms | 24.64 ms |
| 9811573 | 1259.78 ms | 1278.33 ms | 18.55 ms |
| aba65ca | 1248.83 ms | 1268.30 ms | 19.46 ms |
App size
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| dd933d4 | 8.33 MiB | 9.64 MiB | 1.31 MiB |
| 3e5ee37 | 8.15 MiB | 9.12 MiB | 986.23 KiB |
| 6034b0a | 8.33 MiB | 9.40 MiB | 1.07 MiB |
| 824df58 | 8.33 MiB | 9.64 MiB | 1.31 MiB |
| 3e4b523 | 8.28 MiB | 9.33 MiB | 1.05 MiB |
| 33d0587 | 8.29 MiB | 9.38 MiB | 1.09 MiB |
| ca7f531 | 8.32 MiB | 9.38 MiB | 1.06 MiB |
| a5031f1 | 8.32 MiB | 9.50 MiB | 1.18 MiB |
| 9811573 | 8.16 MiB | 9.17 MiB | 1.01 MiB |
| aba65ca | 8.38 MiB | 9.73 MiB | 1.35 MiB |
Previous results on branch: fix/app-lag-sff
Startup times
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 45ab9fc | 1237.96 ms | 1267.60 ms | 29.64 ms |
| 6ddb24e | 1251.69 ms | 1272.11 ms | 20.41 ms |
| b3716ec | 1250.29 ms | 1278.38 ms | 28.09 ms |
App size
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 45ab9fc | 8.38 MiB | 9.74 MiB | 1.36 MiB |
| 6ddb24e | 8.38 MiB | 9.74 MiB | 1.36 MiB |
| b3716ec | 8.38 MiB | 9.74 MiB | 1.36 MiB |
stefanosiano
approved these changes
Sep 26, 2024
Contributor
Author
|
we will keep the limit internal for now until we properly fix it. we might not need to keep the references to the normal frames in the future which would not require a frame limit |
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
4 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.
📜 Description
Basically when a long lasting span runs in the background (e.g 20 minutes) without ever finishing, the frame tracking keeps accumulating frames and thus takes a long time to process it.
💡 Motivation and Context
Fixes #2298
💚 How did you test it?
Unit test
📝 Checklist
sendDefaultPiiis enabled🔮 Next steps