From 3bacab06f8a85ae42981723447e752247fca8c63 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Tue, 1 Jul 2025 14:15:22 -0700 Subject: [PATCH 1/2] proposed updates to flagsmith integration docs --- .../feature-flag/flagsmith/index.mdx | 39 +++++++++++++++++++ .../feature-flag/generic/index.mdx | 2 +- .../change-tracking-list/_default.mdx | 1 + 3 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docs/organization/integrations/feature-flag/flagsmith/index.mdx 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..a8bdc38c936cd0 --- /dev/null +++ b/docs/organization/integrations/feature-flag/flagsmith/index.mdx @@ -0,0 +1,39 @@ + +--- +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 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: +* [JavaScript](/platforms/javascript/configuration/integrations/openfeature/) +* [Python](/platforms/python/integrations/openfeature/) + +## 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 provided Sentry webhook URL 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..57c1f3e7d0af66 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. --- 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) From dd8de3773ab83043819eef4656480c1e124ec8f2 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Tue, 1 Jul 2025 14:22:58 -0700 Subject: [PATCH 2/2] proposed updates to flagsmith integration docs --- .../organization/integrations/feature-flag/flagsmith/index.mdx | 2 -- docs/organization/integrations/feature-flag/index.mdx | 3 ++- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/organization/integrations/feature-flag/flagsmith/index.mdx b/docs/organization/integrations/feature-flag/flagsmith/index.mdx index a8bdc38c936cd0..70e1df6505250e 100644 --- a/docs/organization/integrations/feature-flag/flagsmith/index.mdx +++ b/docs/organization/integrations/feature-flag/flagsmith/index.mdx @@ -1,4 +1,3 @@ - --- title: Flagsmith sidebar_order: 1 @@ -27,7 +26,6 @@ Enabling Change Tracking is a three-step process. To get started, visit the [fea - 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. 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/)