Skip to content

Commit 86cbf85

Browse files
committed
pr feedback
1 parent d0f0956 commit 86cbf85

File tree

1 file changed

+4
-4
lines changed
  • docs/platforms/apple/common/profiling

1 file changed

+4
-4
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Set Up Profiling
3-
description: "Learn how to enable profiling in your app if it is not already set up."
3+
description: "Learn how to enable profiling in your app."
44
sidebar_order: 5000
55
supported:
66
- apple
@@ -53,7 +53,7 @@ See the subsections below to learn about the various ways the profiler can be st
5353
5454
### Manual Lifecycle
5555
56-
By default, the profiler can only be started and stopped manually with calls to `SentrySDK.startProfiler` and `SentrySDK.stopProfiler`. All code that executes on all threads in between those calls will be recorded. The configurations shown above demonstrate configuring manual profiling mode.
56+
By default, the profiler can only be started and stopped manually with calls to `SentrySDK.startProfiler` and `SentrySDK.stopProfiler`. All code that executes on all threads in between those calls will be recorded. The snippets above demonstrate configuring manual profiling mode.
5757
5858
For example, if you wanted to profile everything that happens after starting a network request, and then update a table view with the contents of the response, you could do it like this (assuming you've already started the Sentry SDK with the options shown above):
5959
@@ -115,7 +115,7 @@ SentrySDK.start { options in
115115
116116
<Alert>
117117
118-
The `sessionSampleRate` for profiles is undersampled with respect to the `tracesSampleRate`.
118+
The `sessionSampleRate` for profiles is _relative_ to the `tracesSampleRate`: if `tracesSampleRate` and `sessionSampleRate` are both `0.5`, then on average 25% of attempts to start the profiler will result in actual data collection.
119119
120120
</Alert>
121121
@@ -125,7 +125,7 @@ Check out the <PlatformLink to="/tracing/">tracing setup documentation</Platform
125125
126126
If configured with manual lifecycle, a profile starts on the next app launch, and continues until you call `SentrySDK.stopProfiler`.
127127
128-
If configured with trace lifecycle, app start profiles are attached to a special performance transaction operation called `app.launch` and displayed in the product as `launch`. It is stopped either when `SentrySDK.startWithOptions` is called, or, if <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#time-to-initial-display">TTID</PlatformLink>/<PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#time-to-full-display">TTFD</PlatformLink> tracking is enabled, when the SDK determines that TTID/TTFD has been reached.
128+
If configured with trace lifecycle, app start profiles are attached to a special performance transaction operation called `app.launch` and displayed in the product as `launch`. It is stopped either when `SentrySDK.startWithOptions` is called, or, if <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#time-to-initial-display">Time to Initial Display (TTID)</PlatformLink>/<PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#time-to-full-display">Time to Full Display (TTFD)</PlatformLink> tracking is enabled, when the SDK determines that TTID/TTFD has been reached.
129129
130130
Every time `SentrySDK.startWithOptions` is called with app start profiling configured, a separate sample decision is generated with `sessionSampleRate` and stored until the next app launch (as well as `tracesSampleRate` if trace profile lifecycle is configured). The same sample decision will apply for the remainder of the profile session following that subsequent launch.
131131

0 commit comments

Comments
 (0)