Skip to content

Commit 9d56232

Browse files
authored
docs: call out beta status for all public-facing profiling APIs (#2804)
1 parent 9e96fd6 commit 9d56232

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

Sources/Sentry/Public/SentryOptions.h

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ NS_SWIFT_NAME(Options)
160160
@property (nonatomic, assign) BOOL attachStacktrace;
161161

162162
/**
163-
* Attention: This is an experimental feature. Turning this feature on can have an impact on
164-
* the grouping of your issues.
163+
* @warning This is an experimental feature and may still have bugs. Turning this feature on can
164+
* have an impact on the grouping of your issues.
165165
*
166166
* When enabled, the SDK stitches stack traces of asynchronous code together.
167167
*
@@ -213,7 +213,7 @@ NS_SWIFT_NAME(Options)
213213
@property (nonatomic, assign) BOOL attachScreenshot;
214214

215215
/**
216-
* This feature is EXPERIMENTAL.
216+
* @warning This is an experimental feature and may still have bugs.
217217
*
218218
* Automatically attaches a textual representation of the view hierarchy when capturing an error
219219
* event.
@@ -235,7 +235,7 @@ NS_SWIFT_NAME(Options)
235235
@property (nonatomic, assign) NSTimeInterval idleTimeout;
236236

237237
/**
238-
* This feature is EXPERIMENTAL.
238+
* @warning This is an experimental feature and may still have bugs.
239239
*
240240
* Report pre-warmed app starts by dropping the first app start spans if pre-warming paused during
241241
* these steps. This approach will shorten the app start duration, but it represents the duration a
@@ -349,7 +349,8 @@ NS_SWIFT_NAME(Options)
349349

350350
#if SENTRY_TARGET_PROFILING_SUPPORTED
351351
/**
352-
* This feature is experimental. Profiling is not supported on watchOS or tvOS.
352+
* @warning This is a beta feature and may still have bugs.
353+
* @note Profiling is not supported on watchOS or tvOS.
353354
*
354355
* Indicates the percentage profiles being sampled out of the sampled transactions.
355356
*
@@ -363,7 +364,8 @@ NS_SWIFT_NAME(Options)
363364
@property (nullable, nonatomic, strong) NSNumber *profilesSampleRate;
364365

365366
/**
366-
* This feature is experimental. Profiling is not supported on watchOS or tvOS.
367+
* @warning This is a beta feature and may still have bugs.
368+
* @note Profiling is not supported on watchOS or tvOS.
367369
*
368370
* A callback to a user defined profiles sampler function. This is similar to setting
369371
* `profilesSampleRate`, but instead of a static value, the callback function will be called to
@@ -372,6 +374,9 @@ NS_SWIFT_NAME(Options)
372374
@property (nullable, nonatomic) SentryTracesSamplerCallback profilesSampler;
373375

374376
/**
377+
* @warning This is a beta feature and may still have bugs.
378+
* @note Profiling is not supported on watchOS or tvOS.
379+
*
375380
* If profiling should be enabled or not. Returns YES if either a profilesSampleRate > 0 and
376381
* <=1 or a profilesSampler is set otherwise NO.
377382
*/
@@ -380,11 +385,12 @@ NS_SWIFT_NAME(Options)
380385
/**
381386
* DEPRECATED: Use `profilesSampleRate` instead. Setting `enableProfiling` to YES is the equivalent
382387
* of setting `profilesSampleRate` to `1.0`. If `profilesSampleRate` is set, it will take precedence
388+
* @warning This is a beta feature and may still have bugs.
389+
* @note Profiling is not supported on watchOS or tvOS.
390+
*
383391
* over this setting.
384392
*
385393
* Whether to enable the sampling profiler. Default is NO.
386-
* @note This is a beta feature that is currently not available to all Sentry customers. This
387-
* feature is not supported on watchOS or tvOS.
388394
*/
389395
@property (nonatomic, assign) BOOL enableProfiling DEPRECATED_MSG_ATTRIBUTE(
390396
"Use profilesSampleRate or profilesSampler instead. This property will be removed in a future "
@@ -460,7 +466,7 @@ NS_SWIFT_NAME(Options)
460466
#if SENTRY_HAS_METRIC_KIT
461467

462468
/**
463-
* ATTENTION: This is an experimental feature.
469+
* @warning This is an experimental feature and may still have bugs.
464470
*
465471
* This feature is disabled by default. When enabled, the SDK sends
466472
* ``MXDiskWriteExceptionDiagnostic``, ``MXCPUExceptionDiagnostic`` and ``MXHangDiagnostic`` to

Sources/SentrySwiftUI/SentryTracedView.swift

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ import SwiftUI
55
import SentryInternal
66
#endif
77

8-
///
9-
/// This feature is EXPERIMENTAL.
8+
/// - warning: This is an experimental feature and may still have bugs.
109
///
1110
/// A control to measure the performance of your views and send the result as a transaction to Sentry.io.
1211
///
@@ -93,11 +92,9 @@ public struct SentryTracedView<Content: View>: View {
9392
}
9493
}
9594

96-
///
97-
/// This feature is EXPERIMENTAL.
98-
///
9995
@available(iOS 13, macOS 10.15, tvOS 13, watchOS 6.0, *)
10096
public extension View {
97+
/// - warning: This is an experimental feature and may still have bugs.
10198
func sentryTrace(_ viewName: String? = nil) -> some View {
10299
return SentryTracedView(viewName) {
103100
return self

0 commit comments

Comments
 (0)