Add feature flags to issue-details page and launchdarkly integration documentation #11749
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,6 +4,8 @@ sidebar_order: 1 | |||||
| description: Learn about Sentry's LaunchDarkly integration. LaunchDarkly enables organizations to use Sentry errors as a metric in their LaunchDarkly experiments. | ||||||
|
There was a problem hiding this comment. we should probably update this description to be more generic -- right now it's about metrics, but we're adding FF info to this page too! |
||||||
| --- | ||||||
|
|
||||||
| ## Metrics Integration | ||||||
|
|
||||||
| This integration is maintained and supported by the company that created it. For more details or questions, feel free to contact rrosefigura@launchdarkly.com. | ||||||
|
|
||||||
| ## Install and Configure | ||||||
|
|
@@ -23,3 +25,9 @@ The LaunchDarkly integration is only available to organizations with a Business | |||||
| 1. Navigate to **Settings > Integrations > LaunchDarkly** | ||||||
|
|
||||||
| 2. Follow the full [LaunchDarkly installation instructions](https://docs.launchdarkly.com/integrations/sentry). | ||||||
|
|
||||||
| ## Change Tracking Integration | ||||||
|
There was a problem hiding this comment. we should mention that there's another step needed to set up feature flags completely (e.g. for eval tracking, they need to set up the platform-specific language for their sdk) & link to a full list of platforms (a product index page, when we create it, would make sense) There was a problem hiding this comment. link to eval tracking setup: PR here in case the title/link changes |
||||||
|
|
||||||
| Sentry offers a flag change tracking integration which allows Sentry to associate flag definition changes with errors that occurred in your application. To enable this integration, create a new <Link to="https://app.launchdarkly.com/settings/integrations?q=generic+trigger">"Generic Trigger"</Link> integration and paste the Sentry web hook URL generated by the Feature Flag Integration Modal. For information on how to generate a Sentry Web Hook URL, visit the <PlatformLink to="/product/issues/issue-details/#feature-flags">feature flag integration documentation here</PlatformLink>. Learn more about LaunchDarkly's "Generic Triggers" <Link to="https://docs.launchdarkly.com/home/releases/triggers">here</Link>. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
|  | ||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -102,6 +102,18 @@ If you’ve enabled [Session Replay](/product/explore/session-replay/), you’ll | |
|
|
||
|  | ||
|
|
||
| ## Feature Flags | ||
| There are two types of integrations you can configure to integrate feature flag data into your error events. | ||
|
|
||
| The first integration type is **flag evaluation tracking** within the Sentry SDK. To enable it, update the Sentry SDK's `init` method to include one of our supported feature flag integrations. Support varies by language and by provider. Doing so will give you access to the feature flag table, which shows any flags that were evaluated after the Sentry SDK's initialization and before the error event occurred. You will see rows of (flag, evaluation-result) pairs. Supported integrations include: | ||
|
|
||
| * LaunchDarkly ([Python](/platforms/python/integrations/launchdarkly/) and [JavaScript](/platforms/javascript/integrations/launchdarkly/)) | ||
| * OpenFeature ([Python](/platforms/python/integrations/openfeature/) and [JavaScript](/platforms/javascript/integrations/openfeature/)) | ||
|
|
||
| The second integration type is **feature flag change tracking**. This will enable a timeline of feature flag definition changes on the event and user volume chart. These annotations can help you diagnose when a feature flag change is related to a new issue. To enable this type of integration, please visit the documentation page of one of our supported providers: | ||
|
There was a problem hiding this comment. we should list the providers and the links here! There was a problem hiding this comment. or at the very least, we should link to a spot where we have a full list of providers (an index page, when we create one, would make sense) There was a problem hiding this comment. PR is out for the index page: #11969 the link/title might change, but as of now can link to There was a problem hiding this comment. or |
||
|
|
||
| When both integrations are enabled, you'll see suspect feature flags highlighted in yellow in the feature flag table. Feature flags are marked as "suspect" if they're modified suspiciously close to the detection of a new issue. | ||
|
|
||
| ## Breadcrumbs | ||
|
|
||
|  | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is the generic trigger different from this one that i've been using?