From bf215f80fb552c4cfb00c04423360373d99cf00f Mon Sep 17 00:00:00 2001 From: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com> Date: Tue, 26 Nov 2024 23:59:40 -0800 Subject: [PATCH 1/2] docs(flags): add js index page --- .../javascript/common/feature-flags/index.mdx | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/platforms/javascript/common/feature-flags/index.mdx diff --git a/docs/platforms/javascript/common/feature-flags/index.mdx b/docs/platforms/javascript/common/feature-flags/index.mdx new file mode 100644 index 00000000000000..215b0f88277363 --- /dev/null +++ b/docs/platforms/javascript/common/feature-flags/index.mdx @@ -0,0 +1,45 @@ +--- +title: Set Up Feature Flags +sidebar_order: 7000 +notSupported: + - javascript.aws-lambda + - javascript.azure-functions + - javascript.bun + - javascript.capacitor + - javascript.cloudflare + - javascript.connect + - javascript.cordova + - javascript.deno + - javascript.electron + - javascript.express + - javascript.fastify + - javascript.gcp-functions + - javascript.hapi + - javascript.koa + - javascript.nestjs + - javascript.nodejs + - javascript.wasm +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. + +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 JavaScript and how to set them up: +- [OpenFeature](/platforms/javascript/integrations/openfeature/) +- [LaunchDarkly](/platforms/javascript/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). + + \ No newline at end of file From e6da6193b1e8f56599ef099395eed3e5552f29eb Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Sat, 30 Nov 2024 14:55:00 -0600 Subject: [PATCH 2/2] Simplify language --- .../javascript/common/feature-flags/index.mdx | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/platforms/javascript/common/feature-flags/index.mdx b/docs/platforms/javascript/common/feature-flags/index.mdx index 215b0f88277363..01df9acf985447 100644 --- a/docs/platforms/javascript/common/feature-flags/index.mdx +++ b/docs/platforms/javascript/common/feature-flags/index.mdx @@ -19,27 +19,26 @@ notSupported: - javascript.nestjs - javascript.nodejs - javascript.wasm -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. +## Prerequisites -To set up **feature flag evaluation tracking**, you will need to set up your language-specific SDK to include Sentry's feature flag integration. +* You have the Javascript SDK installed (version 8.41.0-beta.0 or higher). -Learn more about the integrations available for JavaScript and how to set them up: -- [OpenFeature](/platforms/javascript/integrations/openfeature/) -- [LaunchDarkly](/platforms/javascript/integrations/launchdarkly/) +## Enable Evaluation Tracking -Please read the note below to ensure that you also complete one additional step. +Evaluation tracking requires enabling an SDK integration. Integrations are provider specific. Documentation for supported providers is listed below. - +- [OpenFeature](/platforms/javascript/integrations/openfeature/) +- [LaunchDarkly](/platforms/javascript/integrations/launchdarkly/) -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).