docs(feature-flags): Document Apple, Java, and Android APIs#18755
Open
denrase wants to merge 2 commits into
Open
docs(feature-flags): Document Apple, Java, and Android APIs#18755denrase wants to merge 2 commits into
denrase wants to merge 2 commits into
Conversation
Add feature flag evaluation tracking documentation for the Apple SDK and expand the Java and Android guides. The guides cover the generic API, custom scopes and hubs, scope callbacks, clearing evaluations, span attributes, retention limits, and scope isolation. They also document minimum SDK versions and link all supported platforms from the product documentation.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds/expands Feature Flag evaluation tracking documentation for Apple, Java, and Android SDKs, and updates the product “Issue Details > Feature Flags” page to link to all supported platform guides.
Changes:
- Expand Java + Android evaluation-tracking includes with guidance for custom
IScopes, scope callbacks, and clearing evaluations, plus documented retention/attachment behavior. - Add new Apple evaluation-tracking include and a new Apple “Set Up Feature Flags” platform page, and surface Feature Flags in the Apple “Features” list.
- Update the product feature flags docs to link to additional platform setup pages and reformat the change-tracking include for consistency.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| platform-includes/feature-flags/evaluation-tracking-index/java.mdx | Expands Java evaluation-tracking docs (generic API + scopes/callbacks/clearing + limits). |
| platform-includes/feature-flags/evaluation-tracking-index/android.mdx | Mirrors the Java expansion for Android evaluation-tracking docs. |
| platform-includes/feature-flags/evaluation-tracking-index/apple.mdx | Introduces Apple evaluation-tracking API docs (Swift + ObjC). |
| docs/product/issues/issue-details/feature-flags/index.mdx | Adds platform setup links (Android/Apple/etc.) and formats change-tracking include. |
| docs/platforms/java/common/feature-flags/index.mdx | Adds minimum Java SDK version prerequisite and trims trailing whitespace. |
| docs/platforms/android/feature-flags/index.mdx | Adds minimum Android SDK version prerequisite and trims trailing whitespace. |
| docs/platforms/apple/common/features/index.mdx | Adds Feature Flags to the Apple “Features” list. |
| docs/platforms/apple/common/feature-flags/index.mdx | New Apple Feature Flags setup page (prereqs + evaluation/change tracking includes). |
Comment on lines
+84
to
+86
| Scope evaluations are attached to error events. By default, the current scope keeps the 100 most recent, unique feature flag evaluations. When a scope forks, the child receives a copy of these evaluations, and changes to the copy don't affect the parent scope. | ||
|
|
||
| Active spans and transactions record the first 10 unique feature flags as span attributes using the `flag.evaluation.<name>` key. Spans don't inherit evaluations from their parent span. |
Comment on lines
+83
to
+85
| Scope evaluations are attached to error events. By default, the current scope keeps the 100 most recent, unique feature flag evaluations. When a scope forks, the child receives a copy of these evaluations, and changes to the copy don't affect the parent scope. | ||
|
|
||
| Active spans and transactions record the first 10 unique feature flags as span attributes using the `flag.evaluation.<name>` key. Spans don't inherit evaluations from their parent span. |
Comment on lines
+73
to
+75
| Scope evaluations are attached to error and message events. The current scope keeps the 100 most recent, unique feature flag evaluations. When a scope forks, the child receives a copy of these evaluations, and changes to the copy don't affect the parent scope. | ||
|
|
||
| Active spans and transactions record the first 10 unique feature flags as span attributes using the `flag.evaluation.<name>` key. Spans don't inherit evaluations from their parent span. |
philprime
approved these changes
Jul 22, 2026
philprime
left a comment
philprime
left a comment
Member
There was a problem hiding this comment.
Apple related docs look good to me. Left comments to consider
| @@ -0,0 +1,19 @@ | |||
| --- | |||
| title: Set Up Feature Flags | |||
Member
There was a problem hiding this comment.
m: Should we assign a label "New" to this page in the menu bar?
|
|
||
| `clearFeatureFlags()` removes evaluations only from the current scope. It doesn't affect parent or sibling scopes, or evaluations already recorded on an active span or transaction. | ||
|
|
||
| Scope evaluations are attached to error events. By default, the current scope keeps the 100 most recent, unique feature flag evaluations. When a scope forks, the child receives a copy of these evaluations, and changes to the copy don't affect the parent scope. |
Member
There was a problem hiding this comment.
m: I don't think we have a scope forking/parent scope pattern in sentry-cocoa. Do I read this correctly?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
Add feature flag evaluation tracking documentation for the Apple SDK and expand the Java and Android guides.
The guides cover the generic API, custom scopes and hubs, scope callbacks, clearing evaluations, span attributes, retention limits, and scope isolation. They also document minimum SDK versions and link all supported platforms from the product documentation.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
EXTRA RESOURCES
Closes getsentry/sentry-cocoa#8159