From ebbaddeabd1f86a59c326cdfb7c7270e77d296e3 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:32:12 -0800 Subject: [PATCH 1/3] feat(flags): add browser JS integration docs for Launchdarkly --- .../integrations/launchdarkly.mdx | 54 +++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx diff --git a/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx b/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx new file mode 100644 index 00000000000000..7660427e2c8a75 --- /dev/null +++ b/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx @@ -0,0 +1,54 @@ +--- +title: LaunchDarkly +description: "Attaches recent LD feature flag evaluations to error event context." +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. + + + +_Import name: `Sentry.launchDarklyIntegration` and `Sentry.buildLaunchDarklyFlagUsedHandler`_ + +The [LaunchDarkly](https://launchdarkly.com/) integration tracks feature flag evaluations produced by the LaunchDarkly SDK. These evaluations are held in memory and, in the event an error occurs, sent to Sentry for review and analysis. + +```JavaScript +import * as Sentry from '@sentry/browser'; +import * as LaunchDarkly from 'launchdarkly-js-client-sdk'; + +Sentry.init({integrations: [Sentry.launchDarklyIntegration()]}); + +const ldClient = LaunchDarkly.initialize( + 'my-client-ID', + {kind: 'user', key: 'my-user-context-key'}, + {inspectors: [Sentry.buildLaunchDarklyFlagUsedHandler()]} +); +const flagVal = ldClient.variation('my-flag', false); // evaluates a flag +``` + +Learn more about the LaunchDarkly SDK at https://docs.launchdarkly.com/sdk/client-side/javascript. +At the moment, **we do not officially support framework-specific LaunchDarkly +SDKs.** However, you may reuse this setup code for React and client-side Node.js. + +## Options + +There are no setup options for this configuration. From 3e34e42d6de463f998f0e01ab6fa8ca2bf4e88be Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Thu, 14 Nov 2024 14:02:39 -0800 Subject: [PATCH 2/3] Review comments --- .../common/configuration/integrations/launchdarkly.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx b/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx index 7660427e2c8a75..12a4daab866592 100644 --- a/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx @@ -1,6 +1,6 @@ --- title: LaunchDarkly -description: "Attaches recent LD feature flag evaluations to error event context." +description: "Attaches recent LaunchDarkly feature flag evaluations to error event context." notSupported: - javascript.aws-lambda - javascript.azure-functions @@ -29,7 +29,7 @@ This integration only works inside a browser environment. _Import name: `Sentry.launchDarklyIntegration` and `Sentry.buildLaunchDarklyFlagUsedHandler`_ -The [LaunchDarkly](https://launchdarkly.com/) integration tracks feature flag evaluations produced by the LaunchDarkly SDK. These evaluations are held in memory and, in the event an error occurs, sent to Sentry for review and analysis. +The [LaunchDarkly](https://launchdarkly.com/) integration tracks feature flag evaluations produced by the LaunchDarkly 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.** ```JavaScript import * as Sentry from '@sentry/browser'; From 59cffdb90d7ea772573adfee30600ce0311f30fb Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Thu, 14 Nov 2024 14:04:05 -0800 Subject: [PATCH 3/3] configuration->integration --- .../common/configuration/integrations/launchdarkly.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx b/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx index 12a4daab866592..0517bd3bc2edec 100644 --- a/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx @@ -51,4 +51,4 @@ SDKs.** However, you may reuse this setup code for React and client-side Node.js ## Options -There are no setup options for this configuration. +There are no setup options for this integration.