From 3429112589aeeadeb0338ba33baba5e53ebdaf73 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Mon, 12 Feb 2024 10:54:32 +0100 Subject: [PATCH 1/2] feat(apple): Add docs for performanceV2 Add documentation for the performanceV2 option. --- .../automatic-instrumentation.mdx | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx b/docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx index 017333cc526b1..f56b9cc4a18e7 100644 --- a/docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx @@ -391,6 +391,22 @@ SentrySDK.reportFullyDisplayed() If the span finishes through the API, its `status` is set to `SpanStatus.OK`. If the span doesn't finish after 30 seconds, it will be finished by the SDK automatically, and its `status` will be set to `SpanStatus.DEADLINE_EXCEEDED`, also its duration will match the same of the `Time to initial display` span and the description will contain `Deadline Exceeded` suffix. If a call to `reportFullyDisplayed()` happens before the view controller appears, the reported time will be shifted to `Time to initial display` measured time. +## Performance V2 + + + +This feature is experimental and may have bugs. + + + +_(New in version 8.18.0)_ + +We are improving the performance offering with the code name Mobile Starfish, which aims to provide better insights into mobile app performance and highlight clear actions to improve app performance for developers. The `performanceV2` option changes the following behavior: + +* The app start duration finishes when the first frame is drawn instead of when the OS posts the `UIWindowDidBecomeVisibleNotification`. + +We aim to include the behavioral changes by default in the next major version. + ## Opt Out You can opt out of all automatic instrumentations using the options: From 094ec2751fc1881bca4194096b2119312114d732 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Tue, 13 Feb 2024 11:11:27 +0100 Subject: [PATCH 2/2] Update docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx Co-authored-by: Liza Mock --- .../instrumentation/automatic-instrumentation.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx b/docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx index f56b9cc4a18e7..ee53e0ea89561 100644 --- a/docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx @@ -401,11 +401,11 @@ This feature is experimental and may have bugs. _(New in version 8.18.0)_ -We are improving the performance offering with the code name Mobile Starfish, which aims to provide better insights into mobile app performance and highlight clear actions to improve app performance for developers. The `performanceV2` option changes the following behavior: +We're working to update our **Performance** product offering in order to be able to provide better insights and highlight specific actions you can take to improve your mobile app's overall performance. The `performanceV2` option changes the following behavior: -* The app start duration finishes when the first frame is drawn instead of when the OS posts the `UIWindowDidBecomeVisibleNotification`. +* The app start duration will now finish when the first frame is drawn instead of when the OS posts the `UIWindowDidBecomeVisibleNotification`. -We aim to include the behavioral changes by default in the next major version. +This change will be the default in the next major version. ## Opt Out