diff --git a/docs/platforms/apple/common/features/experimental-features.mdx b/docs/platforms/apple/common/features/experimental-features.mdx index c66608064fe5d..6ee713e6dac55 100644 --- a/docs/platforms/apple/common/features/experimental-features.mdx +++ b/docs/platforms/apple/common/features/experimental-features.mdx @@ -9,6 +9,7 @@ Do you want to try some new experimental features? On the latest version of the - Enable Time to Full Display (TTFD) to gain insight into how long it takes your view controller to launch and load all of its content. - Enable App Launch Profiling to get detailed profiles for your app launches. +- Enable Continuous Profiling to get full coverage of your app's execution. - If you use Swift concurrency, stitch together stack traces of your async code with the `swiftAsyncStacktraces` option. Note that you can enable this in your Objective-C project, but only async code written in Swift will be stitched together. @@ -27,6 +28,7 @@ SentrySDK.start { options in options.enableTimeToFullDisplayTracing = true options.enableAppLaunchProfiling = true options.swiftAsyncStacktraces = true + options.profilesSampleRate = nil // enable continuous profiling mode } ``` @@ -40,6 +42,7 @@ SentrySDK.start { options in options.enableTimeToFullDisplayTracing = YES; options.enableAppLaunchProfiling = YES; options.swiftAsyncStacktraces = YES; // only applies to async code in Swift + options.profilesSampleRate = nil; // enable continuous profiling mode }]; ``` diff --git a/docs/platforms/apple/common/profiling/index.mdx b/docs/platforms/apple/common/profiling/index.mdx index be58fe0d9ce2b..eadd657f5c429 100644 --- a/docs/platforms/apple/common/profiling/index.mdx +++ b/docs/platforms/apple/common/profiling/index.mdx @@ -98,3 +98,23 @@ To set up launch profiling, use the `enableAppLaunchProfiling` option and config If you use `SentryOptions.tracesSampler` or `SentryOptions.profilesSampler`, it will be invoked after you call `SentrySDK.startWithOptions`, with `SentryTransactionContext.forNextAppLaunch` set to `true` indicating that it's evaluating a launch profile sampling decision. If instead you simply set `SentryOptions.tracesSampleRate` and `SentryOptions.profilesSampleRate`, those numerical rates will be used directly. Currently, launch profiles are attached to a special performance transaction operation called `app.launch` and displayed in the product simply as `launch`. + +## Continuous Profiling + + + +This feature is experimental and may have bugs. + + + +_(New in version 8.36.0)_ + +The current profiling implementation stops the profiler automatically after 30 seconds (unless you manually stop it earlier). Naturally, this limitation makes it difficult to get full coverage of your app's execution. We now offer an experimental continuous mode, where profiling data is periodically uploaded while running, with no limit to how long the profiler may run. + +Previously, profiles only ran in tandem with performance transactions that were started either automatically or manually with `SentrySDK.startTransaction`. Now, you can start and stop the profiler directly with `SentrySDK.startProfiler` and `SentrySDK.stopProfiler`. You can also start a profile at app launch by setting `SentryOptions.enableAppLaunchProfiling = true` in your call to `SentrySDK.startWithOptions`. + +Continuous profiling mode is enabled by default, requiring no changes to `SentryOptions` when you start the SDK to opt in. If you had previously set `SentryOptions.profilesSampleRate` or `SentryOptions.profilesSampler` to use transaction-based profiling, then remove those lines of code from your configuration. + +These new APIs do not offer any sampling functionality—every call to start the profiler will start it, and the same goes for launch profiles if you've configured that. If you are interested in reducing the amount of profiles that run, you must take care to do it at the callsites. + +Continuous profiling has implications for your org's billing structure. This feature is only available for subscription plans that enrolled after June 5, 2024.