diff --git a/docs/platforms/python/integrations/feature-flags/unleash.mdx b/docs/platforms/python/integrations/feature-flags/unleash.mdx new file mode 100644 index 0000000000000..04c4d25d11f11 --- /dev/null +++ b/docs/platforms/python/integrations/feature-flags/unleash.mdx @@ -0,0 +1,62 @@ +--- +title: Unleash +description: "Learn how to use Sentry with Unleash." +--- + + + +The [Unleash](https://www.getunleash.io/) integration tracks feature flag evaluations produced by the Unleash 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.3) and `UnleashClient` (>=6.0.1) from PyPI. + +```bash +pip install --upgrade sentry-sdk UnleashClient +``` + +## Configure + +Add `UnleashIntegration` to your `integrations` list: + +```python +import sentry_sdk +from sentry_sdk.integrations.unleash import UnleashIntegration + +sentry_sdk.init( + dsn="___PUBLIC_DSN___", + integrations=[UnleashIntegration()], +) +``` + +For more information on how to use Unleash, read Unleash's [Python reference](https://docs.getunleash.io/reference/sdks/python) and [quickstart guide](https://docs.getunleash.io/quickstart). + +## Verify + +Test the integration by evaluating a feature flag using your Unleash SDK before capturing an exception. + +```python {tabTitle: Python, using is_enabled} +import sentry_sdk +from UnleashClient import UnleashClient + +unleash_client = UnleashClient(...) # See Unleash quickstart. +test_flag_enabled = unleash_client.is_enabled("test-flag") + +sentry_sdk.capture_exception(Exception("Something went wrong!")) +``` + +```python {tabTitle: Python, using get_variant} +import sentry_sdk +from UnleashClient import UnleashClient + +unleash_client = UnleashClient(...) # See Unleash quickstart. +test_flag_variant = unleash_client.get_variant("test-flag") +test_flag_enabled = test_flag_variant["enabled"] + +sentry_sdk.capture_exception(Exception("Something went wrong!")) +``` + +Visit the [Sentry website](https://sentry.io/issues/) and confirm that your error +event has recorded the feature flag "test-flag", and its value is equal to `test_flag_enabled`. + + diff --git a/docs/platforms/python/integrations/index.mdx b/docs/platforms/python/integrations/index.mdx index 53a8ae661d5e1..ec53c3df76812 100644 --- a/docs/platforms/python/integrations/index.mdx +++ b/docs/platforms/python/integrations/index.mdx @@ -65,6 +65,7 @@ The Sentry SDK uses integrations to hook into the functionality of popular libra | ----------------------------------------------------------------------------------------------------------------------- | :--------------: | | | | | | | +| | | ### Cloud Computing