Skip to content

Commit b231d74

Browse files
chore(App Starts): Add info why Sentry app starts can be longer (#13269)
* add info why Sentry app starts can be longer * update flutter * Apply suggestions from code review --------- Co-authored-by: Krystof Woldrich <[email protected]>
1 parent 949763e commit b231d74

File tree

5 files changed

+31
-2
lines changed

5 files changed

+31
-2
lines changed

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,17 @@ The App Start Instrumentation provides insight into how long your application ta
126126

127127
The SDK differentiates between a cold and a warm start, but doesn't track hot starts/resumes.
128128

129-
- **Cold start**: A cold start refers to an apps starting from scratch: the systems process has not, until this start, created the apps process. Cold starts happen in cases such as your apps being launched for the first time since the device booted, or since the system killed the app.
129+
- **Cold start**: A cold start refers to an app's starting from scratch: the system's process has not, until this start, created the app's process. Cold starts happen in cases such as your app's being launched for the first time since the device booted, or since the system killed the app.
130130
- **Warm start**: A warm start encompasses some subset of the operations that take place during a cold start; at the same time, it represents more overhead than a hot start. For instance: The system evicts your app from memory, and then the user re-launches it. The process and the activity need to be restarted, but the task can benefit somewhat from the saved instance state bundle passed into `onCreate()`.
131131

132+
<Alert>
133+
134+
Sentry's App Start instrumentation aims to be as comprehensive and representative of the user experience as possible, and adheres to guidelines by the platform vendors. For this reason, App Starts reported by Sentry might be longer than what you see in other tools.
135+
136+
For example, Sentry measures the duration from process start, including the time it takes for all Content Providers to complete, until the first frame is rendered to the user.
137+
138+
</Alert>
139+
132140
The SDK sets the Span operation to `app.start.cold` for _Cold start_ and `app.start.warm` for _Warm start_.
133141

134142
The SDK uses the `SentryPerformanceProvider` (ContentProvider) creation time as the beginning of the app start and the first frame drawn as the end.

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,14 @@ The SDK differentiates between a cold and a warm start, but doesn't track hot st
103103
- **Cold start**: App launched for the first time, after a reboot or update. The app is not in memory and no process exists.
104104
- **Warm start**: App launched at least once, is partially in memory, and no process exists.
105105
106+
<Alert>
107+
108+
Sentry's App Start instrumentation aims to be as comprehensive and representative of the user experience as possible, and adheres to guidelines by the platform vendors. For this reason, App Starts reported by Sentry might be longer than what you see in other tools.
109+
110+
For example, Sentry measures the duration from process start, including the time before before runtime initialization and before the first application object is loaded, until the first frame is rendered to the user.
111+
112+
</Alert>
113+
106114
Since [sentry-cocoa 8.18.0](https://github.com/getsentry/sentry-cocoa/releases/tag/8.18.0) the SDK creates the following app start spans:
107115
108116
- **Pre Runtime Init**: from the process start time to the runtime init.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ The SDK differentiates between a cold and a warm start, but doesn't track hot st
5555

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

58+
<Alert>
59+
60+
Sentry's App Start instrumentation aims to be as comprehensive and representative of the user experience as possible, and adheres to guidelines by the platform vendors. For this reason, App Starts reported by Sentry might be longer than what you see in other tools. Read more on the [Apple App Start docs](/platforms/apple/guides/ios/tracing/instrumentation/automatic-instrumentation/#app-start-tracing) and [Android App Start docs](/platforms/android/tracing/instrumentation/automatic-instrumentation/#app-start-instrumentation).
61+
62+
</Alert>
63+
5864
### Slow and Frozen Frames
5965

6066
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.

docs/product/insights/mobile/mobile-vitals/index.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ The definitions of cold start and warm start change slightly depending on the op
1919
- [Flutter](/platforms/dart/guides/flutter/tracing/instrumentation/automatic-instrumentation/#app-start-instrumentation)
2020
- [React Native](/platforms/react-native/tracing/instrumentation/automatic-instrumentation/#app-start-instrumentation)
2121

22+
<Alert>
23+
24+
Sentry's App Start instrumentation aims to be as comprehensive and representative of the user experience as possible, and adheres to guidelines by the platform vendors. For this reason, App Starts reported by Sentry might be longer than what you see in other tools. Read more on the [Apple App Start docs](/platforms/apple/guides/ios/tracing/instrumentation/automatic-instrumentation/#app-start-tracing) and [Android App Start docs](/platforms/android/tracing/instrumentation/automatic-instrumentation/#app-start-instrumentation).
25+
26+
27+
</Alert>
28+
2229
In the example below, the detail view of a transaction displays the warm start measurement in the right sidebar.
2330

2431
![The event detail of a transaction with a warm start measurement.](./img/app-start-transaction.png)

includes/dart-integrations/app-start-instrumentation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ When the SDK receives the start and end times of the app launch, the SDK:
3131

3232
<Alert>
3333

34-
While the SDK differentiates between cold and warm starts, it doesn't track hot starts/resumes.
34+
Sentry's App Start instrumentation aims to be as comprehensive and representative of the user experience as possible, and adheres to guidelines by the platform vendors. For this reason, App Starts reported by Sentry might be longer than what you see in other tools.
3535

3636
</Alert>
3737

0 commit comments

Comments
 (0)