From 080b765fce10685c38084793c4d5c4d56229b134 Mon Sep 17 00:00:00 2001 From: aliu39 <159852527+aliu39@users.noreply.github.com> Date: Mon, 13 Jan 2025 23:54:26 -0800 Subject: [PATCH 1/6] init --- .../configuration/integrations/unleash.mdx | 40 +++++++++++++++++++ .../configuration/unleash/javascript.mdx | 24 +++++++++++ 2 files changed, 64 insertions(+) create mode 100644 docs/platforms/javascript/common/configuration/integrations/unleash.mdx create mode 100644 platform-includes/configuration/unleash/javascript.mdx diff --git a/docs/platforms/javascript/common/configuration/integrations/unleash.mdx b/docs/platforms/javascript/common/configuration/integrations/unleash.mdx new file mode 100644 index 0000000000000..0027248a3d023 --- /dev/null +++ b/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 +--- + + + + + +This integration only works inside a browser environment. It is only available from a package-based install (e.g. `npm` or `yarn`). + + + +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.TODO: or higher.** + +_Import names: `Sentry.unleashIntegration`_ + + + +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.mdx b/platform-includes/configuration/unleash/javascript.mdx new file mode 100644 index 0000000000000..1a753cbec1479 --- /dev/null +++ b/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(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!")); +``` From 80bd50cc08b87876353a3c7fd3931cb7e8545f21 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Tue, 14 Jan 2025 00:25:52 -0800 Subject: [PATCH 2/6] Add platform content --- .../unleash/javascript.ember.mdx | 24 +++++++++++++++++++ .../unleash/javascript.gatsby.mdx | 24 +++++++++++++++++++ .../unleash/javascript.nextjs.mdx | 24 +++++++++++++++++++ .../configuration/unleash/javascript.nuxt.mdx | 24 +++++++++++++++++++ .../unleash/javascript.react.mdx | 24 +++++++++++++++++++ .../unleash/javascript.remix.mdx | 24 +++++++++++++++++++ .../unleash/javascript.solid.mdx | 24 +++++++++++++++++++ .../unleash/javascript.solidstart.mdx | 24 +++++++++++++++++++ .../unleash/javascript.svelte.mdx | 24 +++++++++++++++++++ .../unleash/javascript.sveltekit.mdx | 24 +++++++++++++++++++ .../configuration/unleash/javascript.vue.mdx | 24 +++++++++++++++++++ 11 files changed, 264 insertions(+) create mode 100644 platform-includes/configuration/unleash/javascript.ember.mdx create mode 100644 platform-includes/configuration/unleash/javascript.gatsby.mdx create mode 100644 platform-includes/configuration/unleash/javascript.nextjs.mdx create mode 100644 platform-includes/configuration/unleash/javascript.nuxt.mdx create mode 100644 platform-includes/configuration/unleash/javascript.react.mdx create mode 100644 platform-includes/configuration/unleash/javascript.remix.mdx create mode 100644 platform-includes/configuration/unleash/javascript.solid.mdx create mode 100644 platform-includes/configuration/unleash/javascript.solidstart.mdx create mode 100644 platform-includes/configuration/unleash/javascript.svelte.mdx create mode 100644 platform-includes/configuration/unleash/javascript.sveltekit.mdx create mode 100644 platform-includes/configuration/unleash/javascript.vue.mdx diff --git a/platform-includes/configuration/unleash/javascript.ember.mdx b/platform-includes/configuration/unleash/javascript.ember.mdx new file mode 100644 index 0000000000000..d3beede108efd --- /dev/null +++ b/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(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.gatsby.mdx b/platform-includes/configuration/unleash/javascript.gatsby.mdx new file mode 100644 index 0000000000000..0b0974c5f95cd --- /dev/null +++ b/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(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.nextjs.mdx b/platform-includes/configuration/unleash/javascript.nextjs.mdx new file mode 100644 index 0000000000000..333b187837f11 --- /dev/null +++ b/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(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.nuxt.mdx b/platform-includes/configuration/unleash/javascript.nuxt.mdx new file mode 100644 index 0000000000000..fedde3366e363 --- /dev/null +++ b/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(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.react.mdx b/platform-includes/configuration/unleash/javascript.react.mdx new file mode 100644 index 0000000000000..cc318174f21eb --- /dev/null +++ b/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(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.remix.mdx b/platform-includes/configuration/unleash/javascript.remix.mdx new file mode 100644 index 0000000000000..0647a416d9631 --- /dev/null +++ b/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(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.solid.mdx b/platform-includes/configuration/unleash/javascript.solid.mdx new file mode 100644 index 0000000000000..86acf2f629ab5 --- /dev/null +++ b/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(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.solidstart.mdx b/platform-includes/configuration/unleash/javascript.solidstart.mdx new file mode 100644 index 0000000000000..8142ea812f66e --- /dev/null +++ b/platform-includes/configuration/unleash/javascript.solidstart.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/solidstart"; +import { UnleashClient } from "unleash-proxy-client"; + +Sentry.init({ + dsn: "___PUBLIC_DSN___", + integrations: [Sentry.unleashIntegration(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.svelte.mdx b/platform-includes/configuration/unleash/javascript.svelte.mdx new file mode 100644 index 0000000000000..8c8d9dd92ca88 --- /dev/null +++ b/platform-includes/configuration/unleash/javascript.svelte.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/svelte"; +import { UnleashClient } from "unleash-proxy-client"; + +Sentry.init({ + dsn: "___PUBLIC_DSN___", + integrations: [Sentry.unleashIntegration(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.sveltekit.mdx b/platform-includes/configuration/unleash/javascript.sveltekit.mdx new file mode 100644 index 0000000000000..453b7d3c57a41 --- /dev/null +++ b/platform-includes/configuration/unleash/javascript.sveltekit.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/sveltekit"; +import { UnleashClient } from "unleash-proxy-client"; + +Sentry.init({ + dsn: "___PUBLIC_DSN___", + integrations: [Sentry.unleashIntegration(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!")); +``` diff --git a/platform-includes/configuration/unleash/javascript.vue.mdx b/platform-includes/configuration/unleash/javascript.vue.mdx new file mode 100644 index 0000000000000..42d3cea137f9c --- /dev/null +++ b/platform-includes/configuration/unleash/javascript.vue.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/vue"; +import { UnleashClient } from "unleash-proxy-client"; + +Sentry.init({ + dsn: "___PUBLIC_DSN___", + integrations: [Sentry.unleashIntegration(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!")); +``` From b50479e1c362fb90a736b53aaa4d116989f7c80d Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Tue, 14 Jan 2025 15:24:52 -0800 Subject: [PATCH 3/6] Add to integration table --- platform-includes/configuration/integrations/javascript.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/platform-includes/configuration/integrations/javascript.mdx b/platform-includes/configuration/integrations/javascript.mdx index ba419ec70729c..fc3a8d3d4954e 100644 --- a/platform-includes/configuration/integrations/javascript.mdx +++ b/platform-includes/configuration/integrations/javascript.mdx @@ -24,3 +24,4 @@ | [`replayCanvasIntegration`](./replaycanvas) | | | | ✓ | | | [`reportingObserverIntegration`](./reportingobserver) | | ✓ | | | | | [`sessionTimingIntegration`](./sessiontiming) | | | | | ✓ | +| [`unleashIntegration`](./unleash) | | | | | ✓ | From d85a80aa47503549051139eafa6e54e6d2532ef3 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Tue, 14 Jan 2025 16:23:55 -0800 Subject: [PATCH 4/6] Single quote (thanks cursor) --- .../configuration/unleash/javascript.ember.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.gatsby.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.nextjs.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.nuxt.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.react.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.remix.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.solid.mdx | 16 ++++++++-------- .../unleash/javascript.solidstart.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.svelte.mdx | 16 ++++++++-------- .../unleash/javascript.sveltekit.mdx | 16 ++++++++-------- .../configuration/unleash/javascript.vue.mdx | 16 ++++++++-------- 12 files changed, 96 insertions(+), 96 deletions(-) diff --git a/platform-includes/configuration/unleash/javascript.ember.mdx b/platform-includes/configuration/unleash/javascript.ember.mdx index d3beede108efd..5339ee6fabb08 100644 --- a/platform-includes/configuration/unleash/javascript.ember.mdx +++ b/platform-includes/configuration/unleash/javascript.ember.mdx @@ -1,24 +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"; +import * as Sentry from '@sentry/ember'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.gatsby.mdx b/platform-includes/configuration/unleash/javascript.gatsby.mdx index 0b0974c5f95cd..92ba6dc7c753a 100644 --- a/platform-includes/configuration/unleash/javascript.gatsby.mdx +++ b/platform-includes/configuration/unleash/javascript.gatsby.mdx @@ -1,24 +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"; +import * as Sentry from '@sentry/gatsby'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.mdx b/platform-includes/configuration/unleash/javascript.mdx index 1a753cbec1479..950e56825dd8d 100644 --- a/platform-includes/configuration/unleash/javascript.mdx +++ b/platform-includes/configuration/unleash/javascript.mdx @@ -1,24 +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"; +import * as Sentry from '@sentry/browser'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.nextjs.mdx b/platform-includes/configuration/unleash/javascript.nextjs.mdx index 333b187837f11..2d55ec59509b2 100644 --- a/platform-includes/configuration/unleash/javascript.nextjs.mdx +++ b/platform-includes/configuration/unleash/javascript.nextjs.mdx @@ -1,24 +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"; +import * as Sentry from '@sentry/nextjs'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.nuxt.mdx b/platform-includes/configuration/unleash/javascript.nuxt.mdx index fedde3366e363..0b4f018283d02 100644 --- a/platform-includes/configuration/unleash/javascript.nuxt.mdx +++ b/platform-includes/configuration/unleash/javascript.nuxt.mdx @@ -1,24 +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"; +import * as Sentry from '@sentry/nuxt'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.react.mdx b/platform-includes/configuration/unleash/javascript.react.mdx index cc318174f21eb..e520f39df76be 100644 --- a/platform-includes/configuration/unleash/javascript.react.mdx +++ b/platform-includes/configuration/unleash/javascript.react.mdx @@ -1,24 +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"; +import * as Sentry from '@sentry/react'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.remix.mdx b/platform-includes/configuration/unleash/javascript.remix.mdx index 0647a416d9631..d2b787dc73fa9 100644 --- a/platform-includes/configuration/unleash/javascript.remix.mdx +++ b/platform-includes/configuration/unleash/javascript.remix.mdx @@ -1,24 +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"; +import * as Sentry from '@sentry/remix'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.solid.mdx b/platform-includes/configuration/unleash/javascript.solid.mdx index 86acf2f629ab5..d8b74864772c1 100644 --- a/platform-includes/configuration/unleash/javascript.solid.mdx +++ b/platform-includes/configuration/unleash/javascript.solid.mdx @@ -1,24 +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"; +import * as Sentry from '@sentry/solid'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.solidstart.mdx b/platform-includes/configuration/unleash/javascript.solidstart.mdx index 8142ea812f66e..26dd95ec740d1 100644 --- a/platform-includes/configuration/unleash/javascript.solidstart.mdx +++ b/platform-includes/configuration/unleash/javascript.solidstart.mdx @@ -1,24 +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/solidstart"; -import { UnleashClient } from "unleash-proxy-client"; +import * as Sentry from '@sentry/solidstart'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.svelte.mdx b/platform-includes/configuration/unleash/javascript.svelte.mdx index 8c8d9dd92ca88..05075fba0efa4 100644 --- a/platform-includes/configuration/unleash/javascript.svelte.mdx +++ b/platform-includes/configuration/unleash/javascript.svelte.mdx @@ -1,24 +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/svelte"; -import { UnleashClient } from "unleash-proxy-client"; +import * as Sentry from '@sentry/svelte'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.sveltekit.mdx b/platform-includes/configuration/unleash/javascript.sveltekit.mdx index 453b7d3c57a41..9b32a3a6d5571 100644 --- a/platform-includes/configuration/unleash/javascript.sveltekit.mdx +++ b/platform-includes/configuration/unleash/javascript.sveltekit.mdx @@ -1,24 +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/sveltekit"; -import { UnleashClient } from "unleash-proxy-client"; +import * as Sentry from '@sentry/sveltekit'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` diff --git a/platform-includes/configuration/unleash/javascript.vue.mdx b/platform-includes/configuration/unleash/javascript.vue.mdx index 42d3cea137f9c..94ff64fba625c 100644 --- a/platform-includes/configuration/unleash/javascript.vue.mdx +++ b/platform-includes/configuration/unleash/javascript.vue.mdx @@ -1,24 +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/vue"; -import { UnleashClient } from "unleash-proxy-client"; +import * as Sentry from '@sentry/vue'; +import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ - dsn: "___PUBLIC_DSN___", + dsn: '___PUBLIC_DSN___', integrations: [Sentry.unleashIntegration(UnleashClient)], }); const unleash = new UnleashClient({ - url: "https:///api/frontend", - clientKey: "", - appName: "my-webapp", + 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"); +unleash.isEnabled('test-flag'); -Sentry.captureException(new Error("Something went wrong!")); +Sentry.captureException(new Error('Something went wrong!')); ``` From 27ca5aa55778e6e16b361037d41f241463411c96 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Tue, 21 Jan 2025 11:47:09 -0800 Subject: [PATCH 5/6] Update setup code integration params --- platform-includes/configuration/unleash/javascript.ember.mdx | 2 +- platform-includes/configuration/unleash/javascript.gatsby.mdx | 2 +- platform-includes/configuration/unleash/javascript.mdx | 2 +- platform-includes/configuration/unleash/javascript.nextjs.mdx | 2 +- platform-includes/configuration/unleash/javascript.nuxt.mdx | 2 +- platform-includes/configuration/unleash/javascript.react.mdx | 2 +- platform-includes/configuration/unleash/javascript.remix.mdx | 2 +- platform-includes/configuration/unleash/javascript.solid.mdx | 2 +- .../configuration/unleash/javascript.solidstart.mdx | 2 +- platform-includes/configuration/unleash/javascript.svelte.mdx | 2 +- .../configuration/unleash/javascript.sveltekit.mdx | 2 +- platform-includes/configuration/unleash/javascript.vue.mdx | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/platform-includes/configuration/unleash/javascript.ember.mdx b/platform-includes/configuration/unleash/javascript.ember.mdx index 5339ee6fabb08..e053ce33712aa 100644 --- a/platform-includes/configuration/unleash/javascript.ember.mdx +++ b/platform-includes/configuration/unleash/javascript.ember.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.gatsby.mdx b/platform-includes/configuration/unleash/javascript.gatsby.mdx index 92ba6dc7c753a..e04bcf48bba6b 100644 --- a/platform-includes/configuration/unleash/javascript.gatsby.mdx +++ b/platform-includes/configuration/unleash/javascript.gatsby.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.mdx b/platform-includes/configuration/unleash/javascript.mdx index 950e56825dd8d..c818cedfdd040 100644 --- a/platform-includes/configuration/unleash/javascript.mdx +++ b/platform-includes/configuration/unleash/javascript.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.nextjs.mdx b/platform-includes/configuration/unleash/javascript.nextjs.mdx index 2d55ec59509b2..6a3afd7ef2992 100644 --- a/platform-includes/configuration/unleash/javascript.nextjs.mdx +++ b/platform-includes/configuration/unleash/javascript.nextjs.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.nuxt.mdx b/platform-includes/configuration/unleash/javascript.nuxt.mdx index 0b4f018283d02..a3bcd9dfb3696 100644 --- a/platform-includes/configuration/unleash/javascript.nuxt.mdx +++ b/platform-includes/configuration/unleash/javascript.nuxt.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.react.mdx b/platform-includes/configuration/unleash/javascript.react.mdx index e520f39df76be..d1f31117c7e1a 100644 --- a/platform-includes/configuration/unleash/javascript.react.mdx +++ b/platform-includes/configuration/unleash/javascript.react.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.remix.mdx b/platform-includes/configuration/unleash/javascript.remix.mdx index d2b787dc73fa9..192a3bfaa1db6 100644 --- a/platform-includes/configuration/unleash/javascript.remix.mdx +++ b/platform-includes/configuration/unleash/javascript.remix.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.solid.mdx b/platform-includes/configuration/unleash/javascript.solid.mdx index d8b74864772c1..ff8e03545c9ea 100644 --- a/platform-includes/configuration/unleash/javascript.solid.mdx +++ b/platform-includes/configuration/unleash/javascript.solid.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.solidstart.mdx b/platform-includes/configuration/unleash/javascript.solidstart.mdx index 26dd95ec740d1..369cf7803e0d9 100644 --- a/platform-includes/configuration/unleash/javascript.solidstart.mdx +++ b/platform-includes/configuration/unleash/javascript.solidstart.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.svelte.mdx b/platform-includes/configuration/unleash/javascript.svelte.mdx index 05075fba0efa4..eea7c36e70934 100644 --- a/platform-includes/configuration/unleash/javascript.svelte.mdx +++ b/platform-includes/configuration/unleash/javascript.svelte.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.sveltekit.mdx b/platform-includes/configuration/unleash/javascript.sveltekit.mdx index 9b32a3a6d5571..2443707b18877 100644 --- a/platform-includes/configuration/unleash/javascript.sveltekit.mdx +++ b/platform-includes/configuration/unleash/javascript.sveltekit.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ diff --git a/platform-includes/configuration/unleash/javascript.vue.mdx b/platform-includes/configuration/unleash/javascript.vue.mdx index 94ff64fba625c..e284125f818c5 100644 --- a/platform-includes/configuration/unleash/javascript.vue.mdx +++ b/platform-includes/configuration/unleash/javascript.vue.mdx @@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client'; Sentry.init({ dsn: '___PUBLIC_DSN___', - integrations: [Sentry.unleashIntegration(UnleashClient)], + integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})], }); const unleash = new UnleashClient({ From 117b372648c2f40dfab0a93a9ce3f7ed1f0eef33 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Wed, 22 Jan 2025 10:16:03 -0800 Subject: [PATCH 6/6] Fill in min version --- .../javascript/common/configuration/integrations/unleash.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/javascript/common/configuration/integrations/unleash.mdx b/docs/platforms/javascript/common/configuration/integrations/unleash.mdx index 0027248a3d023..765f61b3f2440 100644 --- a/docs/platforms/javascript/common/configuration/integrations/unleash.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/unleash.mdx @@ -29,7 +29,7 @@ This integration only works inside a browser environment. It is only available f -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.TODO: or higher.** +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`_