Skip to content

Commit f1de76c

Browse files
feat(apple): Add troubleshooting page (#5288)
* feat(apple): Add troubleshooting page Move notes on upgrading to a SDK version to fix critical bugs to a newly added troubleshooting page. * Update src/platforms/apple/troubleshooting.mdx Co-authored-by: Bruno Garcia <[email protected]> Co-authored-by: Bruno Garcia <[email protected]>
1 parent 1b656f4 commit f1de76c

File tree

3 files changed

+21
-18
lines changed

3 files changed

+21
-18
lines changed

src/platforms/apple/common/configuration/out-of-memory.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@ sidebar_order: 10
44
description: "Learn how to turn off Out Of Memory"
55
---
66

7-
<Alert level="info" title="Important">
8-
9-
We recommend updating to at least [7.11.0](https://github.com/getsentry/sentry-cocoa/releases/tag/7.11.0), because the SDK might falsely report out-of-memory crashes when an app hangs, and the user kills it manually.
10-
11-
</Alert>
12-
137
This integration tracks out-of-memory (OOM) crashes based on heuristics. This feature is available for iOS, tvOS, and Mac Catalyst, works only if the application was in the foreground, and doesn't track OOMs for unit tests.
148

159
When a typical unhandled error occurs, the Apple SDK writes a report to disk with the current state of your application, with details like the stack trace, tags, breadcrumbs, and so on, before the app terminates. With OOM crashes, the operating system can kill your app without further notice, which means the SDK can't write a report to disk.

src/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,6 @@ This feature is available for iOS, tvOS, and Mac Catalyst.
5050
The App Start Instrumentation provides insight into how long your application takes to launch. It adds spans for different phases, from the application launch to the first auto-generated UI transaction.
5151
To enable this feature, enable `AutoUIPerformanceTracking`.
5252
53-
<Alert level="info" title="Important">
54-
55-
Starting with iOS 15, the system might [pre-warm](https://developer.apple.com/documentation/uikit/app_and_environment/responding_to_the_launch_of_your_app/about_the_app_launch_sequence#3894431) your app by creating the process before the user opens it. In such cases, we can't reliably measure the app start, so we drop it as of [sentry-cocoa 7.18.0](https://github.com/getsentry/sentry-cocoa/releases/tag/7.18.0). We are working on a fix for this. Follow the [GitHub issue](https://github.com/getsentry/sentry-cocoa/issues/1897) for more details.
56-
57-
</Alert>
58-
5953
The SDK differentiates between a cold and a warm start, but doesn't track hot starts/resumes.
6054
6155
* __Cold start__: App launched for the first time, after a reboot or update. The app is not in memory and no process exists.
@@ -72,12 +66,6 @@ Cold and warm start are Mobile Vitals, which you can learn about in the [full do
7266
7367
## Slow and Frozen Frames
7468
75-
<Alert level="info" title="Important">
76-
77-
We recommend updating to at least [7.18.1](https://github.com/getsentry/sentry-cocoa/releases/tag/7.18.1), or else the SDK might report too high a percentage of slow frames.
78-
79-
</Alert>
80-
8169
This feature is available for iOS, tvOS, and Mac Catalyst.
8270
8371
Unresponsive UI and animation hitches annoy users and degrade the user experience. Two measurements to track these types of experiences are *slow frames* and *frozen frames*. If you want your app to run smoothly, you should try to avoid both. The SDK adds these two measurements for the transactions you capture.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Troubleshooting
3+
description: "Troubleshoot and resolve common issues with the Cocoa SDK."
4+
sidebar_order: 2000
5+
---
6+
7+
## Wrong App Start Data
8+
9+
Starting with iOS 15, the system might [pre-warm](https://developer.apple.com/documentation/uikit/app_and_environment/responding_to_the_launch_of_your_app/about_the_app_launch_sequence#3894431) your app by creating the process before the user opens it. In such cases, we can't reliably measure the app start, so we drop it as of [sentry-cocoa 7.18.0](https://github.com/getsentry/sentry-cocoa/releases/tag/7.18.0). We are working on a fix for this. Follow the [GitHub issue](https://github.com/getsentry/sentry-cocoa/issues/1897) for more details.
10+
11+
## High Slow and Frozen Frames Rate
12+
13+
We recommend updating to at least [7.18.1](https://github.com/getsentry/sentry-cocoa/releases/tag/7.18.1), or else the SDK might report too high a percentage of slow frames.
14+
15+
## Falsely Reported Out Of Memory Crashes
16+
17+
We recommend updating to at least [7.11.0](https://github.com/getsentry/sentry-cocoa/releases/tag/7.11.0), because before this version the SDK might falsely report out-of-memory crashes when an app hangs, and the user kills it manually.
18+
19+
## Crashes with HTTP Auto Performance Instrumentation
20+
21+
We recommend updating to at least [7.5.3](https://github.com/getsentry/sentry-cocoa/releases/tag/7.5.3), because the HTTP instrumentation can lead to crashes. Alternatively, you can also <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#http-instrumentation">disable the feature</PlatformLink>.

0 commit comments

Comments
 (0)