Skip to content

docs: call out beta status for all public-facing profiling APIs #2804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
armcknight merged 2 commits into from
Mar 23, 2023
Merged

docs: call out beta status for all public-facing profiling APIs #2804

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5a938a
docs: call out beta status for all public-facing profiling APIs
armcknight Mar 16, 2023
ccf9ea3
standardize headerdoc warnings for beta/experimental features
armcknight Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions Sources/Sentry/Public/SentryOptions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,9 @@ NS_SWIFT_NAME(Options)
* This property is dependent on `tracesSampleRate` -- if `tracesSampleRate` is 0 (default),
* no profiles will be collected no matter what this property is set to. This property is
* used to undersample profiles *relative to* `tracesSampleRate`.
*
* @Note This feature is not supported on watchOS or tvOS.
* @warning This is a beta feature and may still have bugs.
*/
@property (nullable, nonatomic, strong) NSNumber *profilesSampleRate;

Expand All @@ -368,12 +371,18 @@ NS_SWIFT_NAME(Options)
* A callback to a user defined profiles sampler function. This is similar to setting
* `profilesSampleRate`, but instead of a static value, the callback function will be called to
* determine the sample rate.
*
* @Note This feature is not supported on watchOS or tvOS.
* @warning This is a beta feature and may still have bugs.
*/
@property (nullable, nonatomic) SentryTracesSamplerCallback profilesSampler;

/**
* If profiling should be enabled or not. Returns YES if either a profilesSampleRate > 0 and
* <=1 or a profilesSampler is set otherwise NO.
*
* @Note This feature is not supported on watchOS or tvOS.
* @warning This is a beta feature and may still have bugs.
*/
@property (nonatomic, assign, readonly) BOOL isProfilingEnabled;

Expand All @@ -383,8 +392,9 @@ NS_SWIFT_NAME(Options)
* over this setting.
*
* Whether to enable the sampling profiler. Default is NO.
* @note This is a beta feature that is currently not available to all Sentry customers. This
* feature is not supported on watchOS or tvOS.
*
* @Note This feature is not supported on watchOS or tvOS.
* @warning This is a beta feature and may still have bugs.
*/
@property (nonatomic, assign) BOOL enableProfiling DEPRECATED_MSG_ATTRIBUTE(
"Use profilesSampleRate or profilesSampler instead. This property will be removed in a future "
Expand Down