OpenFeature
Learn how to use Sentry with OpenFeature.
Currently in Beta
Feature flag change tracking and feature flag evaluation tracking is currently in open beta.
This integration only works inside a browser environment.
The OpenFeature 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. At the moment, we only support boolean flag evaluations.
Import name: Sentry.openFeatureIntegration and Sentry.OpenFeatureIntegrationHook
Install your platform's Sentry SDK and @openfeature/web-sdk from npm.
import * as Sentry from '@sentry/browser';
import { OpenFeature } from '@openfeature/web-sdk';
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
integrations: [Sentry.openFeatureIntegration()]
});
OpenFeature.setProvider(new MyProviderOfChoice());
// Option 1: track all OpenFeature evaluations.
OpenFeature.addHooks(new Sentry.OpenFeatureIntegrationHook());
// Option 2: only track evaluations by a specific client.
const client = OpenFeature.getClient();
client.addHooks(new Sentry.OpenFeatureIntegrationHook());
Learn more about OpenFeature providers and the web SDK.
The integration is tested by evaluating a feature flag with your OpenFeature SDK before capturing an exception.
import * as Sentry from '@sentry/browser';
import { OpenFeature } from '@openfeature/web-sdk';
// Evaluate a flag with a default value. If you added the hook to a client in
// the Configure step, make sure to use the same client here.
const client = OpenFeature.getClient();
const result = client.getBooleanValue('hello', false);
Sentry.captureException(Exception("Something went wrong!"))
Visit the Sentry website and confirm that your error event has recorded the feature flag "hello" and its value "false".
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").