Skip to content

Commit

Permalink
docs(flags): add unleash webhook setup docs (#12239)
Browse files Browse the repository at this point in the history
* docs(flags): add unleash webhook setup docs

* Update docs/organization/integrations/feature-flag/unleash/index.mdx

Co-authored-by: Alex Krawiec <[email protected]>

* Update docs/organization/integrations/feature-flag/split/index.mdx

* Update docs/organization/integrations/feature-flag/unleash/index.mdx

* Update docs/organization/integrations/feature-flag/unleash/index.mdx

* Fix URL and remove reference to Javascript docs

* ♻️ add unleash to python index

---------

Co-authored-by: Alex Krawiec <[email protected]>
Co-authored-by: Colton Allen <[email protected]>
  • Loading branch information
3 people authored Jan 7, 2025
1 parent 23ee68e commit 0f8b34d
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 1 deletion.
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 @@ -7,3 +7,4 @@ description: "Learn more about Sentry's feature flag integrations."
- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
- [Generic](/organization/integrations/feature-flag/generic/)
- [Split](/organization/integrations/feature-flag/split/)
- [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: 4
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.
40 changes: 40 additions & 0 deletions docs/organization/integrations/feature-flag/unleash/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
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 the 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:
* [Python](/platforms/python/integrations/feature-flags/unleash/)

## 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.
1 change: 1 addition & 0 deletions docs/platforms/python/feature-flags/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Evaluation tracking requires enabling an SDK integration. Integrations are provi

- [OpenFeature](/platforms/python/integrations/feature-flags/openfeature/)
- [LaunchDarkly](/platforms/python/integrations/feature-flags/launchdarkly/)
- [Unleash](/platforms/python/integrations/feature-flags/unleash/)
- [Generic](/platforms/python/integrations/feature-flags/generic/)

<PlatformContent includePath="feature-flags/enable-change-tracking" />

0 comments on commit 0f8b34d

Please sign in to comment.