Skip to content
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.

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

docs(flags): add unleash webhook setup docs #12239

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/organization/integrations/feature-flag/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ description: "Learn more about Sentry's feature flag integrations."

- [Split](/organization/integrations/feature-flag/split/)
- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
- [Unleash](/organization/integrations/feature-flag/unleash/)
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Split
sidebar_order: 1
sidebar_order: 3
description: "Learn more about Sentry's Split integration, which allows you to use Sentry data in your Split analyses."
---

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions docs/organization/integrations/feature-flag/unleash/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Unleash
sidebar_order: 2
description: Learn about Sentry's Unleash integrations.
---

## Evaluation Tracking

Sentry can track flag evaluations as they happen within your application. Flag evaluations will appear in the "Feature Flag" section of Issue Details page as a table, with "suspect" flag predictions highlighted in yellow. 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).

### Set Up Evaluation Tracking

To set up evaluation tracking visit one of our supported languages pages:
* [JavaScript](/platforms/javascript/configuration/integrations/unleash/)
* [Python](/platforms/python/integrations/unleash/)
Comment on lines +14 to +15
Copy link
Member Author

Choose a reason for hiding this comment

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

note: these 2 links don't exist yet

Copy link
Member

Choose a reason for hiding this comment

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

Andrew will merge those soon. Let's wait until they're merged to merge this one.

Copy link
Contributor

Choose a reason for hiding this comment

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

I went ahead and set this to 'draft' to make sure we don't merge before these urls are working.


## Change Tracking

Sentry can track changes to feature flag definitions and report suspicious feature flag edits.

### Set Up Change Tracking

Enabling Change Tracking is a three-step process. To get started visit the [feature-flags settings page](https://sentry.io/orgredirect/organizations/:orgslug/settings/feature-flags) in a new tab. Then follow the steps listed below.

1. **Click the "Add New Provider" button.**
- One webhook secret can be registered per provider type.
- Select Unleash in the dropdown that says "Select a provider".
2. **Register the webhook URL**.
- Go to your Unleash homepage and navigate to the `/integrations/` page, which can be found by clicking Integrations on the left-hand sidebar navigation, under the Configure heading.
- Select the Webhook option. You should be on the `/integrations/create/webhook/` page.
- Copy the provided Sentry webhook URL in settings and paste it into Unleash within their webhook integration UI.
- Make sure the integration is toggled to Enabled.
3. **Set the Signing Secret**.
- In the Unleash webhook UI, under the Authorization input box, type in any 32-character string to use as your authorization token ("secret"). Keep this string safe and note it down somewhere in case you need it in the future; Unleash will not show you the token once you save the webhook. We recommend not using any sensitive tokens.
- Copy your authorization token from the Unleash UI and paste it into the input box next to "Secret" in Sentry settings.
4. **Configure your webhook.**
- Under the Events input box, specify which feature flag events you'd like to send to Sentry. We currently support the following events: ![Supported Unleash events](./img/unleash-events.png)
- Save the secret by clicking "Add Provider" in Sentry settings.
- Save the webhook by clicking "Create" in Unleash.

Once saved, Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint.

Loading