FeatureFlags

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 sent to Sentry when an error occurs. At the moment, we only support boolean flag evaluations.

Import names: Sentry.featureFlagsIntegration and type Sentry.FeatureFlagsIntegration

Copied
import * as Sentry from '@sentry/browser';

Sentry.init({
  dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0',
  integrations: [Sentry.featureFlagsIntegration()]
});

const flagsIntegration = Sentry.getClient()?
  .getIntegrationByName<Sentry.FeatureFlagsIntegration>('FeatureFlags');
if (flagsIntegration) {
  flagsIntegration.addFeatureFlag('test-flag', false);
} else {
  // Something went wrong, check your DSN and/or integrations
}
Sentry.captureException(new Error('Something went wrong!'));

Visit the Sentry website and confirm that your error event has recorded the feature flag "test-flag" and its value "false".

Help improve this content
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").