docs(flags): Add OpenFeature JS integration docs #11837

cmanallen · 2024-11-15T19:53:43Z

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

Urgent deadline (GA date, etc.):
Other deadline:
None: Not urgent, can wait up to 1 week+

SLA

Teamwork makes the dream work, so please add a reviewer to your PRs.
Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

Checked Vercel preview for correctness, including links
PR was reviewed and approved by any necessary SMEs (subject matter experts)
PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Sentry Docs contributor guide

vercel · 2024-11-15T19:53:47Z

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 8:32pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
changelog	⬜️ Ignored (Inspect)	Visit Preview		Nov 15, 2024 8:32pm
develop-docs	⬜️ Ignored (Inspect)	Visit Preview		Nov 15, 2024 8:32pm

codecov · 2024-11-15T19:59:16Z

Bundle Report

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

Detailed changes

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

bruno-garcia · 2024-11-15T20:00:57Z

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

+const client = OpenFeature.getClient();
+client.addHooks(new OpenFeatureIntegrationHook());


More of a review to be done here: getsentry/sentry-javascript#14326

But could the integration itself do this? Since it's a "global" function that we're calling we could just auto register and avoid having the user do this bit of code?

Not without taking on a dependency. We either ask them to pass the client to us at integration init time (which may or may not be desired depending on their code's structure) or we ask them to register the hook explicitly. Just my two cents. Could be more options I don't know about.

should this be Sentry.OpenFeatureIntegrationHook?

Yes thank you!

Not without taking on a dependency.

I see so we're not shipping a @sentry/openfeature here and this is the way?

It's not the easist set up but it does make our lives much easier for now at least (no additional package requirements)

Yeah its just a browser integration so no extra install steps. I agree its not an ideal setup. But I don't think its unexpected setup friction either.

If one day the flag buffer is a property on the scope we could remove the integration registration step all together and just have people register the hook. Which would be a one line change on the customer's side rather than two.

Talking about the integration init here being removed: https://github.com/getsentry/sentry-docs/pull/11837/files#diff-9f766b64b39c2a17b915efb1536f14ed4dede9c406a6e9fe920f1f1110ba7bcfR38

lizokm

Thanks for adding this, I've left a few wording suggestions.

lizokm · 2024-11-18T20:51:49Z

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

@@ -0,0 +1,51 @@
+---
+title: OpenFeature
+description: "Attaches recent OpenFeature feature flag evaluations to error event context."


Suggested change

description: "Attaches recent OpenFeature feature flag evaluations to error event context."

description: "Learn how to attach Sentry's OpenFeature feature flag evaluations to error event context."

lizokm · 2024-11-18T20:58:14Z

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

+
+_Import name: `Sentry.openFeatureIntegration` and `Sentry.OpenFeatureIntegrationHook`_
+
+The [OpenFeature](https://https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature 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.**


Suggested change

The [OpenFeature](https://https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature 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 [OpenFeature](https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature 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.**

lizokm · 2024-11-18T21:03:06Z

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

+const client = OpenFeature.getClient();
+client.addHooks(new Sentry.OpenFeatureIntegrationHook());
+
+// Evaluating flags will record the result on the Sentry client.


Suggested change

// Evaluating flags will record the result on the Sentry client.

// When you evaluate flags, the result will be recorded by the Sentry client.

lizokm · 2024-11-18T21:06:24Z

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

+## Options
+
+There are no setup options for this integration.


Suggested change

## Options

There are no setup options for this integration.

## Options

There are no setup options for this integration.

Maybe it's better to just not have this section since there aren't any options?

michellewzhang · 2024-11-27T07:26:34Z

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!

michellewzhang · 2024-11-27T07:49:57Z

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

+
+</Alert>
+
+_Import name: `Sentry.openFeatureIntegration` and `Sentry.OpenFeatureIntegrationHook`_


maybe we should also add an alert saying this is in beta to match the other docs (same with the LD JS doc too)

i've been doing this:

<Alert level="info" title="Currently in Beta"> The support for **feature flag change tracking** and **feature flag evaluation tracking** is currently in beta. </Alert>

ryan953 · 2024-12-02T17:39:14Z

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

closing this so we can focus there.

Add OpenFeature integration docs

dc5b2e5

michellewzhang approved these changes Nov 15, 2024

View reviewed changes

bruno-garcia reviewed Nov 15, 2024

View reviewed changes

Fix namespacing

b26e949

vercel bot deployed to Preview – sentry-docs November 15, 2024 20:32 View deployment

lizokm self-requested a review November 18, 2024 20:52

lizokm approved these changes Nov 18, 2024

View reviewed changes

michellewzhang changed the title ~~docs(flags): Add OpenFeature integration docs~~ docs(flags): Add OpenFeature JS integration docs Nov 19, 2024

ryan953 mentioned this pull request Nov 20, 2024

docs(flags): add index flag docs for python #11879

Closed

michellewzhang reviewed Nov 27, 2024

View reviewed changes

jas-kas approved these changes Nov 29, 2024

View reviewed changes

ryan953 closed this Dec 2, 2024

github-actions bot locked and limited conversation to collaborators Dec 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(flags): Add OpenFeature JS integration docs #11837

docs(flags): Add OpenFeature JS integration docs #11837

cmanallen commented Nov 15, 2024

vercel bot commented Nov 15, 2024 •

edited

Loading

codecov bot commented Nov 15, 2024 •

edited

Loading

bruno-garcia Nov 15, 2024

cmanallen Nov 15, 2024

billyvg Nov 15, 2024

cmanallen Nov 15, 2024

bruno-garcia Nov 15, 2024

cmanallen Nov 15, 2024 •

edited

Loading

cmanallen Nov 15, 2024

lizokm left a comment

lizokm Nov 18, 2024

lizokm Nov 18, 2024 •

edited

Loading

lizokm Nov 18, 2024

lizokm Nov 18, 2024

michellewzhang commented Nov 27, 2024 •

edited

Loading

michellewzhang Nov 27, 2024 •

edited

Loading

ryan953 commented Dec 2, 2024

		const client = OpenFeature.getClient();
		client.addHooks(new OpenFeatureIntegrationHook());

	description: "Attaches recent OpenFeature feature flag evaluations to error event context."
	description: "Learn how to attach Sentry's OpenFeature feature flag evaluations to error event context."


		_Import name: `Sentry.openFeatureIntegration` and `Sentry.OpenFeatureIntegrationHook`_

		The [OpenFeature](https://https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature 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 [OpenFeature](https://https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature 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 [OpenFeature](https://openfeature.dev/) integration tracks feature flag evaluations produced by the OpenFeature 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.

	// Evaluating flags will record the result on the Sentry client.
	// When you evaluate flags, the result will be recorded by the Sentry client.


		</Alert>

		_Import name: `Sentry.openFeatureIntegration` and `Sentry.OpenFeatureIntegrationHook`_

docs(flags): Add OpenFeature JS integration docs #11837

docs(flags): Add OpenFeature JS integration docs #11837

Conversation

cmanallen commented Nov 15, 2024

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

LEGAL BOILERPLATE

EXTRA RESOURCES

vercel bot commented Nov 15, 2024 • edited Loading

codecov bot commented Nov 15, 2024 • edited Loading

Bundle Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cmanallen Nov 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizokm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizokm Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michellewzhang commented Nov 27, 2024 • edited Loading

michellewzhang Nov 27, 2024 • edited Loading

Choose a reason for hiding this comment

ryan953 commented Dec 2, 2024

vercel bot commented Nov 15, 2024 •

edited

Loading

codecov bot commented Nov 15, 2024 •

edited

Loading

cmanallen Nov 15, 2024 •

edited

Loading

lizokm Nov 18, 2024 •

edited

Loading

michellewzhang commented Nov 27, 2024 •

edited

Loading

michellewzhang Nov 27, 2024 •

edited

Loading