Skip to content

Commit 0359399

Browse files
authored
feat(flags): document statsig webhook setup instructions (#12736)
1 parent a9fa6e7 commit 0359399

File tree

8 files changed

+54
-6
lines changed

8 files changed

+54
-6
lines changed

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: 3
3+
sidebar_order: 1
44
description: Learn about Sentry's generic feature-flag integrations.
55
---
66

@@ -24,7 +24,7 @@ For the generic case, you need to write a webhook that conforms to our API. You
2424

2525
### Set Up Change Tracking
2626

27-
Enabling Change Tracking is a four 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.
27+
Enabling Change Tracking is a four 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.
2828

2929
1. **Click the "Add New Provider" button.**
3030
- One webhook secret can be registered per provider type.

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

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

7-
- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
87
- [Generic](/organization/integrations/feature-flag/generic/)
8+
- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
9+
- [Statsig](/organization/integrations/feature-flag/statsig/)
910
- [Split](/organization/integrations/feature-flag/split/)
1011
- [Unleash](/organization/integrations/feature-flag/unleash/)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: LaunchDarkly
3-
sidebar_order: 1
3+
sidebar_order: 2
44
description: Learn about Sentry's LaunchDarkly integrations.
55
---
66

172 KB
Loading
176 KB
Loading
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Statsig
3+
sidebar_order: 3
4+
description: Learn about Sentry's Statsig 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+
* [JavaScript](/platforms/javascript/configuration/integrations/statsig/)
15+
* [Python](/platforms/python/integrations/statsig/)
16+
17+
## Change Tracking
18+
19+
Sentry can track changes to feature flag definitions and report suspicious feature flag edits.
20+
21+
### Set Up Change Tracking
22+
23+
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.
24+
25+
1. **Click the "Add New Provider" button.**
26+
- One webhook secret can be registered per provider type.
27+
- Select Statsig in the dropdown that says "Select a provider".
28+
2. **Register the webhook URL**.
29+
![Statsig Webhook Modal](./img/statsig-webhook-modal.png)
30+
- Go to your Statsig console and navigate to the `/integrations/` page, which can be found by clicking settings on the left-hand sidebar navigation, then "Integrations" under the "Product Configuration" heading.
31+
- Select the Webhook option, which will open a modal.
32+
- Copy the webhook URL provided in Sentry settings and paste it into the modal's "Webhook URL" input box.
33+
3. **Set the Signing Secret**.
34+
- Copy the Webhook Signing Secret from below the URL, and paste it into the input box next to "Secret" in Sentry settings.
35+
- Keep this string safe and note it down somewhere in case you need it in the future. Statsig will still show you the secret when reopening the webhook modal. Keep in mind that if you click "Generate New Key", you will need to add the secret to Sentry settings again.
36+
4. **Optional: Event Filters**.
37+
- We currently only support change tracking events from this webhook. To avoid sending unnecessary events, click "Event Filtering" on the top right of the Statsig modal and check off "Configuration Changes". Click save to confirm.
38+
- If you would like to only track changes from your Statsig development, staging, and/or production environments, check off the corresponding environment(s) under "Configuration Changes" > "Environments" in Event Filtering. Click save to confirm.
39+
- Similar to Environments, you may also filter by Configuration Changes by "Tags", "Target Apps", or "Teams".
40+
![Statsig Event Filters](./img/statsig-event-filters.png)
41+
42+
5. **Save your webhook**.
43+
- Save the secret by clicking "Add Provider" in Sentry settings.
44+
- Save the webhook by clicking "Confirm" in Statsig.
45+
46+
Once saved, Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint.

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

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

@@ -20,7 +20,7 @@ Sentry can track changes to feature flag definitions and report suspicious featu
2020

2121
### Set Up Change Tracking
2222

23-
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+
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.
2424

2525
1. **Click the "Add New Provider" button.**
2626
- One webhook secret can be registered per provider type.
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:
22
* [Generic](/organization/integrations/feature-flag/generic/#change-tracking)
33
* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking)
4+
* [Statsig](/organization/integrations/feature-flag/statsig/#change-tracking)
45
* [Unleash](/organization/integrations/feature-flag/unleash/#change-tracking)

0 commit comments

Comments
 (0)