Skip to content

Commit c371429

Browse files
markushikahestcoolguyzone
authored
chore(insights): Update docs for new Mobile Vitals insights module (#12366)
* chore(insights): Update docs for upcoming mobile screens GA * Update links and redirects * Add screenshot for mobile-screens, add frames delay section * Update docs/product/insights/mobile/mobile-screens/screen-loads.mdx Co-authored-by: Karl Heinz Struggl <[email protected]> * Apply suggestions from code review Co-authored-by: Alex Krawiec <[email protected]> * Update index.mdx * Rename Mobile Screens to Mobile Vitals * Fix CI errors * Refine docs based on feedback * Address PR feedback --------- Co-authored-by: Karl Heinz Struggl <[email protected]> Co-authored-by: Alex Krawiec <[email protected]>
1 parent 95ed5f4 commit c371429

33 files changed

+126
-107
lines changed

docs/concepts/search/searchable-properties/events.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -342,13 +342,13 @@ Returns results with a matching maximum value for the field entered.
342342

343343
### `measurements.app_start_cold`
344344

345-
A [cold start](/product/insights/mobile-vitals/#app-start) refers to when the app launches for the first time after a reboot or update. The app is not in memory and no process exists.
345+
A [cold start](/product/insights/mobile/mobile-vitals/app-starts/) refers to when the app launches for the first time after a reboot or update. The app is not in memory and no process exists.
346346

347347
- **Type:** duration
348348

349349
### `measurements.app_start_warm`
350350

351-
A [warm start](/product/insights/mobile-vitals/#app-start) refers to when the app has already launched at least once and is partially in memory. For instance, the user backs out of your app, but then re-launches it. The process may have continued to run, but the app must recreate the activity from scratch.
351+
A [warm start](/product/insights/mobile/mobile-vitals/app-starts/) refers to when the app has already launched at least once and is partially in memory. For instance, the user backs out of your app, but then re-launches it. The process may have continued to run, but the app must recreate the activity from scratch.
352352

353353
- **Type:** duration
354354

@@ -378,7 +378,7 @@ A [warm start](/product/insights/mobile-vitals/#app-start) refers to when the ap
378378

379379
### `measurements.frames_frozen`
380380

381-
[Slow and frozen frames](/product/insights/mobile-vitals/#slow-and-frozen-frames) measure the responsiveness of your app.
381+
[Slow and frozen frames](/product/insights/mobile/mobile-vitals/#slow-and-frozen-frames) measure the responsiveness of your app.
382382

383383
- **Type:** number
384384

@@ -390,7 +390,7 @@ Returns results with a matching rate of frozen frames. That is, `measurements.fr
390390

391391
### `measurements.frames_slow`
392392

393-
[Slow and frozen frames](/product/insights/mobile-vitals/#slow-and-frozen-frames) measure the responsiveness of your app.
393+
[Slow and frozen frames](/product/insights/mobile/mobile-vitals/#slow-and-frozen-frames) measure the responsiveness of your app.
394394

395395
- **Type:** number
396396

docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ You can opt out of Activity Instrumentation and App Start Instrumentation using
147147
</application>
148148
```
149149

150-
Cold and warm start are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile-vitals).
150+
Cold and warm start are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile/mobile-vitals).
151151

152152
### Slow and Frozen Frames
153153

@@ -159,7 +159,7 @@ Supported on Android OS version `7.0` and above.
159159

160160
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 [Activity](/platforms/android/tracing/instrumentation/automatic-instrumentation/#activity-instrumentation) transactions.
161161

162-
Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile-vitals).
162+
Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile/mobile-vitals).
163163

164164
### Trace Propagation Targets
165165

docs/platforms/android/tracing/instrumentation/perf-v2.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Supported in Sentry's Android SDK version `7.4.0` and above.
1111

1212
</Alert>
1313

14-
Performance V2 is a set of features which enrich your existing instrumentation, giving you more insights into potential performance bottlenecks. These features tightly integrate with [Mobile Vitals](/product/insights/mobile-vitals/).
14+
Performance V2 is a set of features which enrich your existing instrumentation, giving you more insights into potential performance bottlenecks. These features tightly integrate with the [Mobile Vitals](/product/insights/mobile/mobile-vitals/) insights module.
1515

1616
### Enabling Performance V2
1717

docs/platforms/apple/common/features/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The SDK builds a crash report that persists to disk. While it attempts to send t
3838
- Rendering of UIViewControllers
3939
- Performance of HTTP requests
4040
- Distributed tracing
41-
- <Link to="/product/insights/mobile-vitals">Mobile Vitals</Link>
41+
- <Link to="/product/insights/mobile/mobile-vitals">Insights for Mobile Vitals</Link>
4242
- Cold and warm start
4343
- Slow and frozen frames
4444
- <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#prewarmed-app-start-tracing">Prewarmed App Start Tracing</PlatformLink>

docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Before [sentry-cocoa 8.18.0](https://github.com/getsentry/sentry-cocoa/releases/
123123
- **UIKit and Application Init**: from pre main initializers to [`didFinishLaunchingNotification`][didfinishlaunching].
124124
- **Initial Frame Render**: from the [`didFinishLaunchingNotification`][didfinishlaunching] to [`UIWindowDidBecomeVisibleNotification`][uiwindow].
125125
126-
Cold and warm start are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile-vitals).
126+
Cold and warm start are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile/mobile-vitals).
127127
128128
### Prewarmed App Start Tracing
129129
@@ -170,7 +170,7 @@ The detail view of the transaction displays the slow, frozen, and total frames:
170170
171171
![Slow and Frozen Frames](./img/slow-frozen-frames.png)
172172
173-
Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile-vitals).
173+
Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile/mobile-vitals).
174174
175175
## Network Tracking
176176

