Skip to content

Commit

Permalink
feat(flags): document statsig webhook setup instructions (#12736)
Browse files Browse the repository at this point in the history
  • Loading branch information
aliu39 authored Feb 18, 2025
1 parent a9fa6e7 commit 0359399
Show file tree
Hide file tree
Showing 8 changed files with 54 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/organization/integrations/feature-flag/generic/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Generic
sidebar_order: 3
sidebar_order: 1
description: Learn about Sentry's generic feature-flag integrations.
---

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

### Set Up Change Tracking

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.
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.

1. **Click the "Add New Provider" button.**
- One webhook secret can be registered per provider type.
Expand Down
3 changes: 2 additions & 1 deletion docs/organization/integrations/feature-flag/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ sidebar_order: 90
description: "Learn more about Sentry's feature flag integrations."
---

- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
- [Generic](/organization/integrations/feature-flag/generic/)
- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
- [Statsig](/organization/integrations/feature-flag/statsig/)
- [Split](/organization/integrations/feature-flag/split/)
- [Unleash](/organization/integrations/feature-flag/unleash/)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: LaunchDarkly
sidebar_order: 1
sidebar_order: 2
description: Learn about Sentry's LaunchDarkly integrations.
---

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions docs/organization/integrations/feature-flag/statsig/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Statsig
sidebar_order: 3
description: Learn about Sentry's Statsig 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:
* [JavaScript](/platforms/javascript/configuration/integrations/statsig/)
* [Python](/platforms/python/integrations/statsig/)

## 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 Statsig in the dropdown that says "Select a provider".
2. **Register the webhook URL**.
![Statsig Webhook Modal](./img/statsig-webhook-modal.png)
- 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.
- Select the Webhook option, which will open a modal.
- Copy the webhook URL provided in Sentry settings and paste it into the modal's "Webhook URL" input box.
3. **Set the Signing Secret**.
- Copy the Webhook Signing Secret from below the URL, and paste it into the input box next to "Secret" in Sentry settings.
- 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.
4. **Optional: Event Filters**.
- 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.
- 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.
- Similar to Environments, you may also filter by Configuration Changes by "Tags", "Target Apps", or "Teams".
![Statsig Event Filters](./img/statsig-event-filters.png)

5. **Save your webhook**.
- Save the secret by clicking "Add Provider" in Sentry settings.
- Save the webhook by clicking "Confirm" in Statsig.

Once saved, Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint.
4 changes: 2 additions & 2 deletions docs/organization/integrations/feature-flag/unleash/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Unleash
sidebar_order: 2
sidebar_order: 5
description: Learn about Sentry's Unleash integrations.
---

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

### 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.
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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Change tracking requires registering a Sentry webhook with a feature flag provider. For set up instructions, visit the documentation for your provider:
* [Generic](/organization/integrations/feature-flag/generic/#change-tracking)
* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking)
* [Statsig](/organization/integrations/feature-flag/statsig/#change-tracking)
* [Unleash](/organization/integrations/feature-flag/unleash/#change-tracking)

0 comments on commit 0359399

Please sign in to comment.