Skip to content

Commit ea1face

Browse files
authored
Add Flagsmith as feature flag provider (#14126)
1 parent fad9d6f commit ea1face

File tree

7 files changed

+47
-5
lines changed

7 files changed

+47
-5
lines changed
Loading
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Flagsmith
3+
sidebar_order: 1
4+
description: Learn about Sentry's Flagsmith 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+
Flagsmith recommends using an OpenFeature SDK combined with a [Flagsmith provider](https://openfeature.dev/ecosystem?instant_search%5Bquery%5D=flagsmith&instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=Provider) to evaluate feature flags. To track these evaluations, visit one of our supported languages pages for OpenFeature:
14+
* [JavaScript](/platforms/javascript/configuration/integrations/openfeature/)
15+
* [Python](/platforms/python/integrations/openfeature/)
16+
17+
Visit the [Flagsmith documentation](https://docs.flagsmith.com/integrations/apm/sentry#evaluation-tracking-setup) for specific instructions on how to set up the OpenFeature SDK with the Flagsmith provider.
18+
19+
## Change Tracking
20+
21+
Sentry can track changes to feature flag definitions and report suspicious feature flag edits.
22+
23+
### Set Up Change Tracking
24+
25+
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/change-tracking/) in a new tab. Then follow the steps listed below.
26+
27+
1. **Click the "Add New Provider" button.**
28+
- One webhook secret can be registered per provider type.
29+
- Select Generic in the dropdown that says "Select a provider".
30+
2. **Register the webhook URL**.
31+
![Flagsmith Sentry Webhook Modal](./img/flagsmith-sentry-webhook-modal.png)
32+
- Go to your Flagsmith project dashboard and navigate to the `/project/:projectid/integrations` page, which can be found by clicking "Integrations" on the top navigation bar.
33+
- Find the Sentry option, and click "Add Integration", which will open a modal.
34+
- Select the Environment from which flag change events will trigger.
35+
- Copy the webhook URL from Sentry settings and paste it into "Webhook URL" in the Flagsmith "Sentry Integration" modal.
36+
3. **Set the Signing Secret**.
37+
- Still in the Flagsmith "Sentry Integration" modal, type in any string between 10 and 60 characters to use as your authorization token ("secret").
38+
- Copy the authorization token from the previous step and paste it into the input box next to "Secret" in Sentry settings.
39+
40+
Once saved, Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Generic
3-
sidebar_order: 1
3+
sidebar_order: 6
44
description: Learn about Sentry's generic feature-flag integrations.
55
---
66

@@ -30,7 +30,7 @@ Enabling Change Tracking is a four step process. To get started, visit the [feat
3030
- One webhook secret can be registered per provider type.
3131
- Select Generic in the dropdown that says "Select a provider".
3232
2. **Save the webhook URL**.
33-
- Copy the provided Sentry webhook URL and save it for step 4.
33+
- Copy the webhook URL from Sentry settings and save it for step 4.
3434
3. **Set the Signing Secret**.
3535
- In your feature flagging system's UI, find or create a "Signing Secret" for this webhook. If you are writing your own webhook, secrets must be 10-64 characters long (we recommend at least 32).
3636
- Copy the signing secret and paste it into the input box next to "Secret" in Sentry settings.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ sidebar_order: 90
44
description: "Learn more about Sentry's feature flag integrations."
55
---
66

7-
- [Generic](/organization/integrations/feature-flag/generic/)
7+
- [Flagsmith](/organization/integrations/feature-flag/flagsmith/)
88
- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
99
- [Statsig](/organization/integrations/feature-flag/statsig/)
1010
- [Split](/organization/integrations/feature-flag/split/)
1111
- [Unleash](/organization/integrations/feature-flag/unleash/)
12+
- [Generic](/organization/integrations/feature-flag/generic/)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Enabling Change Tracking is a three step process. To get started, visit the [fea
2626
- One webhook secret can be registered per provider type.
2727
- Select LaunchDarkly in the dropdown that says "Select a provider".
2828
2. **Register the webhook URL**.
29-
- Copy the provided Sentry webhook URL and paste it into LaunchDarkly within their [webhook integration UI](https://app.launchdarkly.com/settings/integrations/webhooks/new).
29+
- Copy the webhook URL from Sentry settings and paste it into LaunchDarkly within their [webhook integration UI](https://app.launchdarkly.com/settings/integrations/webhooks/new).
3030
3. **Set the Signing Secret**.
3131
- In the LaunchDarkly webhook UI, check the box that says "Sign this webhook".
3232
- Copy the signing secret in the revealed input box and paste it into the input box next to "Secret" in Sentry settings.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Enabling Change Tracking is a three-step process. To get started, visit the [fea
2828
2. **Register the webhook URL**.
2929
- 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.
3030
- Select the Webhook option. You should be on the `/integrations/create/webhook/` page.
31-
- Copy the provided Sentry webhook URL in settings and paste it into Unleash within their webhook integration UI.
31+
- Copy the webhook URL from Sentry settings and paste it into Unleash within their webhook integration UI.
3232
- Make sure the integration is toggled to Enabled.
3333
3. **Set the Signing Secret**.
3434
- 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.

platform-includes/feature-flags/change-tracking-list/_default.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
Change tracking requires registering a Sentry webhook with a feature flag provider. For set up instructions, visit the documentation for your provider:
2+
* [Flagsmith](/organization/integrations/feature-flag/flagsmith/#change-tracking)
23
* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking)
34
* [Statsig](/organization/integrations/feature-flag/statsig/#change-tracking)
45
* [Unleash](/organization/integrations/feature-flag/unleash/#change-tracking)

0 commit comments

Comments
 (0)