Skip to content

docs(apple): Add maxFeatureFlags option #19224

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

Open
itaybre wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(apple): Add maxFeatureFlags option #19224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions docs/platforms/apple/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,16 @@ The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/enve

</SdkOption>

<SdkOption name="maxFeatureFlags" type="int" defaultValue="100">

The maximum number of unique feature flag evaluations to keep in memory on the scope. Events record the most recent, unique feature flag evaluations. When the limit is exceeded, the SDK drops the oldest evaluations. Increase this if your app evaluates a large number of flags and you want more of them attached to your events. Set it to `0` to stop recording feature flag evaluations on the scope.

This option does not affect span-level feature flag tracking, which independently records up to 10 evaluations per span.

Learn more in the <PlatformLink to="/feature-flags/">Feature Flags</PlatformLink> documentation.

</SdkOption>

<SdkOption name="attachStacktrace" type="bool" defaultValue="true">

When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.
Expand Down
2 changes: 1 addition & 1 deletion platform-includes/feature-flags/evaluation-tracking-index/apple.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ SentrySDK.configureScope { scope in

`clearFeatureFlags()` removes evaluations from the current scope. It doesn't remove evaluations already recorded on an active span or transaction.

Scope evaluations are attached to error and message events. The current scope keeps the latest evaluation for up to 100 flag names. Re-evaluating a flag updates its stored value and makes it the most recent evaluation.
Scope evaluations are attached to error and message events. The current scope keeps the latest evaluation for up to <PlatformLink to="/configuration/options/#maxFeatureFlags">`maxFeatureFlags`</PlatformLink> flag names (default 100). Re-evaluating a flag updates its stored value and makes it the most recent evaluation.

Active spans and transactions record evaluations for up to 10 flag names as span attributes using the `flag.evaluation.<name>` key. Re-evaluating a recorded flag updates its value. After 10 flag names are recorded, evaluations for new flag names are ignored. Spans don't inherit evaluations from their parent span.
Loading