From 6bd4dad4ab053591511a1dc6aaaebff5dde30a88 Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreplay.github.com> Date: Tue, 26 Nov 2024 22:54:12 -0800 Subject: [PATCH 1/3] docs(flags): add product index page for feature flags --- docs/product/explore/feature-flags/index.mdx | 40 ++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/product/explore/feature-flags/index.mdx diff --git a/docs/product/explore/feature-flags/index.mdx b/docs/product/explore/feature-flags/index.mdx new file mode 100644 index 0000000000000..14b040b2bb433 --- /dev/null +++ b/docs/product/explore/feature-flags/index.mdx @@ -0,0 +1,40 @@ +--- +title: "Feature Flags" +sidebar_order: 100 +description: "Learn how to set up and interact with Sentry's feature flag evaluation tracking and feature flag change tracking." +--- + + + +The support for **feature flag change tracking** and **feature flag evaluation tracking** is currently in beta. + + + +Link your external feature flag integrations with Sentry to provide feature flag insights right inside the Sentry UI. Linking one or more integrations will allow you to view recent flag evaluations in one place and identify potential suspect flags related to errors. In addition, Sentry will provide insights on feature flag updates relative to error event timelines. + +## Touchpoints + +Feature flag insights can be found by navigating to the Issue Details page for any error event. There are two places where you can interact with flag data: +* Flag updates (changes, deletions, and additions) will appear as a series on the event and user volume chart. +* Flag evaluations will appear in the Feature Flag section in Issue Details 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 docs](/product/issues/issue-details/#feature-flags/). + +## Setup + +In order to take advantage of the full feature flag experience available, there are two steps necessary to set up **feature flag evaluation tracking** and **feature flag change tracking**. The first step — setting up the language-specific SDK — is necessary for evaluation tracking, and the second step — setting up your integration-specific webhook — is necessary for change tracking. + +## Set Up Your Language-Specific SDK + +In order to gain access to **feature flag evaluation tracking**, you need to set up your SDK to include Sentry's feature flag integration. + +Learn more about the languages we currently support and how to set up the SDK: +* JavaScript +* [Python](/platforms/python/feature-flags/) + +## Set Up Your Integration-Specific Webhook + +In order to gain access to **feature flag change tracking**, you need to set up a webhook with your specific integration, so that it may communicate feature flag changes with Sentry. + +Learn more about the integrations we currently support and how to set up the webhook: +* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) \ No newline at end of file From 0bb8b8ea66a30560b5906eda04f5ce2c6f12b4ba Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreplay.github.com> Date: Tue, 26 Nov 2024 23:06:57 -0800 Subject: [PATCH 2/3] add link to js --- docs/product/explore/feature-flags/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/product/explore/feature-flags/index.mdx b/docs/product/explore/feature-flags/index.mdx index 14b040b2bb433..7bc0443ff770f 100644 --- a/docs/product/explore/feature-flags/index.mdx +++ b/docs/product/explore/feature-flags/index.mdx @@ -29,7 +29,7 @@ In order to take advantage of the full feature flag experience available, there In order to gain access to **feature flag evaluation tracking**, you need to set up your SDK to include Sentry's feature flag integration. Learn more about the languages we currently support and how to set up the SDK: -* JavaScript +* [JavaScript](/platforms/javascript/feature-flags/) * [Python](/platforms/python/feature-flags/) ## Set Up Your Integration-Specific Webhook From cdb050ee2e33bcd7261cf71872693b041ded054f Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Sat, 30 Nov 2024 17:02:06 -0600 Subject: [PATCH 3/3] Update instructions --- docs/product/explore/feature-flags/index.mdx | 32 ++++++++------------ 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/docs/product/explore/feature-flags/index.mdx b/docs/product/explore/feature-flags/index.mdx index 7bc0443ff770f..0aba401209f5f 100644 --- a/docs/product/explore/feature-flags/index.mdx +++ b/docs/product/explore/feature-flags/index.mdx @@ -6,35 +6,27 @@ description: "Learn how to set up and interact with Sentry's feature flag evalua -The support for **feature flag change tracking** and **feature flag evaluation tracking** is currently in beta. +**Feature flag change tracking** and **feature flag evaluation tracking** is currently in closed beta. If you'd like to be added to the beta, please fill out [this form](https://forms.gle/EeNwTepvVwt7poAJ8). -Link your external feature flag integrations with Sentry to provide feature flag insights right inside the Sentry UI. Linking one or more integrations will allow you to view recent flag evaluations in one place and identify potential suspect flags related to errors. In addition, Sentry will provide insights on feature flag updates relative to error event timelines. +Enabling a feature flag integration gives you deep insights into the state of your application prior to failure. A list of flags and their evaluation results are displayed on each error event. Integrating Sentry with your feature flag provider enables Sentry to correlate feature flag changes with new error events and mark certain changes as suspicious. -## Touchpoints +## Evaluation Tracking -Feature flag insights can be found by navigating to the Issue Details page for any error event. There are two places where you can interact with flag data: -* Flag updates (changes, deletions, and additions) will appear as a series on the event and user volume chart. -* Flag evaluations will appear in the Feature Flag section in Issue Details as a table, with "suspect" flag predictions highlighted in yellow. +Flag evaluations will appear in the "Feature Flag" section of 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 docs](/product/issues/issue-details/#feature-flags/). -Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details docs](/product/issues/issue-details/#feature-flags/). +### Set Up Evaluation Tracking -## Setup - -In order to take advantage of the full feature flag experience available, there are two steps necessary to set up **feature flag evaluation tracking** and **feature flag change tracking**. The first step — setting up the language-specific SDK — is necessary for evaluation tracking, and the second step — setting up your integration-specific webhook — is necessary for change tracking. - -## Set Up Your Language-Specific SDK - -In order to gain access to **feature flag evaluation tracking**, you need to set up your SDK to include Sentry's feature flag integration. - -Learn more about the languages we currently support and how to set up the SDK: +Supported Platforms: * [JavaScript](/platforms/javascript/feature-flags/) * [Python](/platforms/python/feature-flags/) -## Set Up Your Integration-Specific Webhook +## Change Tracking + +Change tracking enables Sentry to listen for updates to your feature flags' definitions. On change, we'll record the event in an audit log. The audit log appears in the "event volume" chart and presents itself as a "release" line. If the change is responsible for a new error event, we'll notify you by marking the feature flag as "suspect" on the issue details page. 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/). -In order to gain access to **feature flag change tracking**, you need to set up a webhook with your specific integration, so that it may communicate feature flag changes with Sentry. +### Set Up Change Tracking -Learn more about the integrations we currently support and how to set up the webhook: -* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) \ No newline at end of file +Supported Feature Flag Providers: +* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)