Skip to content

Commit 0b63960

Browse files
Adding feature flag product screenshots and details (#13543)
## DESCRIBE YOUR PR Adding screenshots to support the feature flag views within the issue details and audit log based on request from field. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [x] None: Not urgent, can wait up to 1 week+ [Docs preview](https://sentry-docs-1bm7xglao.sentry.dev/product/issues/issue-details/feature-flags/) --------- Co-authored-by: Michelle Zhang <[email protected]>
1 parent b8953f5 commit 0b63960

File tree

6 files changed

+34
-4
lines changed

6 files changed

+34
-4
lines changed
144 KB
Loading
305 KB
Loading
383 KB
Loading
62.8 KB
Loading
121 KB
Loading

docs/product/issues/issue-details/feature-flags/index.mdx

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,53 @@ Feature flag change tracking and feature flag evaluation tracking is currently i
1010

1111
</Alert>
1212

13-
Enabling a feature flag integration provides deep insights into the state of your application prior to an error. A list of flags and their evaluation results are displayed on each error event in the order of evaluation. Integrating Sentry with your feature flag provider enables Sentry to correlate feature flag changes with new error events and mark certain changes as suspicious.
13+
Enabling a feature flag integration provides deep insights into the state of your application prior to an error. A list of flags and their evaluation results are displayed on each error event in the order of evaluation.
14+
15+
Integrating Sentry with your feature flag provider enables Sentry to correlate feature flag changes with new error events and mark certain changes as suspicious.
1416

1517
## Evaluation Tracking
1618

17-
Flag evaluations will appear in the "Feature Flag" section of Issue Details page as a table, with "suspect" flag predictions highlighted in yellow. For each event, we track the 100 most recently evaluated flags leading up to the error. Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details page documentation](/product/issues/issue-details/#feature-flags).
19+
Flag evaluations will appear in the "Feature Flag" section of Issue Details page as a table, with "suspect" flag predictions highlighted in yellow.
20+
21+
![Flag Change Suspect](./img/SuspectFlag.png)
22+
23+
For each event, we track the 100 most recently evaluated flags leading up to the error. Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details page documentation](/product/issues/issue-details/#feature-flags).
24+
25+
Setting up evaluation tracking also allows you to use Issues Search in conjunction with feature flags. On Issues Search, using the `flags` keyword will allow you to filter for issues containing errors where the feature flag evaluated value is true or false.
1826

19-
Setting up evaluation tracking also allows you to use Issues Search in conjunction with feature flags. On Issues Search, using the `flags` keyword will allow you to filter for issues containing errors where the feature flag evaluated value is true or false. This allows you to quickly find all errors where a specific flag evaluation and its value of interest are present. See [searchable properties](/concepts/search/searchable-properties/issues/#flags) for more details about the search syntax.
27+
![Flag Change Search](./img/FlagsSearch.png)
28+
29+
This allows you to quickly find all errors where a specific flag evaluation and its value of interest are present. See [searchable properties](/concepts/search/searchable-properties/issues/#flags) for more details about the search syntax.
2030

2131
### Set Up Evaluation Tracking
2232

2333
To set up evaluation tracking, visit the SDK integration documentation for your platform:
2434
* [JavaScript](/platforms/javascript/feature-flags/)
2535
* [Python](/platforms/python/feature-flags/)
2636

37+
### Flag Distribution View
38+
39+
The flag distribution view allows you to see the percentage of your users who are receiving a specific feature flag value. You can access this view by selecting `View all tags and feature flags` from the issue details view, and selecting `All Feature Flags` on the top right.
40+
41+
![Flag Distribution](./img/FlagDistribution.png)
42+
43+
This view is useful for diagnosing the impacted audience of feature flag changes. For example, if a new issue occurs and the flag distribution view shows that 100% of impacted users are receiving a recently changed feature flag value, this could suggest that the feature flag change is responsible for the new error.
44+
2745
## Change Tracking
2846

29-
Change tracking enables Sentry to listen for additions, removals, and modifications to your feature flags. On change, we'll record the change event in the audit log. The audit log appears in the "event volume" chart and presents itself as a "release" line. If the change is responsible for a new error event, we'll notify you by marking the feature flag as "suspect" on the Issue Details page. Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details documentation](/product/issues/issue-details/#feature-flags).
47+
Change tracking enables Sentry to listen for additions, removals, and modifications to your feature flags. On change, we'll record the change event in the audit log.
48+
49+
![Flag Change Tracking](./img/FlagChangeTracking.png)
50+
51+
Within an issue, the audit log is represented in the "event" chart and presents itself as a "release" line.
52+
53+
![Flag Change Issue](./img/FlagChangeIssue.png)
54+
55+
If the change is responsible for a new error event, we'll notify you by marking the feature flag as "suspect" on the Issue Details page.
56+
57+
![Flag Change Suspect](./img/SuspectFlag.png)
58+
59+
Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details documentation](/product/issues/issue-details/#feature-flags).
3060

3161
### Set Up Change Tracking
3262

0 commit comments

Comments
 (0)