Unleash
Learn how to use Sentry with Unleash.
Currently in Beta
Feature flag change tracking and feature flag evaluation tracking is currently in open beta.
The Unleash 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 sentry-sdk (>=TODO:) and UnleashClient (>=6.0.1) from PyPI.
pip install --upgrade sentry-sdk UnleashClient
Add a UnleashIntegration to your integrations list:
import sentry_sdk
import os
from sentry_sdk.integrations.unleash import UnleashIntegration
from UnleashClient import UnleashClient
unleash_client = UnleashClient(
url="<Unleash server URL>/api/", # "http://localhost:4242/api/" if you are self-hosting Unleash.
app_name="my-app", # Identifies your app in the Unleash UI.
custom_headers={"Authorization": os.environ["UNLEASH_CLIENT_API_TOKEN"]}
)
unleash_integration = UnleashIntegration(unleash_client)
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
integrations=[
unleash_integration,
],
)
For more information on how to use Unleash, read Unleash's Python reference and quickstart guide.
The integration is tested by evaluating a feature flag using your Unleash SDK before capturing an exception.
import sentry_sdk
# Re-use `unleash_client` from the previous step.
test_flag_enabled = unleash_client.is_enabled("test-flag")
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 is equal to test_flag_enabled.
Next Steps
- 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 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. Your feature flag provider needs to notify Sentry when a feature flag definition has changed. A Sentry webhook URL can be registered with your provider. Learn how.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").