Skip to content

Add feature flags to issue-details page and launchdarkly integration documentation #11749

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

Closed
wants to merge 20 commits into from
Closed

Add feature flags to issue-details page and launchdarkly integration documentation #11749

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
0011f2d
Revert "Remove feature flag documentation from issue details page (#1…
cmanallen Nov 6, 2024
0dc00d1
Add feature flag documentation to issue-details page
cmanallen Nov 6, 2024
1cf3e8e
Fix spelling
cmanallen Nov 8, 2024
b0bbf64
Add more docs
cmanallen Nov 8, 2024
5a0e779
Clean up sentence
cmanallen Nov 8, 2024
1800bb4
Merge branch 'master' into cmanallen/add-issue-details-docs
cmanallen Nov 11, 2024
f00a3fa
Point to 'Change Tracking Integration' heading
cmanallen Nov 11, 2024
22d9ec4
Update docs/product/issues/issue-details/index.mdx
cmanallen Nov 11, 2024
920a532
Merge branch 'cmanallen/add-issue-details-docs' of https://github.com…
cmanallen Nov 11, 2024
cd6ecee
Clean up
cmanallen Nov 11, 2024
de57663
Add comma
cmanallen Nov 12, 2024
2e6e233
Another comma
cmanallen Nov 12, 2024
acb2b71
Fix wording
cmanallen Nov 12, 2024
4243227
Formatting
cmanallen Nov 13, 2024
1b0e3d4
Use correct naming
cmanallen Nov 13, 2024
db5797d
Formatting and naming corrections
cmanallen Nov 13, 2024
22a253e
Fix wording
cmanallen Nov 13, 2024
b5976c1
Clean up redundant documentation
cmanallen Nov 14, 2024
8e0051d
Remove extraneous information
cmanallen Nov 15, 2024
4cd2f65
Remove unused images
cmanallen Nov 15, 2024
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
Binary file added docs/organization/integrations/feature-flag/launchdarkly/img/launchdarkly-ui.png
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SCR-20241121-ltza

is the generic trigger different from this one that i've been using?

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/organization/integrations/feature-flag/launchdarkly/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 [email protected].

## Install and Configure
Expand All @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member

@michellewzhang michellewzhang Nov 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link to eval tracking setup: /product/explore/feature-flags/#set-up-your-language-specific-sdk

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>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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>.
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 webhook URL generated by the feature flag flyout panel. For information on how to generate a Sentry webhook 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>.


![LaunchDarkly Integration UI](./img/launchdarkly-ui.png)
Binary file added docs/product/issues/issue-details/img/feature-flag-modal.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions docs/product/issues/issue-details/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,36 @@ If you’ve enabled [Session Replay](/product/explore/session-replay/), you’ll

![Session Replay](./img/issue-replay.png)

## Feature Flags
There are two types of integrations you can configure to integrate feature flag data into your error events.

The first 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.

The second type is feature flag change tracking. This will enable a timeline of feature flag definition changes inside the releases graph. 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:

* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking-integration)

When both integrations are enabled, you'll also 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.

![Feature Flags](./img/feature-flags.png)

A timeline of feature flag changes is displayed in the releases graph. It can help you diagnose when a feature flag change has triggered a new bug report.

![Feature Flags](./img/suspect-flags-timeline.png)

Additionally, feature flag definition changes can be flagged as suspect when their modification occurs suspiciously close to the creation of an error event. Suspect feature flags are displayed are given a yellow highlight within the feature flag table.

![Feature Flags](./img/suspect-flags-table.png)

To enable suspect feature flags and feature flag change annotations, click the "Set Up Integration" button on the feature flag table and follow the instructions. Provider specific instructions are provided by clicking the "Read Docs" button.

![Feature Flags](./img/feature-flag-modal.png)

To learn more about enabling feature flag change tracking, visit the documentation for one of the supported providers below.

* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking-integration)


## Breadcrumbs

![Breadcrumbs](./img/issue-breadcrumbs.png)
Expand Down
Loading