Skip to content

feat(flags): Add browser JS integration docs for Launchdarkly #11839

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.

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

Closed
wants to merge 1 commit into from

Conversation

cmanallen
Copy link
Member

Re-adds LaunchDarkly integration documentation.

Reverts #11838

Copy link

vercel bot commented Nov 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 9:07pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 15, 2024 9:07pm
develop-docs ⬜️ Ignored (Inspect) Nov 15, 2024 9:07pm

Copy link

codecov bot commented Nov 15, 2024

Bundle Report

Changes will increase total bundle size by 258 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 8.59MB 264 bytes (0.0%) ⬆️
sentry-docs-client-array-push 8.94MB 6 bytes (-0.0%) ⬇️

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Thanks for adding!

@@ -0,0 +1,54 @@
---
title: LaunchDarkly
description: "Attaches recent LaunchDarkly feature flag evaluations to error event context."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: "Attaches recent LaunchDarkly feature flag evaluations to error event context."
description: "Learn how to attach LaunchDarkly feature flag evaluations to error event context."

Copy link
Member

Choose a reason for hiding this comment

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

@cmanallen Should this be expanded to feature flag change tracking?

Copy link
Member

Choose a reason for hiding this comment

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

Is this too verbose? "Learn how to attach recent LaunchDarkly feature flag evaluations to your error event context"

@cmanallen Should this be expanded to feature flag change tracking?

@jas-kas The SDK integration doesn't track FF changes, only evaluations leading up to the error. Changes are tracked through the webhook, maybe we can link the docs for that

Copy link
Member

Choose a reason for hiding this comment

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

^ basically +1 to Michelle's comment below!

Comment on lines +31 to +32

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.**
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.**
The [LaunchDarkly](https://launchdarkly.com/) integration tracks feature flag evaluations produced by the LaunchDarkly SDK. These evaluations are held in memory and, if an error occurs, sent to Sentry for review and analysis. **At the moment, we only support boolean flag evaluations.**

Comment on lines +48 to +50
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.
Learn more about the [LaunchDarkly SDK] (https://docs.launchdarkly.com/sdk/client-side/javascript).
At the moment, **we don't officially support framework-specific LaunchDarkly
SDKs.** However, you can reuse this setup code for React and client-side Node.js.

Comment on lines +52 to +54
## Options

There are no setup options for this integration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Options
There are no setup options for this integration.
## Options
There are no setup options for this integration.

Same comment as for open feature - maybe it's best to delete this section?

Copy link
Member

Choose a reason for hiding this comment

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

I left it in so we'd remember to update it if we add options in the future. Don't have strong opinions on this though

@michellewzhang
Copy link
Member

michellewzhang commented Nov 27, 2024

we should make it clear that there's another step to setting up flags (the change tracking / webhook step). can link to the index docs in this PR: #11969. can mirror the changes made here: #11970

see figjam for full map!

@jas-kas
Copy link
Member

jas-kas commented Nov 29, 2024

Should we also include this step right here on this docs page https://github.com/getsentry/sentry-docs/pull/11971/files#r1863929949?

Copy link
Member

@jas-kas jas-kas left a comment

Choose a reason for hiding this comment

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

Looks good! Main comment is should we expand this to talk about set up for feature flag change tracking, not just evaluation?

@@ -0,0 +1,54 @@
---
title: LaunchDarkly
description: "Attaches recent LaunchDarkly feature flag evaluations to error event context."
Copy link
Member

Choose a reason for hiding this comment

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

@cmanallen Should this be expanded to feature flag change tracking?


<Alert level="info">

This integration only works inside a browser environment.
Copy link
Member

Choose a reason for hiding this comment

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

Should we re-frame this to just call out JavaScript and Python as supported SDKs?

@ryan953
Copy link
Member

ryan953 commented Dec 2, 2024

looks like this got pulled into the big docs PR here: https://github.com/getsentry/sentry-docs/pull/12005/files#diff-3365be2e16bf22c9c585399fe09132f3aaaa952585587745a54a0f114dfbc7fb

closing this so we can focus there.

@ryan953 ryan953 closed this Dec 2, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants