Skip to content

Commit 0f8b34d

Browse files
michellewzhangcoolguyzonecmanallen
authored
docs(flags): add unleash webhook setup docs (#12239)
* 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]>
1 parent 23ee68e commit 0f8b34d

File tree

6 files changed

+43
-1
lines changed

6 files changed

+43
-1
lines changed

docs/organization/integrations/feature-flag/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ description: "Learn more about Sentry's feature flag integrations."
77
- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
88
- [Generic](/organization/integrations/feature-flag/generic/)
99
- [Split](/organization/integrations/feature-flag/split/)
10+
- [Unleash](/organization/integrations/feature-flag/unleash/)
Binary file not shown.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Split
3-
sidebar_order: 1
3+
sidebar_order: 4
44
description: "Learn more about Sentry's Split integration, which allows you to use Sentry data in your Split analyses."
55
---
66

82 KB
Loading
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Unleash
3+
sidebar_order: 2
4+
description: Learn about Sentry's Unleash integrations.
5+
---
6+
7+
## Evaluation Tracking
8+
9+
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).
10+
11+
### Set Up Evaluation Tracking
12+
13+
To set up evaluation tracking, visit one of our supported languages pages:
14+
* [Python](/platforms/python/integrations/feature-flags/unleash/)
15+
16+
## Change Tracking
17+
18+
Sentry can track changes to feature flag definitions and report suspicious feature flag edits.
19+
20+
### Set Up Change Tracking
21+
22+
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.
23+
24+
1. **Click the "Add New Provider" button.**
25+
- One webhook secret can be registered per provider type.
26+
- Select Unleash in the dropdown that says "Select a provider".
27+
2. **Register the webhook URL**.
28+
- 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.
29+
- Select the Webhook option. You should be on the `/integrations/create/webhook/` page.
30+
- Copy the provided Sentry webhook URL in settings and paste it into Unleash within their webhook integration UI.
31+
- Make sure the integration is toggled to Enabled.
32+
3. **Set the Signing Secret**.
33+
- 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.
34+
- Copy your authorization token from the Unleash UI and paste it into the input box next to "Secret" in Sentry settings.
35+
4. **Configure your webhook.**
36+
- 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)
37+
- Save the secret by clicking "Add Provider" in Sentry settings.
38+
- Save the webhook by clicking "Create" in Unleash.
39+
40+
Once saved, Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint.

docs/platforms/python/feature-flags/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Evaluation tracking requires enabling an SDK integration. Integrations are provi
1616

1717
- [OpenFeature](/platforms/python/integrations/feature-flags/openfeature/)
1818
- [LaunchDarkly](/platforms/python/integrations/feature-flags/launchdarkly/)
19+
- [Unleash](/platforms/python/integrations/feature-flags/unleash/)
1920
- [Generic](/platforms/python/integrations/feature-flags/generic/)
2021

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

0 commit comments

Comments
 (0)