From 097e4d164dc0d9ba364a5966bca7495dc3bd4ddb Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:26:55 -0800 Subject: [PATCH 1/6] docs(flags): add index flag docs for python --- docs/platforms/python/feature-flags/index.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/platforms/python/feature-flags/index.mdx diff --git a/docs/platforms/python/feature-flags/index.mdx b/docs/platforms/python/feature-flags/index.mdx new file mode 100644 index 0000000000000..5b9bf84c498b7 --- /dev/null +++ b/docs/platforms/python/feature-flags/index.mdx @@ -0,0 +1,11 @@ +--- +title: Set Up Feature Flags +sidebar_order: 5200 +description: "Learn how to enable Feature Flags in your app if it is not already set up." +--- + +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. + +Learn more about the integrations available for Python and how to set them up: +- [OpenFeature](/platforms/python/integrations/openfeature/) +- [LaunchDarkly](/platforms/python/integrations/launchdarkly/) From d8a67954e2c7638909b2fd139bacd6ed873037ab Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> Date: Wed, 20 Nov 2024 11:54:03 -0800 Subject: [PATCH 2/6] :add beta label --- docs/platforms/python/feature-flags/index.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/platforms/python/feature-flags/index.mdx b/docs/platforms/python/feature-flags/index.mdx index 5b9bf84c498b7..c4ac5a46e081a 100644 --- a/docs/platforms/python/feature-flags/index.mdx +++ b/docs/platforms/python/feature-flags/index.mdx @@ -1,9 +1,15 @@ --- title: Set Up Feature Flags sidebar_order: 5200 -description: "Learn how to enable Feature Flags in your app if it is not already set up." +description: Learn how to set up 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. Learn more about the integrations available for Python and how to set them up: From 9254bba68d7fea419273b3689d1dc6baeb07bfb5 Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> Date: Tue, 26 Nov 2024 23:20:43 -0800 Subject: [PATCH 3/6] add info about second step --- docs/platforms/python/feature-flags/index.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/platforms/python/feature-flags/index.mdx b/docs/platforms/python/feature-flags/index.mdx index c4ac5a46e081a..b71855c066c1e 100644 --- a/docs/platforms/python/feature-flags/index.mdx +++ b/docs/platforms/python/feature-flags/index.mdx @@ -12,6 +12,16 @@ The support for **feature flag change tracking** and **feature flag evaluation t 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. +To set up **feature flag evaluation tracking**, you will need to set up your language-specific SDK to include Sentry's feature flag integration. + Learn more about the integrations available for Python and how to set them up: - [OpenFeature](/platforms/python/integrations/openfeature/) - [LaunchDarkly](/platforms/python/integrations/launchdarkly/) + +Please read the note below to ensure that you also complete one additional step. + + + +In order to take full advantage of the feature flag capabilities Sentry offers, there is an additional setup step needed, which is setting up your integration-specific webhook. This is needed to enable **feature flag change tracking**, so that your integration may communicate feature flag changes to Sentry. Learn how to set this up by [reading the docs](/product/explore/feature-flags/). + + \ No newline at end of file From 0ef3d1f822ec88e7a8b61ada4e83d6387b1092fe Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> Date: Tue, 26 Nov 2024 23:35:08 -0800 Subject: [PATCH 4/6] new link --- docs/platforms/python/feature-flags/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/python/feature-flags/index.mdx b/docs/platforms/python/feature-flags/index.mdx index b71855c066c1e..978b25a5cc904 100644 --- a/docs/platforms/python/feature-flags/index.mdx +++ b/docs/platforms/python/feature-flags/index.mdx @@ -22,6 +22,6 @@ Please read the note below to ensure that you also complete one additional step. -In order to take full advantage of the feature flag capabilities Sentry offers, there is an additional setup step needed, which is setting up your integration-specific webhook. This is needed to enable **feature flag change tracking**, so that your integration may communicate feature flag changes to Sentry. Learn how to set this up by [reading the docs](/product/explore/feature-flags/). +In order to take full advantage of the feature flag capabilities Sentry offers, there is an additional setup step needed, which is setting up your integration-specific webhook. This is needed to enable **feature flag change tracking**, so that your integration may communicate feature flag changes to Sentry. Learn how to set this up by [reading the docs](/product/explore/feature-flags/#set-up-your-integration-specific-webhook). \ No newline at end of file From 8eddd68e2e97faecd21088fcbb5ffa79a871e959 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Sat, 30 Nov 2024 14:45:22 -0600 Subject: [PATCH 5/6] Simplify language specific documentation --- docs/platforms/python/feature-flags/index.mdx | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/platforms/python/feature-flags/index.mdx b/docs/platforms/python/feature-flags/index.mdx index 978b25a5cc904..b77e134c41b1d 100644 --- a/docs/platforms/python/feature-flags/index.mdx +++ b/docs/platforms/python/feature-flags/index.mdx @@ -1,27 +1,24 @@ --- title: Set Up Feature Flags sidebar_order: 5200 -description: Learn how to set up feature flag evaluation tracking and feature flag change tracking. +description: With Feature Flags, Sentry tracks flag evaluations in your application and reports their state on error. Sentry will also record an audit log of feature flag changes and report any suspicious changes that may have triggered an error. --- -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. -To set up **feature flag evaluation tracking**, you will need to set up your language-specific SDK to include Sentry's feature flag integration. +## Enable Evaluation Tracking + +Evaluation tracking requires enabling an SDK integration. Integrations are provider specific. Documentation for supported providers is listed below. -Learn more about the integrations available for Python and how to set them up: - [OpenFeature](/platforms/python/integrations/openfeature/) - [LaunchDarkly](/platforms/python/integrations/launchdarkly/) -Please read the note below to ensure that you also complete one additional step. - - - -In order to take full advantage of the feature flag capabilities Sentry offers, there is an additional setup step needed, which is setting up your integration-specific webhook. This is needed to enable **feature flag change tracking**, so that your integration may communicate feature flag changes to Sentry. Learn how to set this up by [reading the docs](/product/explore/feature-flags/#set-up-your-integration-specific-webhook). +## Enable Change Tracking - \ No newline at end of file +Change tracking requires registering a Sentry webhook with your feature flag provider. Set up varies by provider and is documented in detail [here](/product/explore/feature-flags/#set-up-your-integration-specific-webhook). From 00bdf2271e0d96d57cdddb41c70e2ea34e144e63 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Sat, 30 Nov 2024 14:50:17 -0600 Subject: [PATCH 6/6] Add prereqs --- docs/platforms/python/feature-flags/index.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/platforms/python/feature-flags/index.mdx b/docs/platforms/python/feature-flags/index.mdx index b77e134c41b1d..ae3bdad215921 100644 --- a/docs/platforms/python/feature-flags/index.mdx +++ b/docs/platforms/python/feature-flags/index.mdx @@ -10,7 +10,9 @@ description: With Feature Flags, Sentry tracks flag evaluations in your applicat -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. +## Prerequisites + +* You have the Python SDK installed (version 2.18.0 or higher). ## Enable Evaluation Tracking