diff --git a/docs/organization/integrations/feature-flag/flagsmith/img/flagsmith-sentry-webhook-modal.png b/docs/organization/integrations/feature-flag/flagsmith/img/flagsmith-sentry-webhook-modal.png new file mode 100644 index 00000000000000..d70b4a6ef9a79b Binary files /dev/null and b/docs/organization/integrations/feature-flag/flagsmith/img/flagsmith-sentry-webhook-modal.png differ diff --git a/docs/organization/integrations/feature-flag/flagsmith/index.mdx b/docs/organization/integrations/feature-flag/flagsmith/index.mdx new file mode 100644 index 00000000000000..33626a3f9064ad --- /dev/null +++ b/docs/organization/integrations/feature-flag/flagsmith/index.mdx @@ -0,0 +1,40 @@ +--- +title: Flagsmith +sidebar_order: 1 +description: Learn about Sentry's Flagsmith 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 + +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: +* [JavaScript](/platforms/javascript/configuration/integrations/openfeature/) +* [Python](/platforms/python/integrations/openfeature/) + +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. + +## 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/change-tracking/) 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 Generic in the dropdown that says "Select a provider". +2. **Register the webhook URL**. + ![Flagsmith Sentry Webhook Modal](./img/flagsmith-sentry-webhook-modal.png) + - 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. + - Find the Sentry option, and click "Add Integration", which will open a modal. + - Select the Environment from which flag change events will trigger. + - Copy the webhook URL from Sentry settings and paste it into "Webhook URL" in the Flagsmith "Sentry Integration" modal. +3. **Set the Signing Secret**. + - Still in the Flagsmith "Sentry Integration" modal, type in any string between 10 and 60 characters to use as your authorization token ("secret"). + - Copy the authorization token from the previous step and paste it into the input box next to "Secret" in Sentry settings. + +Once saved, Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint. diff --git a/docs/organization/integrations/feature-flag/generic/index.mdx b/docs/organization/integrations/feature-flag/generic/index.mdx index 053e436e4fff67..fa2e0045d39344 100644 --- a/docs/organization/integrations/feature-flag/generic/index.mdx +++ b/docs/organization/integrations/feature-flag/generic/index.mdx @@ -1,6 +1,6 @@ --- title: Generic -sidebar_order: 1 +sidebar_order: 6 description: Learn about Sentry's generic feature-flag integrations. --- @@ -30,7 +30,7 @@ Enabling Change Tracking is a four step process. To get started, visit the [feat - One webhook secret can be registered per provider type. - Select Generic in the dropdown that says "Select a provider". 2. **Save the webhook URL**. - - Copy the provided Sentry webhook URL and save it for step 4. + - Copy the webhook URL from Sentry settings and save it for step 4. 3. **Set the Signing Secret**. - In your feature flagging system's UI, find the "Signing Secret". - Copy the signing secret and paste it into the input box next to "Secret" in Sentry settings. diff --git a/docs/organization/integrations/feature-flag/index.mdx b/docs/organization/integrations/feature-flag/index.mdx index 84f2a642da776b..04242dcea1bd7e 100644 --- a/docs/organization/integrations/feature-flag/index.mdx +++ b/docs/organization/integrations/feature-flag/index.mdx @@ -4,8 +4,9 @@ sidebar_order: 90 description: "Learn more about Sentry's feature flag integrations." --- -- [Generic](/organization/integrations/feature-flag/generic/) +- [Flagsmith](/organization/integrations/feature-flag/flagsmith/) - [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) - [Statsig](/organization/integrations/feature-flag/statsig/) - [Split](/organization/integrations/feature-flag/split/) - [Unleash](/organization/integrations/feature-flag/unleash/) +- [Generic](/organization/integrations/feature-flag/generic/) diff --git a/docs/organization/integrations/feature-flag/launchdarkly/index.mdx b/docs/organization/integrations/feature-flag/launchdarkly/index.mdx index 8552f2f6a57ee4..20dfe981c8ec8f 100644 --- a/docs/organization/integrations/feature-flag/launchdarkly/index.mdx +++ b/docs/organization/integrations/feature-flag/launchdarkly/index.mdx @@ -26,7 +26,7 @@ Enabling Change Tracking is a three step process. To get started, visit the [fea - One webhook secret can be registered per provider type. - Select LaunchDarkly in the dropdown that says "Select a provider". 2. **Register the webhook URL**. - - Copy the provided Sentry webhook URL and paste it into LaunchDarkly within their [webhook integration UI](https://app.launchdarkly.com/settings/integrations/webhooks/new). + - 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). 3. **Set the Signing Secret**. - In the LaunchDarkly webhook UI, check the box that says "Sign this webhook". - Copy the signing secret in the revealed input box and paste it into the input box next to "Secret" in Sentry settings. diff --git a/docs/organization/integrations/feature-flag/unleash/index.mdx b/docs/organization/integrations/feature-flag/unleash/index.mdx index 6f315636194c3f..a498d59f725245 100644 --- a/docs/organization/integrations/feature-flag/unleash/index.mdx +++ b/docs/organization/integrations/feature-flag/unleash/index.mdx @@ -28,7 +28,7 @@ Enabling Change Tracking is a three-step process. To get started, visit the [fea 2. **Register the webhook URL**. - 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. - Select the Webhook option. You should be on the `/integrations/create/webhook/` page. - - Copy the provided Sentry webhook URL in settings and paste it into Unleash within their webhook integration UI. + - Copy the webhook URL from Sentry settings and paste it into Unleash within their webhook integration UI. - Make sure the integration is toggled to Enabled. 3. **Set the Signing Secret**. - 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. diff --git a/platform-includes/feature-flags/change-tracking-list/_default.mdx b/platform-includes/feature-flags/change-tracking-list/_default.mdx index de0f724315b0a6..84613fdeb48173 100644 --- a/platform-includes/feature-flags/change-tracking-list/_default.mdx +++ b/platform-includes/feature-flags/change-tracking-list/_default.mdx @@ -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: +* [Flagsmith](/organization/integrations/feature-flag/flagsmith/#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)