Skip to content

Commit c9e1888

Browse files
romtsncursoragent
andauthored
feat(apple): Add iOS App Hang rate docs (#14944)
## DESCRIBE YOUR PR This PR adds a new "App Hang Rate" section to the iOS App Hangs documentation (`platforms/apple/configuration/app-hangs/`). It clarifies the definition of App Hang Rate for Apple platforms, emphasizing that the rate is calculated *only* for **Fatal App Hangs**. The new section also explains how to view this metric in Sentry and distinguishes between fatal and non-fatal app hangs in the context of rate calculation. Closes #14815 ## 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: - [x] None: Not urgent, can wait up to 1 week+ --- [Slack Thread](https://sentry.slack.com/archives/CP4UUUF1S/p1756982745568359?thread_ts=1756982745.568359&cid=CP4UUUF1S) <a href="https://cursor.com/background-agent?bcId=bc-314450e0-9932-49bb-86ac-95d4eca5941c"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-cursor-dark.svg"> <source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-cursor-light.svg"> <img alt="Open in Cursor" src="https://cursor.com/open-in-cursor.svg"> </picture> </a> <a href="https://cursor.com/agents?id=bc-314450e0-9932-49bb-86ac-95d4eca5941c"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-web-dark.svg"> <source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-web-light.svg"> <img alt="Open in Web" src="https://cursor.com/open-in-web.svg"> </picture> </a> --------- Co-authored-by: Cursor Agent <[email protected]>
1 parent d9a829d commit c9e1888

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

docs/platforms/apple/common/configuration/app-hangs.mdx

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,3 +184,48 @@ SentrySDK.start { options in
184184
options.enableReportNonFullyBlockingAppHangs = NO;
185185
}];
186186
```
187+
188+
## App Hang Rate
189+
190+
<Alert level="info">
191+
192+
The SDK supports App Hang Rate calculation starting with version 8.50.0. Additionally, you have to enable App Hangs V2 via `options.enableAppHangTrackingV2 = true` in your SDK configuration.
193+
194+
</Alert>
195+
196+
App hangs occur when the main UI thread of an application becomes unresponsive. When configured, Sentry's Apple SDK reports app hang events, and Sentry calculates an App Hang Rate based on these events and user sessions.
197+
198+
App Hang Rate is the percentage of unique users who have experienced a **Fatal App Hang** during the specified time period.
199+
200+
<Alert level="info">
201+
202+
The App Hang Rate in Sentry only accounts for **Fatal App Hangs** - app hangs that lead to your app being terminated, either by the user or the OS watchdog. Non-fatal app hangs are captured as events but do not contribute to the App Hang Rate calculation.
203+
204+
</Alert>
205+
206+
### Fatal App Hangs
207+
208+
Fatal app hangs are the most critical type of app hang because they result in app termination and directly impact user experience. These occur when:
209+
210+
- The user manually force-quits the app during a hang
211+
- The system watchdog terminates the app due to unresponsiveness
212+
213+
Fatal app hangs are distinguished by their `exception.type`:
214+
215+
- `Fatal App Hang Fully Blocked`: A completely blocking app hang that leads to termination
216+
- `Fatal App Hang Non Fully Blocked`: A partially blocking app hang that leads to termination
217+
218+
### Viewing Your App Hang Rate
219+
220+
To see your App Hang Rate in Sentry:
221+
222+
1. Go to the **Projects** page
223+
2. Click on your Apple project
224+
3. Look for the "App Hang Rate" card in the "Project Details" section
225+
4. Click "View Issues" to see a list of app hang issues that were created in the selected timeframe and environment
226+
227+
The App Hang Rate card displays the percentage of users affected by fatal app hangs, helping you understand the impact on your user base and prioritize performance improvements.
228+
229+
![App Hang Rate](./img/app-hang-rate.png)
230+
231+
Since App Hang Rate only includes fatal app hangs, it represents the most severe hangs that directly affect user retention and app store ratings.
112 KB
Loading

0 commit comments

Comments
 (0)