From 2261158630376d917cbbf061d2ca702f8a7ecec5 Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> Date: Tue, 26 Nov 2024 23:34:39 -0800 Subject: [PATCH 1/3] docs(flags): update python onboarding docs to include second step --- docs/platforms/python/integrations/launchdarkly/index.mdx | 8 ++++++++ docs/platforms/python/integrations/openfeature/index.mdx | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/platforms/python/integrations/launchdarkly/index.mdx b/docs/platforms/python/integrations/launchdarkly/index.mdx index 15e30d19710ef..94d8b6aa995bc 100644 --- a/docs/platforms/python/integrations/launchdarkly/index.mdx +++ b/docs/platforms/python/integrations/launchdarkly/index.mdx @@ -44,3 +44,11 @@ sentry_sdk.capture_exception(Exception("Something went wrong!")) ``` Visit the Sentry website and confirm that your error event has recorded the feature flag "hello" and its value "false". + +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). + + \ No newline at end of file diff --git a/docs/platforms/python/integrations/openfeature/index.mdx b/docs/platforms/python/integrations/openfeature/index.mdx index 0f287aa539bd5..95e8375adbde1 100644 --- a/docs/platforms/python/integrations/openfeature/index.mdx +++ b/docs/platforms/python/integrations/openfeature/index.mdx @@ -44,3 +44,11 @@ sentry_sdk.capture_exception(Exception("Something went wrong!")) ``` Visit the Sentry website and confirm that your error event has recorded the feature flag "hello" and its value "false". + +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). + + \ No newline at end of file From ab443b4fd7a074b3cdcfb11a9eab6e01c24298c5 Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> Date: Tue, 26 Nov 2024 23:45:42 -0800 Subject: [PATCH 2/3] add beta label --- docs/platforms/python/integrations/launchdarkly/index.mdx | 6 ++++++ docs/platforms/python/integrations/openfeature/index.mdx | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/docs/platforms/python/integrations/launchdarkly/index.mdx b/docs/platforms/python/integrations/launchdarkly/index.mdx index 94d8b6aa995bc..09885483d65e0 100644 --- a/docs/platforms/python/integrations/launchdarkly/index.mdx +++ b/docs/platforms/python/integrations/launchdarkly/index.mdx @@ -3,6 +3,12 @@ title: LaunchDarkly description: "Learn about the LaunchDarkly integration and how to add it to your integrations list." --- + + +The support for **feature flag change tracking** and **feature flag evaluation tracking** is currently in beta. + + + The [LaunchDarkly](https://launchdarkly.com/) integration tracks feature flag evaluations produced by the LaunchDarkly SDK. These evaluations are held in memory and, in the event an error occurs, sent to Sentry for review and analysis. ## Install diff --git a/docs/platforms/python/integrations/openfeature/index.mdx b/docs/platforms/python/integrations/openfeature/index.mdx index 95e8375adbde1..042e1abbc9018 100644 --- a/docs/platforms/python/integrations/openfeature/index.mdx +++ b/docs/platforms/python/integrations/openfeature/index.mdx @@ -3,6 +3,12 @@ title: OpenFeature description: "Learn about the OpenFeature integration and how to add it to your integrations list." --- + + +The support for **feature flag change tracking** and **feature flag evaluation tracking** is currently in beta. + + + The [OpenFeature](https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature SDK. These evaluations are held in memory and, in the event an error occurs, sent to Sentry for review and analysis. ## Install From 71cedded4399193c694d8f8c68f0ba31f02b13ac Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> Date: Wed, 27 Nov 2024 10:04:59 -0800 Subject: [PATCH 3/3] make component reusable --- docs/platforms/python/integrations/launchdarkly/index.mdx | 6 +----- docs/platforms/python/integrations/openfeature/index.mdx | 8 +------- platform-includes/feature-flags/_default.mdx | 8 ++++++++ 3 files changed, 10 insertions(+), 12 deletions(-) create mode 100644 platform-includes/feature-flags/_default.mdx diff --git a/docs/platforms/python/integrations/launchdarkly/index.mdx b/docs/platforms/python/integrations/launchdarkly/index.mdx index 09885483d65e0..1fabe5c9ffe2a 100644 --- a/docs/platforms/python/integrations/launchdarkly/index.mdx +++ b/docs/platforms/python/integrations/launchdarkly/index.mdx @@ -51,10 +51,6 @@ sentry_sdk.capture_exception(Exception("Something went wrong!")) Visit the Sentry website and confirm that your error event has recorded the feature flag "hello" and its value "false". -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). - - \ No newline at end of file diff --git a/docs/platforms/python/integrations/openfeature/index.mdx b/docs/platforms/python/integrations/openfeature/index.mdx index 042e1abbc9018..598c81ecaac1e 100644 --- a/docs/platforms/python/integrations/openfeature/index.mdx +++ b/docs/platforms/python/integrations/openfeature/index.mdx @@ -51,10 +51,4 @@ sentry_sdk.capture_exception(Exception("Something went wrong!")) Visit the Sentry website and confirm that your error event has recorded the feature flag "hello" and its value "false". -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). - - \ No newline at end of file + \ No newline at end of file diff --git a/platform-includes/feature-flags/_default.mdx b/platform-includes/feature-flags/_default.mdx new file mode 100644 index 0000000000000..f6fcd4cd07ef9 --- /dev/null +++ b/platform-includes/feature-flags/_default.mdx @@ -0,0 +1,8 @@ +Please read the note below to ensure that you also complete one additional step. + + + +- **Track feature flag evaluations in other parts of your codebase.** If needed, you can set up evaluation tracking for more than one SDK. [Read the docs](/product/explore/feature-flags/#set-up-your-language-specific-sdk) to learn more. +- **Set up your change tracking webhook.** 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