From 394301104d5d3d1f94cd91c1dde6f3a053fc6a34 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Fri, 20 Dec 2024 14:05:07 -0600 Subject: [PATCH 01/19] Add generic provider docs --- .../feature-flag/self-serve/index.mdx | 57 +++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 docs/organization/integrations/feature-flag/self-serve/index.mdx diff --git a/docs/organization/integrations/feature-flag/self-serve/index.mdx b/docs/organization/integrations/feature-flag/self-serve/index.mdx new file mode 100644 index 0000000000000..aec090393b574 --- /dev/null +++ b/docs/organization/integrations/feature-flag/self-serve/index.mdx @@ -0,0 +1,57 @@ +--- +title: Self-Serve +sidebar_order: 1 +description: Learn about Sentry's self-serve feature-flag integrations. +--- + +## Evaluation Tracking + +Sentry can track flag evaluations as they happen within your application. 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 page documentation](/product/issues/issue-details/#feature-flags). + +### Set Up Evaluation Tracking + +To set up evaluation tracking visit the [explore page](/product/explore/feature-flags/) and select the language and SDK of your choice. Not using a supported SDK? That's okay. We support self-serve integrations with your existing system. + +To set up self-serve evaluation tracking visit one of our supported languages pages: +* [JavaScript](/platforms/javascript/configuration/integrations/self-serve/) +* [Python](/platforms/python/integrations/self-serve/) + +## Change Tracking + +Sentry can track changes to feature flag definitions and report suspicious feature flag edits. + +Sentry offers a change tracking feature which functions as an audit-log of feature flag changes. When a feature flag definition changes in your back-end you can emit a web hook to Sentry. + +### API Documentation + +If you're using a self-serve integration it means you will likelyneed to write code to support this endpoint. This section documents our authentication proceedures as well as the resource's fields and structure. + +#### Authentication + +Authentication is performed using a "signing secret". The "signing secret" must be used to sign the web hook payload in your feature flagging system. Signing the payload with your secret produces a "signature". Sentry needs this signature so it can compare the results of our signing function to yours. Both sides must use the same signing function. Sentry uses a HMAC SHA256 hex-digest of the web hook payload. In Python this function looks like: + +```python +def hmac_sha256_hex_digest(secret: str, message: bytes): + return hmac.new(secret.encode(), message, hashlib.sha256).hexdigest() +``` + +The result of this function must be sent as a header to Sentry: `X-Sentry-Signature signature_result`. + +#### API Blueprint + +[An API blueprint is available at this permalink](https://github.com/getsentry/sentry/blob/ed324708947ca26392d6579ed76b93fc94a61ab6/src/sentry/flags/docs/api.md#create-generic-flag-log-post). We strive to keep this page updated. Be sure to check the latest master branch for new protocol versions. We will always maintain backwards compatibility so there is no harm in implementing an old version. However, new versions might introduce new features. + +### 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) 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. +2. **Register the webhook URL**. + - Copy the provided Sentry webhook URL and configure your feature flagging system to emit web hooks to this URL. +3. **Set the Signing Secret**. + - In your feature flagging system's UI retries the "Signing Secret". + - Copy the signing secret in the revealed input box and paste it into the input box labeled "Secret" in Sentry. + - Save the secret by clicking "Save Secret" in the Sentry fly out. + +Once saved Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint. From 3724ffd9e9b3e93bc08c2dc5664f41001432e792 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Fri, 20 Dec 2024 15:02:28 -0600 Subject: [PATCH 02/19] Add SDK docs and links --- .../{featureflags.mdx => self-serve.mdx} | 2 +- .../javascript/common/feature-flags/index.mdx | 2 +- docs/platforms/python/feature-flags/index.mdx | 2 +- .../python/integrations/self-serve/index.mdx | 50 +++++++++++++++++++ docs/product/explore/feature-flags/index.mdx | 1 + 5 files changed, 54 insertions(+), 3 deletions(-) rename docs/platforms/javascript/common/configuration/integrations/{featureflags.mdx => self-serve.mdx} (97%) create mode 100644 docs/platforms/python/integrations/self-serve/index.mdx diff --git a/docs/platforms/javascript/common/configuration/integrations/featureflags.mdx b/docs/platforms/javascript/common/configuration/integrations/self-serve.mdx similarity index 97% rename from docs/platforms/javascript/common/configuration/integrations/featureflags.mdx rename to docs/platforms/javascript/common/configuration/integrations/self-serve.mdx index 718234edd9b85..c0a4ce3de6be3 100644 --- a/docs/platforms/javascript/common/configuration/integrations/featureflags.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/self-serve.mdx @@ -1,5 +1,5 @@ --- -title: FeatureFlags +title: Self-Serve Feature Flags Integration description: "Learn how to attach custom feature flag data to Sentry error events." notSupported: - javascript.aws-lambda diff --git a/docs/platforms/javascript/common/feature-flags/index.mdx b/docs/platforms/javascript/common/feature-flags/index.mdx index 5f36fc2280c0c..d187b1497baf5 100644 --- a/docs/platforms/javascript/common/feature-flags/index.mdx +++ b/docs/platforms/javascript/common/feature-flags/index.mdx @@ -33,6 +33,6 @@ description: With Feature Flags, Sentry tracks feature flag evaluations in your Evaluation tracking requires enabling an SDK integration. Integrations are provider specific. Documentation for supported providers is listed below. - [OpenFeature](/platforms/javascript/configuration/integrations/openfeature/) - [LaunchDarkly](/platforms/javascript/configuration/integrations/launchdarkly/) -- [Generic Support](/platforms/javascript/configuration/integrations/featureflags/) - if you use an unsupported or in-house provider, you may manually track evaluations through an API. +- [Self-Serve](/platforms/javascript/configuration/integrations/self-serve/) diff --git a/docs/platforms/python/feature-flags/index.mdx b/docs/platforms/python/feature-flags/index.mdx index f715a9529535c..f779ade8f7ae1 100644 --- a/docs/platforms/python/feature-flags/index.mdx +++ b/docs/platforms/python/feature-flags/index.mdx @@ -16,6 +16,6 @@ Evaluation tracking requires enabling an SDK integration. Integrations are provi - [OpenFeature](/platforms/python/integrations/openfeature/) - [LaunchDarkly](/platforms/python/integrations/launchdarkly/) -- [Generic Support](/platforms/javascript/configuration/integrations/featureflags/) - if you use an unsupported or in-house provider, you may manually track evaluations through an API. +- [Self-Serve](/platforms/python/integrations/self-serve/) diff --git a/docs/platforms/python/integrations/self-serve/index.mdx b/docs/platforms/python/integrations/self-serve/index.mdx new file mode 100644 index 0000000000000..f7a9d09d66ffc --- /dev/null +++ b/docs/platforms/python/integrations/self-serve/index.mdx @@ -0,0 +1,50 @@ +--- +title: Self Serve Feature Flags +description: "Learn how to attach custom feature flag data to Sentry error events." +--- + + + +The Feature Flags integration allows you to manually track feature flag evaluations through an API. These evaluations are held in memory, and in the event an error occurs, sent to Sentry for review and analysis. +**At the moment, we only support boolean flag evaluations.** + +## Install + +Install `sentry-sdk` from PyPI. + +```bash +pip install --upgrade 'sentry-sdk' +``` + +## Configure + +Add `FeatureFlagsIntegration()` to your `integrations` list: + +```python +import sentry_sdk +from sentry_sdk.integrations.featureflags import FeatureFlagsIntegration + +sentry_sdk.init( + dsn="___PUBLIC_DSN___", + integrations=[ + FeatureFlagsIntegration(), + ], +) +``` + +## Verify + +The integration is tested by calling the `add_feature_flag` API before capturing an exception. + +```python +import sentry_sdk +from sentry_sdk.integrations.featureflags import add_feature_flag + +add_feature_flag('test-flag', False) + +sentry_sdk.capture_exception(Exception("Something went wrong!")) +``` + +Visit the Sentry website and confirm that your error event has recorded the feature flag "test-flag" and its value "false". + + diff --git a/docs/product/explore/feature-flags/index.mdx b/docs/product/explore/feature-flags/index.mdx index 1a1cce3aa5ce3..30387fa62a153 100644 --- a/docs/product/explore/feature-flags/index.mdx +++ b/docs/product/explore/feature-flags/index.mdx @@ -30,3 +30,4 @@ Change tracking enables Sentry to listen for additions, removals, and modificati To set up change tracking, visit the webhook integration documentation for your provider: * [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking) +* [Self-Serve](/organization/integrations/feature-flag/self-serve/#change-tracking) From 1f646d3449264b49bdb6ab94c69ee2af1ec5be40 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Fri, 3 Jan 2025 13:25:07 -0600 Subject: [PATCH 03/19] Minor fixes --- docs/organization/integrations/feature-flag/index.mdx | 3 ++- .../integrations/feature-flag/self-serve/index.mdx | 10 +++++----- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/organization/integrations/feature-flag/index.mdx b/docs/organization/integrations/feature-flag/index.mdx index de239ebe90528..05d49ac0dd643 100644 --- a/docs/organization/integrations/feature-flag/index.mdx +++ b/docs/organization/integrations/feature-flag/index.mdx @@ -4,5 +4,6 @@ sidebar_order: 90 description: "Learn more about Sentry's feature flag integrations." --- -- [Split](/organization/integrations/feature-flag/split/) - [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) +- [Self-serve](/organization/integrations/feature-flag/self-serve/) +- [Split](/organization/integrations/feature-flag/split/) diff --git a/docs/organization/integrations/feature-flag/self-serve/index.mdx b/docs/organization/integrations/feature-flag/self-serve/index.mdx index aec090393b574..6d81d2f0d28a2 100644 --- a/docs/organization/integrations/feature-flag/self-serve/index.mdx +++ b/docs/organization/integrations/feature-flag/self-serve/index.mdx @@ -24,7 +24,7 @@ Sentry offers a change tracking feature which functions as an audit-log of featu ### API Documentation -If you're using a self-serve integration it means you will likelyneed to write code to support this endpoint. This section documents our authentication proceedures as well as the resource's fields and structure. +If you're using a self-serve integration it means you will likely need to write code to support this endpoint. This section documents our authentication proceedures as well as the resource's fields and structure. #### Authentication @@ -45,13 +45,13 @@ The result of this function must be sent as a header to Sentry: `X-Sentry-Signat 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) in a new tab. Then follow the steps listed below. -1. **Click the "Add New Provider" button. +1. **Click the "Add New Provider" button.** - One webhook secret can be registered per provider type. 2. **Register the webhook URL**. - Copy the provided Sentry webhook URL and configure your feature flagging system to emit web hooks to this URL. 3. **Set the Signing Secret**. - - In your feature flagging system's UI retries the "Signing Secret". - - Copy the signing secret in the revealed input box and paste it into the input box labeled "Secret" in Sentry. - - Save the secret by clicking "Save Secret" in the Sentry fly out. + - In your feature flagging system's UI find the "Signing Secret". + - Copy the signing secret and paste it into the input box labeled "Secret" in Sentry. + - In Sentry, save the secret by clicking "Save Secret". Once saved Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint. From 2243d7a7328f5e6ab86c5bf6f90bb79363ddecf8 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Fri, 3 Jan 2025 13:27:18 -0600 Subject: [PATCH 04/19] Wording Co-authored-by: Alex Krawiec --- docs/platforms/python/integrations/self-serve/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/python/integrations/self-serve/index.mdx b/docs/platforms/python/integrations/self-serve/index.mdx index f7a9d09d66ffc..604fd6d568803 100644 --- a/docs/platforms/python/integrations/self-serve/index.mdx +++ b/docs/platforms/python/integrations/self-serve/index.mdx @@ -45,6 +45,6 @@ add_feature_flag('test-flag', False) sentry_sdk.capture_exception(Exception("Something went wrong!")) ``` -Visit the Sentry website and confirm that your error event has recorded the feature flag "test-flag" and its value "false". +Go to your Sentry project and confirm that your error event has recorded the feature flag "test-flag" and its value "false". From b10c0da997ba5b5f9305e045aaeeb951ff8d6fcb Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Fri, 3 Jan 2025 13:27:36 -0600 Subject: [PATCH 05/19] Missing word Co-authored-by: Alex Krawiec --- .../organization/integrations/feature-flag/self-serve/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/organization/integrations/feature-flag/self-serve/index.mdx b/docs/organization/integrations/feature-flag/self-serve/index.mdx index 6d81d2f0d28a2..eda2935a113e9 100644 --- a/docs/organization/integrations/feature-flag/self-serve/index.mdx +++ b/docs/organization/integrations/feature-flag/self-serve/index.mdx @@ -6,7 +6,7 @@ description: Learn about Sentry's self-serve feature-flag integrations. ## Evaluation Tracking -Sentry can track flag evaluations as they happen within your application. 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 page documentation](/product/issues/issue-details/#feature-flags). +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 From 50f6e191fb84987a2fc0d95a720c3c033537337c Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Fri, 3 Jan 2025 13:29:39 -0600 Subject: [PATCH 06/19] Fix wording --- .../organization/integrations/feature-flag/self-serve/index.mdx | 2 +- docs/platforms/python/integrations/self-serve/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/organization/integrations/feature-flag/self-serve/index.mdx b/docs/organization/integrations/feature-flag/self-serve/index.mdx index 6d81d2f0d28a2..d1cfd55056ea7 100644 --- a/docs/organization/integrations/feature-flag/self-serve/index.mdx +++ b/docs/organization/integrations/feature-flag/self-serve/index.mdx @@ -24,7 +24,7 @@ Sentry offers a change tracking feature which functions as an audit-log of featu ### API Documentation -If you're using a self-serve integration it means you will likely need to write code to support this endpoint. This section documents our authentication proceedures as well as the resource's fields and structure. +If you're using a self-serve integration it means you will likely need to write code to support this endpoint. This section documents our authentication procedures as well as the resource's fields and structure. #### Authentication diff --git a/docs/platforms/python/integrations/self-serve/index.mdx b/docs/platforms/python/integrations/self-serve/index.mdx index f7a9d09d66ffc..1943167e9e560 100644 --- a/docs/platforms/python/integrations/self-serve/index.mdx +++ b/docs/platforms/python/integrations/self-serve/index.mdx @@ -1,5 +1,5 @@ --- -title: Self Serve Feature Flags +title: Self-Serve Feature Flags description: "Learn how to attach custom feature flag data to Sentry error events." --- From 5aff5ecd96ff8db2cb4ef3af2b1bff602e4dce0e Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Fri, 3 Jan 2025 15:15:41 -0600 Subject: [PATCH 07/19] Test nesting --- docs/platforms/python/integrations/feature-flags/index.mdx | 6 ++++++ .../python/integrations/feature-flags/launchdarkly.mdx | 6 ++++++ .../python/integrations/feature-flags/openfeature.mdx | 6 ++++++ 3 files changed, 18 insertions(+) create mode 100644 docs/platforms/python/integrations/feature-flags/index.mdx create mode 100644 docs/platforms/python/integrations/feature-flags/launchdarkly.mdx create mode 100644 docs/platforms/python/integrations/feature-flags/openfeature.mdx diff --git a/docs/platforms/python/integrations/feature-flags/index.mdx b/docs/platforms/python/integrations/feature-flags/index.mdx new file mode 100644 index 0000000000000..5a2f210003488 --- /dev/null +++ b/docs/platforms/python/integrations/feature-flags/index.mdx @@ -0,0 +1,6 @@ +--- +title: Test nested +description: "Learn about using Sentry with FastAPI." +--- + +root diff --git a/docs/platforms/python/integrations/feature-flags/launchdarkly.mdx b/docs/platforms/python/integrations/feature-flags/launchdarkly.mdx new file mode 100644 index 0000000000000..219386410c89d --- /dev/null +++ b/docs/platforms/python/integrations/feature-flags/launchdarkly.mdx @@ -0,0 +1,6 @@ +--- +title: Test nested LD +description: "Learn about using Sentry with FastAPI." +--- + +launchdarkly diff --git a/docs/platforms/python/integrations/feature-flags/openfeature.mdx b/docs/platforms/python/integrations/feature-flags/openfeature.mdx new file mode 100644 index 0000000000000..8bdcdf37c61c8 --- /dev/null +++ b/docs/platforms/python/integrations/feature-flags/openfeature.mdx @@ -0,0 +1,6 @@ +--- +title: Test nested OF +description: "Learn about using Sentry with FastAPI." +--- + +open feature From e14f0b52fa075639825f4d7fc2f8b72fa439e164 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Mon, 6 Jan 2025 14:46:15 -0600 Subject: [PATCH 08/19] Move to nested structure --- .../index.mdx => feature-flags/generic.mdx} | 0 .../integrations/feature-flags/index.mdx | 4 +- .../feature-flags/launchdarkly.mdx | 50 +++++++++++++++++-- .../feature-flags/openfeature.mdx | 50 +++++++++++++++++-- .../integrations/launchdarkly/index.mdx | 50 ------------------- .../python/integrations/openfeature/index.mdx | 50 ------------------- 6 files changed, 96 insertions(+), 108 deletions(-) rename docs/platforms/python/integrations/{self-serve/index.mdx => feature-flags/generic.mdx} (100%) delete mode 100644 docs/platforms/python/integrations/launchdarkly/index.mdx delete mode 100644 docs/platforms/python/integrations/openfeature/index.mdx diff --git a/docs/platforms/python/integrations/self-serve/index.mdx b/docs/platforms/python/integrations/feature-flags/generic.mdx similarity index 100% rename from docs/platforms/python/integrations/self-serve/index.mdx rename to docs/platforms/python/integrations/feature-flags/generic.mdx diff --git a/docs/platforms/python/integrations/feature-flags/index.mdx b/docs/platforms/python/integrations/feature-flags/index.mdx index 5a2f210003488..4807e666a20ec 100644 --- a/docs/platforms/python/integrations/feature-flags/index.mdx +++ b/docs/platforms/python/integrations/feature-flags/index.mdx @@ -1,6 +1,6 @@ --- title: Test nested -description: "Learn about using Sentry with FastAPI." +description: "Learn about using Feature Flags with Sentry." --- -root +Sentry offers a variety of SDK implementations. See the sidebar for more options. diff --git a/docs/platforms/python/integrations/feature-flags/launchdarkly.mdx b/docs/platforms/python/integrations/feature-flags/launchdarkly.mdx index 219386410c89d..e642fb0826a86 100644 --- a/docs/platforms/python/integrations/feature-flags/launchdarkly.mdx +++ b/docs/platforms/python/integrations/feature-flags/launchdarkly.mdx @@ -1,6 +1,50 @@ --- -title: Test nested LD -description: "Learn about using Sentry with FastAPI." +title: LaunchDarkly +description: "Learn how to use Sentry with LaunchDarkly." --- -launchdarkly + + +The [LaunchDarkly](https://launchdarkly.com/) integration tracks feature flag evaluations produced by the LaunchDarkly SDK. These evaluations are held in memory and sent to Sentry for review and analysis if an error occurs. **At the moment, we only support boolean flag evaluations.** + +## Install + +Install `sentry-sdk` (>=2.19.2) from PyPI. + +```bash +pip install --upgrade 'sentry-sdk' +``` + +## Configure + +Add `LaunchDarklyIntegration()` to your `integrations` list: + +```python +import sentry_sdk +from sentry_sdk.integrations.launchdarkly import LaunchDarklyIntegration + +sentry_sdk.init( + dsn="___PUBLIC_DSN___", + integrations=[ + LaunchDarklyIntegration(), + ], +) +``` + +## Verify + +The integration is tested by evaluating a feature flag using your LaunchDarkly SDK before capturing an exception. + +```python +import ldclient +import sentry_sdk + +client = ldclient.get() +client.variation("hello", Context.create("test-context"), False) + +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". + + diff --git a/docs/platforms/python/integrations/feature-flags/openfeature.mdx b/docs/platforms/python/integrations/feature-flags/openfeature.mdx index 8bdcdf37c61c8..59b260e38699e 100644 --- a/docs/platforms/python/integrations/feature-flags/openfeature.mdx +++ b/docs/platforms/python/integrations/feature-flags/openfeature.mdx @@ -1,6 +1,50 @@ --- -title: Test nested OF -description: "Learn about using Sentry with FastAPI." +title: OpenFeature +description: "Learn how to use Sentry with OpenFeature." --- -open feature + + +The [OpenFeature](https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature SDK. These evaluations are held in memory and sent to Sentry for review and analysis if an error occurs. **At the moment, we only support boolean flag evaluations.** + +## Install + +Install `sentry-sdk` (>=2.19.2) from PyPI. + +```bash +pip install --upgrade 'sentry-sdk' +``` + +## Configure + +Add `OpenFeatureIntegration()` to your `integrations` list: + +```python +import sentry_sdk +from sentry_sdk.integrations.openfeature import OpenFeatureIntegration + +sentry_sdk.init( + dsn="___PUBLIC_DSN___", + integrations=[ + OpenFeatureIntegration(), + ], +) +``` + +## Verify + +The integration is tested by evaluating a feature flag using your OpenFeature SDK before capturing an exception. + +```python +from openfeature import api +import sentry_sdk + +client = api.get_client() +client.get_boolean_value("hello", default_value=False) + +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". + + diff --git a/docs/platforms/python/integrations/launchdarkly/index.mdx b/docs/platforms/python/integrations/launchdarkly/index.mdx deleted file mode 100644 index e642fb0826a86..0000000000000 --- a/docs/platforms/python/integrations/launchdarkly/index.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: LaunchDarkly -description: "Learn how to use Sentry with LaunchDarkly." ---- - - - -The [LaunchDarkly](https://launchdarkly.com/) integration tracks feature flag evaluations produced by the LaunchDarkly SDK. These evaluations are held in memory and sent to Sentry for review and analysis if an error occurs. **At the moment, we only support boolean flag evaluations.** - -## Install - -Install `sentry-sdk` (>=2.19.2) from PyPI. - -```bash -pip install --upgrade 'sentry-sdk' -``` - -## Configure - -Add `LaunchDarklyIntegration()` to your `integrations` list: - -```python -import sentry_sdk -from sentry_sdk.integrations.launchdarkly import LaunchDarklyIntegration - -sentry_sdk.init( - dsn="___PUBLIC_DSN___", - integrations=[ - LaunchDarklyIntegration(), - ], -) -``` - -## Verify - -The integration is tested by evaluating a feature flag using your LaunchDarkly SDK before capturing an exception. - -```python -import ldclient -import sentry_sdk - -client = ldclient.get() -client.variation("hello", Context.create("test-context"), False) - -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". - - diff --git a/docs/platforms/python/integrations/openfeature/index.mdx b/docs/platforms/python/integrations/openfeature/index.mdx deleted file mode 100644 index 59b260e38699e..0000000000000 --- a/docs/platforms/python/integrations/openfeature/index.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OpenFeature -description: "Learn how to use Sentry with OpenFeature." ---- - - - -The [OpenFeature](https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature SDK. These evaluations are held in memory and sent to Sentry for review and analysis if an error occurs. **At the moment, we only support boolean flag evaluations.** - -## Install - -Install `sentry-sdk` (>=2.19.2) from PyPI. - -```bash -pip install --upgrade 'sentry-sdk' -``` - -## Configure - -Add `OpenFeatureIntegration()` to your `integrations` list: - -```python -import sentry_sdk -from sentry_sdk.integrations.openfeature import OpenFeatureIntegration - -sentry_sdk.init( - dsn="___PUBLIC_DSN___", - integrations=[ - OpenFeatureIntegration(), - ], -) -``` - -## Verify - -The integration is tested by evaluating a feature flag using your OpenFeature SDK before capturing an exception. - -```python -from openfeature import api -import sentry_sdk - -client = api.get_client() -client.get_boolean_value("hello", default_value=False) - -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". - - From 0d39e3e19325ace567fa939a95e82dc706bcc414 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Mon, 6 Jan 2025 14:48:38 -0600 Subject: [PATCH 09/19] Update links --- .../integrations/feature-flag/launchdarkly/index.mdx | 2 +- docs/platforms/python/feature-flags/index.mdx | 6 +++--- docs/platforms/python/integrations/index.mdx | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/organization/integrations/feature-flag/launchdarkly/index.mdx b/docs/organization/integrations/feature-flag/launchdarkly/index.mdx index 24bbb9f490ca4..38b6a735a2496 100644 --- a/docs/organization/integrations/feature-flag/launchdarkly/index.mdx +++ b/docs/organization/integrations/feature-flag/launchdarkly/index.mdx @@ -12,7 +12,7 @@ Sentry can track flag evaluations as they happen within your application. Flag To set up evaluation tracking visit one of our supported languages pages: * [JavaScript](/platforms/javascript/configuration/integrations/launchdarkly/) -* [Python](/platforms/python/integrations/launchdarkly/) +* [Python](/platforms/python/integrations/feature-flags/launchdarkly/) ## Change Tracking diff --git a/docs/platforms/python/feature-flags/index.mdx b/docs/platforms/python/feature-flags/index.mdx index ea1c9510265cd..a9dc9e3d5ac8c 100644 --- a/docs/platforms/python/feature-flags/index.mdx +++ b/docs/platforms/python/feature-flags/index.mdx @@ -14,8 +14,8 @@ description: With Feature Flags, Sentry tracks feature flag evaluations in your Evaluation tracking requires enabling an SDK integration. Integrations are provider specific. Documentation for supported providers is listed below. -- [OpenFeature](/platforms/python/integrations/openfeature/) -- [LaunchDarkly](/platforms/python/integrations/launchdarkly/) -- [Self-Serve](/platforms/python/integrations/self-serve/) +- [OpenFeature](/platforms/python/integrations/feature-flags/openfeature/) +- [LaunchDarkly](/platforms/python/integrations/feature-flags/launchdarkly/) +- [Self-Serve](/platforms/python/integrations/feature-flags/generic/) diff --git a/docs/platforms/python/integrations/index.mdx b/docs/platforms/python/integrations/index.mdx index 076d473ef1dc6..53a8ae661d5e1 100644 --- a/docs/platforms/python/integrations/index.mdx +++ b/docs/platforms/python/integrations/index.mdx @@ -63,8 +63,8 @@ The Sentry SDK uses integrations to hook into the functionality of popular libra | | **Auto-enabled** | | ----------------------------------------------------------------------------------------------------------------------- | :--------------: | -| | | -| | | +| | | +| | | ### Cloud Computing From 585964481d9752a4f2d0fc1249456e62974d89b7 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Mon, 6 Jan 2025 14:49:33 -0600 Subject: [PATCH 10/19] Capitaliztion --- docs/organization/integrations/feature-flag/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/organization/integrations/feature-flag/index.mdx b/docs/organization/integrations/feature-flag/index.mdx index 05d49ac0dd643..891b0310ca16b 100644 --- a/docs/organization/integrations/feature-flag/index.mdx +++ b/docs/organization/integrations/feature-flag/index.mdx @@ -5,5 +5,5 @@ description: "Learn more about Sentry's feature flag integrations." --- - [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) -- [Self-serve](/organization/integrations/feature-flag/self-serve/) +- [Self-Serve](/organization/integrations/feature-flag/self-serve/) - [Split](/organization/integrations/feature-flag/split/) From 87d982d6d6ad4f4c7f25f902af0c5d89f61008f8 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Mon, 6 Jan 2025 14:58:17 -0600 Subject: [PATCH 11/19] Rename and update links --- .../organization/integrations/feature-flag/self-serve/index.mdx | 2 +- .../integrations/feature-flags/{generic.mdx => self-serve.mdx} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/platforms/python/integrations/feature-flags/{generic.mdx => self-serve.mdx} (100%) diff --git a/docs/organization/integrations/feature-flag/self-serve/index.mdx b/docs/organization/integrations/feature-flag/self-serve/index.mdx index 987842dc9f98e..9fd4361359cdb 100644 --- a/docs/organization/integrations/feature-flag/self-serve/index.mdx +++ b/docs/organization/integrations/feature-flag/self-serve/index.mdx @@ -14,7 +14,7 @@ To set up evaluation tracking visit the [explore page](/product/explore/feature- To set up self-serve evaluation tracking visit one of our supported languages pages: * [JavaScript](/platforms/javascript/configuration/integrations/self-serve/) -* [Python](/platforms/python/integrations/self-serve/) +* [Python](/platforms/python/integrations/feature-flags/self-serve/) ## Change Tracking diff --git a/docs/platforms/python/integrations/feature-flags/generic.mdx b/docs/platforms/python/integrations/feature-flags/self-serve.mdx similarity index 100% rename from docs/platforms/python/integrations/feature-flags/generic.mdx rename to docs/platforms/python/integrations/feature-flags/self-serve.mdx From 74fd323db40cb69afd6ebc46b58c29412e40f8f4 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Mon, 6 Jan 2025 14:59:02 -0600 Subject: [PATCH 12/19] Fix import path --- .../python/integrations/feature-flags/self-serve.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/python/integrations/feature-flags/self-serve.mdx b/docs/platforms/python/integrations/feature-flags/self-serve.mdx index b2319a76832e7..fbe7399ccb5dd 100644 --- a/docs/platforms/python/integrations/feature-flags/self-serve.mdx +++ b/docs/platforms/python/integrations/feature-flags/self-serve.mdx @@ -22,7 +22,7 @@ Add `FeatureFlagsIntegration()` to your `integrations` list: ```python import sentry_sdk -from sentry_sdk.integrations.featureflags import FeatureFlagsIntegration +from sentry_sdk.integrations.feature_flags import FeatureFlagsIntegration sentry_sdk.init( dsn="___PUBLIC_DSN___", @@ -38,7 +38,7 @@ The integration is tested by calling the `add_feature_flag` API before capturing ```python import sentry_sdk -from sentry_sdk.integrations.featureflags import add_feature_flag +from sentry_sdk.integrations.feature_flags import add_feature_flag add_feature_flag('test-flag', False) From 0014724548c1cab7ea4ab8558797973f58c52b65 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Mon, 6 Jan 2025 15:00:22 -0600 Subject: [PATCH 13/19] Rename to feature-flags --- .../integrations/feature-flag/index.mdx | 9 --------- .../integrations/feature-flags/index.mdx | 9 +++++++++ .../launchdarkly/img/ff-integration-ui.png | Bin .../launchdarkly/index.mdx | 0 .../self-serve/index.mdx | 0 .../split/img/split.png | Bin .../{feature-flag => feature-flags}/split/index.mdx | 0 docs/organization/integrations/index.mdx | 4 ++-- docs/organization/integrations/troubleshooting.mdx | 2 +- docs/product/explore/feature-flags/index.mdx | 4 ++-- redirects.js | 4 ++-- src/middleware.ts | 10 +++++----- 12 files changed, 21 insertions(+), 21 deletions(-) delete mode 100644 docs/organization/integrations/feature-flag/index.mdx create mode 100644 docs/organization/integrations/feature-flags/index.mdx rename docs/organization/integrations/{feature-flag => feature-flags}/launchdarkly/img/ff-integration-ui.png (100%) rename docs/organization/integrations/{feature-flag => feature-flags}/launchdarkly/index.mdx (100%) rename docs/organization/integrations/{feature-flag => feature-flags}/self-serve/index.mdx (100%) rename docs/organization/integrations/{feature-flag => feature-flags}/split/img/split.png (100%) rename docs/organization/integrations/{feature-flag => feature-flags}/split/index.mdx (100%) diff --git a/docs/organization/integrations/feature-flag/index.mdx b/docs/organization/integrations/feature-flag/index.mdx deleted file mode 100644 index 891b0310ca16b..0000000000000 --- a/docs/organization/integrations/feature-flag/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Feature Flag -sidebar_order: 90 -description: "Learn more about Sentry's feature flag integrations." ---- - -- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) -- [Self-Serve](/organization/integrations/feature-flag/self-serve/) -- [Split](/organization/integrations/feature-flag/split/) diff --git a/docs/organization/integrations/feature-flags/index.mdx b/docs/organization/integrations/feature-flags/index.mdx new file mode 100644 index 0000000000000..8b9af76bbe2c7 --- /dev/null +++ b/docs/organization/integrations/feature-flags/index.mdx @@ -0,0 +1,9 @@ +--- +title: Feature Flag +sidebar_order: 90 +description: "Learn more about Sentry's feature flag integrations." +--- + +- [LaunchDarkly](/organization/integrations/feature-flags/launchdarkly/) +- [Self-Serve](/organization/integrations/feature-flags/self-serve/) +- [Split](/organization/integrations/feature-flags/split/) diff --git a/docs/organization/integrations/feature-flag/launchdarkly/img/ff-integration-ui.png b/docs/organization/integrations/feature-flags/launchdarkly/img/ff-integration-ui.png similarity index 100% rename from docs/organization/integrations/feature-flag/launchdarkly/img/ff-integration-ui.png rename to docs/organization/integrations/feature-flags/launchdarkly/img/ff-integration-ui.png diff --git a/docs/organization/integrations/feature-flag/launchdarkly/index.mdx b/docs/organization/integrations/feature-flags/launchdarkly/index.mdx similarity index 100% rename from docs/organization/integrations/feature-flag/launchdarkly/index.mdx rename to docs/organization/integrations/feature-flags/launchdarkly/index.mdx diff --git a/docs/organization/integrations/feature-flag/self-serve/index.mdx b/docs/organization/integrations/feature-flags/self-serve/index.mdx similarity index 100% rename from docs/organization/integrations/feature-flag/self-serve/index.mdx rename to docs/organization/integrations/feature-flags/self-serve/index.mdx diff --git a/docs/organization/integrations/feature-flag/split/img/split.png b/docs/organization/integrations/feature-flags/split/img/split.png similarity index 100% rename from docs/organization/integrations/feature-flag/split/img/split.png rename to docs/organization/integrations/feature-flags/split/img/split.png diff --git a/docs/organization/integrations/feature-flag/split/index.mdx b/docs/organization/integrations/feature-flags/split/index.mdx similarity index 100% rename from docs/organization/integrations/feature-flag/split/index.mdx rename to docs/organization/integrations/feature-flags/split/index.mdx diff --git a/docs/organization/integrations/index.mdx b/docs/organization/integrations/index.mdx index 6d1633d668333..f4a81a0d67393 100644 --- a/docs/organization/integrations/index.mdx +++ b/docs/organization/integrations/index.mdx @@ -111,8 +111,8 @@ For more details, see the [full Integration Platform documentation](/organizatio | Integration | Tie errors to feature flags | | ---------------------------------------------------------------- | --------------------------- | -| [Split](/organization/integrations/feature-flag/split/) | X | -| [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) | X | +| [Split](/organization/integrations/feature-flags/split/) | X | +| [LaunchDarkly](/organization/integrations/feature-flags/launchdarkly/) | X | ## Compliance diff --git a/docs/organization/integrations/troubleshooting.mdx b/docs/organization/integrations/troubleshooting.mdx index b525ec7393697..e7c9df1d27e00 100644 --- a/docs/organization/integrations/troubleshooting.mdx +++ b/docs/organization/integrations/troubleshooting.mdx @@ -17,7 +17,7 @@ Sentry integrates with many third party services to make your development experi - [Netlify](/product/releases/setup/release-automation/netlify/) - [Vercel](/organization/integrations/deployment/vercel/) - [Grafana](/organization/integrations/data-visualization/grafana/) - - [Split](/organization/integrations/feature-flag/split/) + - [Split](/organization/integrations/feature-flags/split/) - [Segment](/organization/integrations/data-visualization/segment/) - [FullStory](/organization/integrations/session-replay/fullstory/) - [OpenReplay](/organization/integrations/session-replay/openreplay/) diff --git a/docs/product/explore/feature-flags/index.mdx b/docs/product/explore/feature-flags/index.mdx index 30387fa62a153..2800c61f2279a 100644 --- a/docs/product/explore/feature-flags/index.mdx +++ b/docs/product/explore/feature-flags/index.mdx @@ -29,5 +29,5 @@ Change tracking enables Sentry to listen for additions, removals, and modificati ### Set Up Change Tracking To set up change tracking, visit the webhook integration documentation for your provider: -* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking) -* [Self-Serve](/organization/integrations/feature-flag/self-serve/#change-tracking) +* [LaunchDarkly](/organization/integrations/feature-flags/launchdarkly/#change-tracking) +* [Self-Serve](/organization/integrations/feature-flags/self-serve/#change-tracking) diff --git a/redirects.js b/redirects.js index cbb7ecd3818da..c4e605631e8c9 100644 --- a/redirects.js +++ b/redirects.js @@ -236,7 +236,7 @@ const userDocsRedirects = [ }, { source: '/organization/integrations/launchdarkly/', - destination: '/organization/integrations/feature-flag/launchdarkly/', + destination: '/organization/integrations/feature-flags/launchdarkly/', }, { source: '/product/explore/session-replay/replay-details/', @@ -831,7 +831,7 @@ const userDocsRedirects = [ }, { source: '/organization/integrations/launchdarkly/', - destination: '/organization/integrations/feature-flag/launchdarkly/', + destination: '/organization/integrations/feature-flags/launchdarkly/', }, { source: diff --git a/src/middleware.ts b/src/middleware.ts index 7deefdd8ac336..a5bbf9286a194 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -107,7 +107,7 @@ const USER_DOCS_REDIRECTS: Redirect[] = [ }, { from: '/organization/integrations/split/', - to: '/organization/integrations/feature-flag/split/', + to: '/organization/integrations/feature-flags/split/', }, { from: '/organization/integrations/teamwork/', @@ -1977,19 +1977,19 @@ const USER_DOCS_REDIRECTS: Redirect[] = [ }, { from: '/workflow/integrations/split/', - to: '/product/integrations/feature-flag/split/', + to: '/product/integrations/feature-flags/split/', }, { from: '/workflow/integrations/global-integrations/split/', - to: '/product/integrations/feature-flag/split/', + to: '/product/integrations/feature-flags/split/', }, { from: '/product/integrations/split/', - to: '/product/integrations/feature-flag/split/', + to: '/product/integrations/feature-flags/split/', }, { from: '/product/integrations/launchdarkly/', - to: '/product/integrations/feature-flag/launchdarkly/', + to: '/product/integrations/feature-flags/launchdarkly/', }, { from: '/workflow/integrations/vercel/', From 3183f5de9d7097a9dfbf4e07fb415e4c7830e8ee Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Mon, 6 Jan 2025 15:01:07 -0600 Subject: [PATCH 14/19] Fix url --- 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 a9dc9e3d5ac8c..b55b1ab96f450 100644 --- a/docs/platforms/python/feature-flags/index.mdx +++ b/docs/platforms/python/feature-flags/index.mdx @@ -16,6 +16,6 @@ Evaluation tracking requires enabling an SDK integration. Integrations are provi - [OpenFeature](/platforms/python/integrations/feature-flags/openfeature/) - [LaunchDarkly](/platforms/python/integrations/feature-flags/launchdarkly/) -- [Self-Serve](/platforms/python/integrations/feature-flags/generic/) +- [Self-Serve](/platforms/python/integrations/feature-flags/self-serve/) From a84f24dc1d66e43dfe05ea70a067682e5ccc433f Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Mon, 6 Jan 2025 15:30:22 -0600 Subject: [PATCH 15/19] Remove placeholder wording Co-authored-by: Andrew Liu <159852527+aliu39@users.noreply.github.com> --- docs/platforms/python/integrations/feature-flags/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/python/integrations/feature-flags/index.mdx b/docs/platforms/python/integrations/feature-flags/index.mdx index 4807e666a20ec..0347cae609d35 100644 --- a/docs/platforms/python/integrations/feature-flags/index.mdx +++ b/docs/platforms/python/integrations/feature-flags/index.mdx @@ -1,6 +1,6 @@ --- -title: Test nested +title: Feature Flags description: "Learn about using Feature Flags with Sentry." --- -Sentry offers a variety of SDK implementations. See the sidebar for more options. +Sentry has integrations for a variety of feature flagging providers. See the sidebar for supported options. From 44de8ab7bb38c0c0be918e11d0d4d512a8aa808e Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Tue, 7 Jan 2025 08:40:32 -0600 Subject: [PATCH 16/19] More wording --- docs/platforms/python/integrations/feature-flags/index.mdx | 4 +++- .../python/integrations/feature-flags/self-serve.mdx | 5 ++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/platforms/python/integrations/feature-flags/index.mdx b/docs/platforms/python/integrations/feature-flags/index.mdx index 0347cae609d35..b5018499ae0e0 100644 --- a/docs/platforms/python/integrations/feature-flags/index.mdx +++ b/docs/platforms/python/integrations/feature-flags/index.mdx @@ -3,4 +3,6 @@ title: Feature Flags description: "Learn about using Feature Flags with Sentry." --- -Sentry has integrations for a variety of feature flagging providers. See the sidebar for supported options. +A feature flagging integration allows you to manually track feature flag evaluations through an API. These evaluations are collected in memory, and in the event an error occurs, sent to Sentry for review and analysis. + +Sentry has added support for a variety of providers. Click through the nested sidebar listings to learn more. diff --git a/docs/platforms/python/integrations/feature-flags/self-serve.mdx b/docs/platforms/python/integrations/feature-flags/self-serve.mdx index fbe7399ccb5dd..0356c52910971 100644 --- a/docs/platforms/python/integrations/feature-flags/self-serve.mdx +++ b/docs/platforms/python/integrations/feature-flags/self-serve.mdx @@ -1,12 +1,11 @@ --- -title: Self-Serve Feature Flags +title: Self-Serve description: "Learn how to attach custom feature flag data to Sentry error events." --- -The Feature Flags integration allows you to manually track feature flag evaluations through an API. These evaluations are held in memory, and in the event an error occurs, sent to Sentry for review and analysis. -**At the moment, we only support boolean flag evaluations.** +The Feature Flags integration allows you to manually track feature flag evaluations through an API. These evaluations are held in memory, and in the event an error occurs, sent to Sentry for review and analysis. Specifically, the self-serve integration enables users to integrate with proprietary (or otherwise unsupported) feature flagging solutions. **At the moment, we only support boolean flag evaluations.** ## Install From 15a287796cca12fd25cd224cbb2b1e5d583994c9 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Tue, 7 Jan 2025 08:49:15 -0600 Subject: [PATCH 17/19] Pluralize --- docs/organization/integrations/feature-flags/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/organization/integrations/feature-flags/index.mdx b/docs/organization/integrations/feature-flags/index.mdx index 8b9af76bbe2c7..a1e13c59fc2ae 100644 --- a/docs/organization/integrations/feature-flags/index.mdx +++ b/docs/organization/integrations/feature-flags/index.mdx @@ -1,5 +1,5 @@ --- -title: Feature Flag +title: Feature Flags sidebar_order: 90 description: "Learn more about Sentry's feature flag integrations." --- From 6bfa578c643885d5dee007d49511a00cb7dad059 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Tue, 7 Jan 2025 10:17:56 -0600 Subject: [PATCH 18/19] Use singular to fix search --- .../integrations/feature-flag/index.mdx | 9 +++++++++ .../launchdarkly/img/ff-integration-ui.png | Bin .../launchdarkly/index.mdx | 0 .../self-serve/index.mdx | 0 .../split/img/split.png | Bin .../{feature-flags => feature-flag}/split/index.mdx | 0 .../integrations/feature-flags/index.mdx | 9 --------- docs/organization/integrations/index.mdx | 4 ++-- docs/organization/integrations/troubleshooting.mdx | 2 +- docs/product/explore/feature-flags/index.mdx | 4 ++-- redirects.js | 4 ++-- src/middleware.ts | 2 +- 12 files changed, 17 insertions(+), 17 deletions(-) create mode 100644 docs/organization/integrations/feature-flag/index.mdx rename docs/organization/integrations/{feature-flags => feature-flag}/launchdarkly/img/ff-integration-ui.png (100%) rename docs/organization/integrations/{feature-flags => feature-flag}/launchdarkly/index.mdx (100%) rename docs/organization/integrations/{feature-flags => feature-flag}/self-serve/index.mdx (100%) rename docs/organization/integrations/{feature-flags => feature-flag}/split/img/split.png (100%) rename docs/organization/integrations/{feature-flags => feature-flag}/split/index.mdx (100%) delete mode 100644 docs/organization/integrations/feature-flags/index.mdx diff --git a/docs/organization/integrations/feature-flag/index.mdx b/docs/organization/integrations/feature-flag/index.mdx new file mode 100644 index 0000000000000..c8b14bd2ea953 --- /dev/null +++ b/docs/organization/integrations/feature-flag/index.mdx @@ -0,0 +1,9 @@ +--- +title: Feature Flags +sidebar_order: 90 +description: "Learn more about Sentry's feature flag integrations." +--- + +- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) +- [Self-Serve](/organization/integrations/feature-flag/self-serve/) +- [Split](/organization/integrations/feature-flag/split/) diff --git a/docs/organization/integrations/feature-flags/launchdarkly/img/ff-integration-ui.png b/docs/organization/integrations/feature-flag/launchdarkly/img/ff-integration-ui.png similarity index 100% rename from docs/organization/integrations/feature-flags/launchdarkly/img/ff-integration-ui.png rename to docs/organization/integrations/feature-flag/launchdarkly/img/ff-integration-ui.png diff --git a/docs/organization/integrations/feature-flags/launchdarkly/index.mdx b/docs/organization/integrations/feature-flag/launchdarkly/index.mdx similarity index 100% rename from docs/organization/integrations/feature-flags/launchdarkly/index.mdx rename to docs/organization/integrations/feature-flag/launchdarkly/index.mdx diff --git a/docs/organization/integrations/feature-flags/self-serve/index.mdx b/docs/organization/integrations/feature-flag/self-serve/index.mdx similarity index 100% rename from docs/organization/integrations/feature-flags/self-serve/index.mdx rename to docs/organization/integrations/feature-flag/self-serve/index.mdx diff --git a/docs/organization/integrations/feature-flags/split/img/split.png b/docs/organization/integrations/feature-flag/split/img/split.png similarity index 100% rename from docs/organization/integrations/feature-flags/split/img/split.png rename to docs/organization/integrations/feature-flag/split/img/split.png diff --git a/docs/organization/integrations/feature-flags/split/index.mdx b/docs/organization/integrations/feature-flag/split/index.mdx similarity index 100% rename from docs/organization/integrations/feature-flags/split/index.mdx rename to docs/organization/integrations/feature-flag/split/index.mdx diff --git a/docs/organization/integrations/feature-flags/index.mdx b/docs/organization/integrations/feature-flags/index.mdx deleted file mode 100644 index a1e13c59fc2ae..0000000000000 --- a/docs/organization/integrations/feature-flags/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Feature Flags -sidebar_order: 90 -description: "Learn more about Sentry's feature flag integrations." ---- - -- [LaunchDarkly](/organization/integrations/feature-flags/launchdarkly/) -- [Self-Serve](/organization/integrations/feature-flags/self-serve/) -- [Split](/organization/integrations/feature-flags/split/) diff --git a/docs/organization/integrations/index.mdx b/docs/organization/integrations/index.mdx index f4a81a0d67393..6d1633d668333 100644 --- a/docs/organization/integrations/index.mdx +++ b/docs/organization/integrations/index.mdx @@ -111,8 +111,8 @@ For more details, see the [full Integration Platform documentation](/organizatio | Integration | Tie errors to feature flags | | ---------------------------------------------------------------- | --------------------------- | -| [Split](/organization/integrations/feature-flags/split/) | X | -| [LaunchDarkly](/organization/integrations/feature-flags/launchdarkly/) | X | +| [Split](/organization/integrations/feature-flag/split/) | X | +| [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/) | X | ## Compliance diff --git a/docs/organization/integrations/troubleshooting.mdx b/docs/organization/integrations/troubleshooting.mdx index e7c9df1d27e00..b525ec7393697 100644 --- a/docs/organization/integrations/troubleshooting.mdx +++ b/docs/organization/integrations/troubleshooting.mdx @@ -17,7 +17,7 @@ Sentry integrates with many third party services to make your development experi - [Netlify](/product/releases/setup/release-automation/netlify/) - [Vercel](/organization/integrations/deployment/vercel/) - [Grafana](/organization/integrations/data-visualization/grafana/) - - [Split](/organization/integrations/feature-flags/split/) + - [Split](/organization/integrations/feature-flag/split/) - [Segment](/organization/integrations/data-visualization/segment/) - [FullStory](/organization/integrations/session-replay/fullstory/) - [OpenReplay](/organization/integrations/session-replay/openreplay/) diff --git a/docs/product/explore/feature-flags/index.mdx b/docs/product/explore/feature-flags/index.mdx index 2800c61f2279a..30387fa62a153 100644 --- a/docs/product/explore/feature-flags/index.mdx +++ b/docs/product/explore/feature-flags/index.mdx @@ -29,5 +29,5 @@ Change tracking enables Sentry to listen for additions, removals, and modificati ### Set Up Change Tracking To set up change tracking, visit the webhook integration documentation for your provider: -* [LaunchDarkly](/organization/integrations/feature-flags/launchdarkly/#change-tracking) -* [Self-Serve](/organization/integrations/feature-flags/self-serve/#change-tracking) +* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking) +* [Self-Serve](/organization/integrations/feature-flag/self-serve/#change-tracking) diff --git a/redirects.js b/redirects.js index c4e605631e8c9..cbb7ecd3818da 100644 --- a/redirects.js +++ b/redirects.js @@ -236,7 +236,7 @@ const userDocsRedirects = [ }, { source: '/organization/integrations/launchdarkly/', - destination: '/organization/integrations/feature-flags/launchdarkly/', + destination: '/organization/integrations/feature-flag/launchdarkly/', }, { source: '/product/explore/session-replay/replay-details/', @@ -831,7 +831,7 @@ const userDocsRedirects = [ }, { source: '/organization/integrations/launchdarkly/', - destination: '/organization/integrations/feature-flags/launchdarkly/', + destination: '/organization/integrations/feature-flag/launchdarkly/', }, { source: diff --git a/src/middleware.ts b/src/middleware.ts index a5bbf9286a194..03c3b01bebbe8 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -107,7 +107,7 @@ const USER_DOCS_REDIRECTS: Redirect[] = [ }, { from: '/organization/integrations/split/', - to: '/organization/integrations/feature-flags/split/', + to: '/organization/integrations/feature-flag/split/', }, { from: '/organization/integrations/teamwork/', From 38558fb826f1c809b81f921923a58dea7aded624 Mon Sep 17 00:00:00 2001 From: Colton Allen Date: Tue, 7 Jan 2025 10:49:04 -0600 Subject: [PATCH 19/19] Fix linkage --- src/middleware.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/middleware.ts b/src/middleware.ts index 03c3b01bebbe8..7deefdd8ac336 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -1977,19 +1977,19 @@ const USER_DOCS_REDIRECTS: Redirect[] = [ }, { from: '/workflow/integrations/split/', - to: '/product/integrations/feature-flags/split/', + to: '/product/integrations/feature-flag/split/', }, { from: '/workflow/integrations/global-integrations/split/', - to: '/product/integrations/feature-flags/split/', + to: '/product/integrations/feature-flag/split/', }, { from: '/product/integrations/split/', - to: '/product/integrations/feature-flags/split/', + to: '/product/integrations/feature-flag/split/', }, { from: '/product/integrations/launchdarkly/', - to: '/product/integrations/feature-flags/launchdarkly/', + to: '/product/integrations/feature-flag/launchdarkly/', }, { from: '/workflow/integrations/vercel/',