Skip to content

Conversation

cmanallen
Copy link
Member

@cmanallen cmanallen commented Nov 6, 2024

DESCRIBE YOUR PR

Adds documentation for navigating and setting up the feature flags UI.

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.): 2024/11/15
  • 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

Copy link

vercel bot commented Nov 6, 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:30pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 15, 2024 9:30pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 15, 2024 9:30pm

Copy link

codecov bot commented Nov 6, 2024

Bundle Report

Changes will decrease total bundle size by 405 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

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

Copy link
Contributor

@coolguyzone coolguyzone 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 the update! Pls see my comment about the TODO here.

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
@cmanallen cmanallen marked this pull request as ready for review November 8, 2024 21:08
@cmanallen cmanallen changed the title Add feature flags to issue-details page documentation Add feature flags to issue-details page and launchdarkly integration documentation Nov 8, 2024
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.

Left some wording tweaks. Thanks for adding this!

cmanallen and others added 3 commits November 12, 2024 14:33
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
cmanallen and others added 4 commits November 13, 2024 13:54
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
@cmanallen
Copy link
Member Author

@coolguyzone Do you mind reviewing/approving this?

Copy link
Contributor

@coolguyzone coolguyzone 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!

* LaunchDarkly ([Python](/platforms/python/integrations/launchdarkly/) and [JavaScript](/platforms/javascript/integrations/launchdarkly/))
* OpenFeature ([Python](/platforms/python/integrations/openfeature/) and [JavaScript](/platforms/javascript/integrations/openfeature/))

The second integration type is **feature flag change tracking**. This will enable a timeline of feature flag definition changes on the event and user volume chart. These annotations can help you diagnose when a feature flag change is related to a new issue. To enable this type of integration, please visit the documentation page of one of our supported providers:
Copy link
Member

Choose a reason for hiding this comment

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

we should list the providers and the links here!

Copy link
Member

Choose a reason for hiding this comment

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

or at the very least, we should link to a spot where we have a full list of providers (an index page, when we create one, would make sense)

Copy link
Member

@michellewzhang michellewzhang Nov 27, 2024

Choose a reason for hiding this comment

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

PR is out for the index page: #11969

the link/title might change, but as of now can link to /product/explore/feature-flags/#set-up-your-integration-specific-webhook for the full list of providers

Copy link
Member

Choose a reason for hiding this comment

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

or /product/explore/feature-flags/#setup for the full setup info!

Copy link
Member

Choose a reason for hiding this comment

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

SCR-20241121-ltza

is the generic trigger different from this one that i've been using?


## Change Tracking Integration

Sentry offers a flag change tracking integration which allows Sentry to associate flag definition changes with errors that occurred in your application. To enable this integration, create a new <Link to="https://app.launchdarkly.com/settings/integrations?q=generic+trigger">"Generic Trigger"</Link> integration and paste the Sentry web hook URL generated by the Feature Flag Integration Modal. For information on how to generate a Sentry Web Hook URL, visit the <PlatformLink to="/product/issues/issue-details/#feature-flags">feature flag integration documentation here</PlatformLink>. Learn more about LaunchDarkly's "Generic Triggers" <Link to="https://docs.launchdarkly.com/home/releases/triggers">here</Link>.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Sentry offers a flag change tracking integration which allows Sentry to associate flag definition changes with errors that occurred in your application. To enable this integration, create a new <Link to="https://app.launchdarkly.com/settings/integrations?q=generic+trigger">"Generic Trigger"</Link> integration and paste the Sentry web hook URL generated by the Feature Flag Integration Modal. For information on how to generate a Sentry Web Hook URL, visit the <PlatformLink to="/product/issues/issue-details/#feature-flags">feature flag integration documentation here</PlatformLink>. Learn more about LaunchDarkly's "Generic Triggers" <Link to="https://docs.launchdarkly.com/home/releases/triggers">here</Link>.
Sentry offers a flag change tracking integration which allows Sentry to associate flag definition changes with errors that occurred in your application. To enable this integration, create a new <Link to="https://app.launchdarkly.com/settings/integrations?q=generic+trigger">"Generic Trigger"</Link> integration and paste the Sentry webhook URL generated by the feature flag flyout panel. For information on how to generate a Sentry webhook URL, visit the <PlatformLink to="/product/issues/issue-details/#feature-flags">feature flag integration documentation here</PlatformLink>. Learn more about LaunchDarkly's "Generic Triggers" <Link to="https://docs.launchdarkly.com/home/releases/triggers">here</Link>.


2. Follow the full [LaunchDarkly installation instructions](https://docs.launchdarkly.com/integrations/sentry).

## Change Tracking Integration
Copy link
Member

Choose a reason for hiding this comment

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

we should mention that there's another step needed to set up feature flags completely (e.g. for eval tracking, they need to set up the platform-specific language for their sdk) & link to a full list of platforms (a product index page, when we create it, would make sense)

Copy link
Member

@michellewzhang michellewzhang Nov 27, 2024

Choose a reason for hiding this comment

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

link to eval tracking setup: /product/explore/feature-flags/#set-up-your-language-specific-sdk

PR here in case the title/link changes

---
title: LaunchDarkly
sidebar_order: 1
description: Learn about Sentry's LaunchDarkly integration. LaunchDarkly enables organizations to use Sentry errors as a metric in their LaunchDarkly experiments.
Copy link
Member

Choose a reason for hiding this comment

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

we should probably update this description to be more generic -- right now it's about metrics, but we're adding FF info to this page too!

@ryan953
Copy link
Member

ryan953 commented Dec 2, 2024

Looks like most of this PR (the issue details stuff) has already made it into the big docs PR https://github.com/getsentry/sentry-docs/pull/12005/files#diff-051c4d59160f658294ad60b91e188f36142e24b8f9b1dc77436b547cb47a67a2

There's also some LD setup stuff that might need to move over, comment about it here: https://github.com/getsentry/sentry-docs/pull/12005/files#r1866315916

i'll close this to focus on the big PR

@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.

5 participants