Skip to content

feat(flags): add browser JS integration docs for Launchdarkly #11827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 15, 2024
Merged

feat(flags): add browser JS integration docs for Launchdarkly #11827

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ebbadde
feat(flags): add browser JS integration docs for Launchdarkly
aliu39 Nov 14, 2024
3e34e42
Review comments
aliu39 Nov 14, 2024
59cffdb
configuration->integration
aliu39 Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/launchdarkly.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Comment on lines +4 to +21
Copy link
Member Author

@aliu39 aliu39 Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are the non-frontend frameworks

Copy link
Member

@bruno-garcia bruno-garcia Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feature flags can be used on BE too. Does LD for example have a packge for browser and another for node?

Copy link
Member Author

@aliu39 aliu39 Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LD has server-side node, yes, but the implementation + installation will look different, so we focus on client-side for now. See getsentry/sentry-javascript#14207 (comment)

Copy link
Member Author

@aliu39 aliu39 Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tldr; the hook used to listen for evaluations doesn't exist for node. If it does, it works differently. This is also the reason we can't support specific frontend frameworks, only the generic launchdarkly-js-client-sdk

---

<Alert level="info">

This integration only works inside a browser environment.

</Alert>

_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.
Loading