Skip to content

Commit 3bacab0

Browse files
committed
proposed updates to flagsmith integration docs
1 parent a349edd commit 3bacab0

File tree

3 files changed

+41
-1
lines changed

3 files changed

+41
-1
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
---
3+
title: Flagsmith
4+
sidebar_order: 1
5+
description: Learn about Sentry's Flagsmith integrations.
6+
---
7+
8+
## Evaluation Tracking
9+
10+
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).
11+
12+
### Set Up Evaluation Tracking
13+
14+
Flagsmith recommends using a OpenFeature SDK and [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:
15+
* [JavaScript](/platforms/javascript/configuration/integrations/openfeature/)
16+
* [Python](/platforms/python/integrations/openfeature/)
17+
18+
## Change Tracking
19+
20+
Sentry can track changes to feature flag definitions and report suspicious feature flag edits.
21+
22+
### Set Up Change Tracking
23+
24+
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.
25+
26+
1. **Click the "Add New Provider" button.**
27+
- One webhook secret can be registered per provider type.
28+
- Select Generic in the dropdown that says "Select a provider".
29+
2. **Register the webhook URL**.
30+
![Flagsmith Sentry Webhook Modal](./img/flagsmith-sentry-webhook-modal.png)
31+
- 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.
32+
- Find the Sentry option, and click "Add Integration", which will open a modal.
33+
- Select the Environment from which flag change events will trigger.
34+
- Copy the provided Sentry webhook URL and paste it into "Webhook URL" in the Flagsmith "Sentry Integration" modal.
35+
3. **Set the Signing Secret**.
36+
- Still in the Flagsmith "Sentry Integration" modal, type in any string between 10 and 60 characters to use as your authorization token ("secret").
37+
- Copy the authorization token from the previous step and paste it into the input box next to "Secret" in Sentry settings.
38+
39+
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: 1 addition & 1 deletion
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

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)