feat(flags): document JS Unleash integration (#12338)

Documents

feat(flags/v8): Add Unleash integration sentry-javascript#14948
Released in v8.51.0
Closes getsentry/team-replay#514

Author: aliu39

docs/platforms/javascript/common/configuration/integrations/unleash.mdx

@@ -0,0 +1,40 @@
+---
+title: Unleash
+description: "Learn how to use Sentry with Unleash."
+notSupported:
+  - javascript.aws-lambda
+  - javascript.azure-functions
+  - javascript.bun
+  - javascript.capacitor
+  - javascript.cloudflare
+  - javascript.connect
+  - javascript.cordova
+  - javascript.deno
+  - javascript.electron
+  - javascript.express
+  - javascript.fastify
+  - javascript.gcp-functions
+  - javascript.hapi
+  - javascript.koa
+  - javascript.nestjs
+  - javascript.nodejs
+  - javascript.wasm
+---
+
+<PlatformContent includePath="feature-flags/prerelease-alert" />
+
+<Alert level="info">
+
+This integration only works inside a browser environment. It is only available from a package-based install (e.g. `npm` or `yarn`).
+
+</Alert>
+
+The [Unleash](https://www.getunleash.io/) integration tracks feature flag evaluations produced by the Unleash 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.** This integration is available in Sentry SDK **versions 8.51.0 or higher.**
+
+_Import names: `Sentry.unleashIntegration`_
+
+<PlatformContent includePath="/configuration/unleash" />
+
+Visit the Sentry website and confirm that your error event has recorded the feature flag "test-flag" and its value "false".
+
+<PlatformContent includePath="feature-flags/next-steps" />

platform-includes/configuration/integrations/javascript.mdx

@@ -27,3 +27,4 @@
 | [`replayCanvasIntegration`](./replaycanvas)           |                  |            |             |     ✓      |                        |
 | [`reportingObserverIntegration`](./reportingobserver) |                  |     ✓      |             |            |                        |
 | [`sessionTimingIntegration`](./sessiontiming)         |                  |            |             |            |           ✓            |
+| [`unleashIntegration`](./unleash)                     |                  |            |             |            |           ✓            |

platform-includes/configuration/unleash/javascript.ember.mdx

@@ -0,0 +1,24 @@
+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
+import * as Sentry from '@sentry/ember';
+import { UnleashClient } from 'unleash-proxy-client';
+
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+});
+
+const unleash = new UnleashClient({
+  url: 'https://<your-unleash-instance>/api/frontend',
+  clientKey: '<your-client-side-token>',
+  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!'));
+```

platform-includes/configuration/unleash/javascript.gatsby.mdx

@@ -0,0 +1,24 @@
+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
+import * as Sentry from '@sentry/gatsby';
+import { UnleashClient } from 'unleash-proxy-client';
+
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+});
+
+const unleash = new UnleashClient({
+  url: 'https://<your-unleash-instance>/api/frontend',
+  clientKey: '<your-client-side-token>',
+  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!'));
+```

platform-includes/configuration/unleash/javascript.mdx

@@ -0,0 +1,24 @@
+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
+import * as Sentry from '@sentry/browser';
+import { UnleashClient } from 'unleash-proxy-client';
+
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+});
+
+const unleash = new UnleashClient({
+  url: 'https://<your-unleash-instance>/api/frontend',
+  clientKey: '<your-client-side-token>',
+  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!'));
+```

platform-includes/configuration/unleash/javascript.nextjs.mdx

@@ -0,0 +1,24 @@
+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
+import * as Sentry from '@sentry/nextjs';
+import { UnleashClient } from 'unleash-proxy-client';
+
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+});
+
+const unleash = new UnleashClient({
+  url: 'https://<your-unleash-instance>/api/frontend',
+  clientKey: '<your-client-side-token>',
+  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!'));
+```

platform-includes/configuration/unleash/javascript.nuxt.mdx

@@ -0,0 +1,24 @@
+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
+import * as Sentry from '@sentry/nuxt';
+import { UnleashClient } from 'unleash-proxy-client';
+
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+});
+
+const unleash = new UnleashClient({
+  url: 'https://<your-unleash-instance>/api/frontend',
+  clientKey: '<your-client-side-token>',
+  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!'));
+```

platform-includes/configuration/unleash/javascript.react.mdx

@@ -0,0 +1,24 @@
+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
+import * as Sentry from '@sentry/react';
+import { UnleashClient } from 'unleash-proxy-client';
+
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+});
+
+const unleash = new UnleashClient({
+  url: 'https://<your-unleash-instance>/api/frontend',
+  clientKey: '<your-client-side-token>',
+  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!'));
+```

platform-includes/configuration/unleash/javascript.remix.mdx

@@ -0,0 +1,24 @@
+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
+import * as Sentry from '@sentry/remix';
+import { UnleashClient } from 'unleash-proxy-client';
+
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+});
+
+const unleash = new UnleashClient({
+  url: 'https://<your-unleash-instance>/api/frontend',
+  clientKey: '<your-client-side-token>',
+  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!'));
+```

platform-includes/configuration/unleash/javascript.solid.mdx

@@ -0,0 +1,24 @@
+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
+import * as Sentry from '@sentry/solid';
+import { UnleashClient } from 'unleash-proxy-client';
+
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+});
+
+const unleash = new UnleashClient({
+  url: 'https://<your-unleash-instance>/api/frontend',
+  clientKey: '<your-client-side-token>',
+  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!'));
+```