docs/platforms/flutter/tracing/instrumentation/automatic-instrumentation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Learn more in our [App Start Instrumentation](/platforms/flutter/integrations/ap
4545

4646
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.
4747

48-
Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile-vitals).
48+
Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile/mobile-vitals).
4949

5050
Learn more how to set it up in our [Slow and Frozen Frames Instrumentation](/platforms/flutter/integrations/slow-and-frozen-frames-instrumentation/) docs.
5151

docs/platforms/react-native/tracing/instrumentation/automatic-instrumentation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ If you don't [wrap your root component with Sentry](#wrap-your-root-component),
5353

5454
The SDK differentiates between a cold and a warm start, but doesn't track hot starts or resumes. The measurements are available under `measurements.app_start_warm` and `measurements.app_start_cold`.
5555

56-
Cold and warm start are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile-vitals).
56+
Cold and warm start are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile/mobile-vitals).
5757

5858
### Slow and Frozen Frames
5959

6060
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.
6161

62-
Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile-vitals).
62+
Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/insights/mobile/mobile-vitals).
6363

6464
<Alert>
6565

docs/platforms/react-native/tracing/instrumentation/time-to-display.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sdk: sentry.javascript.react-native
66
description: "Learn how to measure time to display with the Sentry React Native SDK."
77
---
88

9-
Sentry's React Native SDK package ships with a tracing feature that allows you to measure your application's [Time to Display](/product/insights/mobile-vitals/#time-to-initial-display-and-time-to-full-display). This guide will show you how to use Sentry's React Native SDK to measure Time to Display in your application.
9+
Sentry's React Native SDK package ships with a tracing feature that allows you to measure your application's [Time to Display](/product/insights/mobile/mobile-vitals/#time-to-initial-display-and-time-to-full-display). This guide will show you how to use Sentry's React Native SDK to measure Time to Display in your application.
1010

1111
Time to Display consists of two parts, Time To Initial Display (TTID) and Time To Full Display (TTFD). TTID measures the time it takes to display the first frame, while TTFD measures the time it takes to display the full content for the user to interact with.
1212

docs/product/explore/profiling/mobile-app-profiling/metrics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The amount of heap memory used by the application is recorded every 100 ms using
1616

1717
## GPU Information
1818

19-
In addition to counting the number of [slow and frozen UI frame renders](/product/insights/mobile-vitals/#slow-and-frozen-frames) for Mobile Vitals, Sentry now records the timestamp for every frame and overlays it on top of profiling flame charts:
19+
In addition to counting the number of [slow and frozen UI frame renders](/product/insights/mobile/mobile-vitals/#slow-and-frozen-frames) for Mobile Vitals Insights, Sentry now records the timestamp for every frame and overlays it on top of profiling flame charts:
2020

2121
![Sentry displays slow and frozen frames above the flamechart of a particular profile.](./img/flamechart-with-gpu-overlay.png)
2222

Loading

0 commit comments

Comments
 (0)