diff --git a/docs/platforms/javascript/common/configuration/integrations/unleash.mdx b/docs/platforms/javascript/common/configuration/integrations/unleash.mdx index 9f9d84cf5965d2..cc0ca6f3b1cd99 100644 --- a/docs/platforms/javascript/common/configuration/integrations/unleash.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/unleash.mdx @@ -33,8 +33,16 @@ The [Unleash](https://www.getunleash.io/) integration tracks feature flag evalua _Import names: `Sentry.unleashIntegration`_ +Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). + + + +The `unleashClientClass` option has been renamed to `featureFlagClientClass` in v9 of the Sentry SDK. Please update accordingly. + + + Visit the Sentry website and confirm that your error event has recorded the feature flag "test-flag" and its value "false". diff --git a/platform-includes/configuration/unleash/javascript.ember.mdx b/platform-includes/configuration/unleash/javascript.ember.mdx index e053ce33712aaa..52574d79b372ba 100644 --- a/platform-includes/configuration/unleash/javascript.ember.mdx +++ b/platform-includes/configuration/unleash/javascript.ember.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/ember'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/ember'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.gatsby.mdx b/platform-includes/configuration/unleash/javascript.gatsby.mdx index e04bcf48bba6bc..11afaddf3cf88b 100644 --- a/platform-includes/configuration/unleash/javascript.gatsby.mdx +++ b/platform-includes/configuration/unleash/javascript.gatsby.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/gatsby'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/gatsby'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.mdx b/platform-includes/configuration/unleash/javascript.mdx index c818cedfdd040e..55bbdd835af953 100644 --- a/platform-includes/configuration/unleash/javascript.mdx +++ b/platform-includes/configuration/unleash/javascript.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/browser'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/browser'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.nextjs.mdx b/platform-includes/configuration/unleash/javascript.nextjs.mdx index 6a3afd7ef2992a..8dd8564f8b0116 100644 --- a/platform-includes/configuration/unleash/javascript.nextjs.mdx +++ b/platform-includes/configuration/unleash/javascript.nextjs.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/nextjs'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/nextjs'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.nuxt.mdx b/platform-includes/configuration/unleash/javascript.nuxt.mdx index a3bcd9dfb3696b..f59454149f4814 100644 --- a/platform-includes/configuration/unleash/javascript.nuxt.mdx +++ b/platform-includes/configuration/unleash/javascript.nuxt.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/nuxt'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/nuxt'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.react.mdx b/platform-includes/configuration/unleash/javascript.react.mdx index d1f31117c7e1a9..f09d1a3b1dd060 100644 --- a/platform-includes/configuration/unleash/javascript.react.mdx +++ b/platform-includes/configuration/unleash/javascript.react.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/react'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/react'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.remix.mdx b/platform-includes/configuration/unleash/javascript.remix.mdx index 192a3bfaa1db68..473f08b386ce10 100644 --- a/platform-includes/configuration/unleash/javascript.remix.mdx +++ b/platform-includes/configuration/unleash/javascript.remix.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/remix'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/remix'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.solid.mdx b/platform-includes/configuration/unleash/javascript.solid.mdx index ff8e03545c9eac..bd1647272a1f49 100644 --- a/platform-includes/configuration/unleash/javascript.solid.mdx +++ b/platform-includes/configuration/unleash/javascript.solid.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/solid'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/solid'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.solidstart.mdx b/platform-includes/configuration/unleash/javascript.solidstart.mdx index 369cf7803e0d91..44f735ff02d550 100644 --- a/platform-includes/configuration/unleash/javascript.solidstart.mdx +++ b/platform-includes/configuration/unleash/javascript.solidstart.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/solidstart'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/solidstart'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.svelte.mdx b/platform-includes/configuration/unleash/javascript.svelte.mdx index eea7c36e709347..dd338d049754a7 100644 --- a/platform-includes/configuration/unleash/javascript.svelte.mdx +++ b/platform-includes/configuration/unleash/javascript.svelte.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/svelte'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/svelte'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.sveltekit.mdx b/platform-includes/configuration/unleash/javascript.sveltekit.mdx index 2443707b188773..f7f15705b276f7 100644 --- a/platform-includes/configuration/unleash/javascript.sveltekit.mdx +++ b/platform-includes/configuration/unleash/javascript.sveltekit.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/sveltekit'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/sveltekit'; import { UnleashClient } from 'unleash-proxy-client'; diff --git a/platform-includes/configuration/unleash/javascript.vue.mdx b/platform-includes/configuration/unleash/javascript.vue.mdx index e284125f818c5e..5c1a6e0db7b435 100644 --- a/platform-includes/configuration/unleash/javascript.vue.mdx +++ b/platform-includes/configuration/unleash/javascript.vue.mdx @@ -1,6 +1,27 @@ -Before using this integration, you need to install and instrument Unleash in your app. Learn more by reading [Unleash's SDK reference](https://docs.getunleash.io/reference/sdks/javascript-browser) and [quickstart](https://docs.getunleash.io/quickstart). +```javascript {tabTitle: JavaScript} +import * as Sentry from '@sentry/vue'; +import { UnleashClient } from 'unleash-proxy-client'; + +Sentry.init({ + dsn: '___PUBLIC_DSN___', + integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})], +}); + +const unleash = new UnleashClient({ + url: 'https:///api/frontend', + clientKey: '', + appName: 'my-webapp', +}); + +unleash.start(); + +// Evaluate a flag with a default value. You may have to wait for your client to synchronize first. +unleash.isEnabled('test-flag'); + +Sentry.captureException(new Error('Something went wrong!')); +``` -```javascript +```javascript {tabTitle: JavaScript (deprecated)} import * as Sentry from '@sentry/vue'; import { UnleashClient } from 'unleash-proxy-client';