-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
docs(flags): add unleash webhook setup docs #12239
Draft
michellewzhang
wants to merge
2
commits into
master
Choose a base branch
from
mz/unleash-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+44
−1
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file removed
BIN
-149 KB
docs/organization/integrations/feature-flag/launchdarkly/img/ff-integration-ui.png
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+82 KB
docs/organization/integrations/feature-flag/unleash/img/unleash-events.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions
42
docs/organization/integrations/feature-flag/unleash/index.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Unleash | ||
sidebar_order: 2 | ||
description: Learn about Sentry's Unleash integrations. | ||
--- | ||
|
||
## Evaluation Tracking | ||
|
||
Sentry can track flag evaluations as they happen within your application. Flag evaluations will appear in the "Feature Flag" section of Issue Details page as a table, with "suspect" flag predictions highlighted in yellow. Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details page documentation](/product/issues/issue-details/#feature-flags). | ||
|
||
### Set Up Evaluation Tracking | ||
|
||
To set up evaluation tracking visit one of our supported languages pages: | ||
* [JavaScript](/platforms/javascript/configuration/integrations/unleash/) | ||
* [Python](/platforms/python/integrations/unleash/) | ||
|
||
## Change Tracking | ||
|
||
Sentry can track changes to feature flag definitions and report suspicious feature flag edits. | ||
|
||
### Set Up Change Tracking | ||
|
||
Enabling Change Tracking is a three-step process. To get started visit the [feature-flags settings page](https://sentry.io/orgredirect/organizations/:orgslug/settings/feature-flags) in a new tab. Then follow the steps listed below. | ||
|
||
1. **Click the "Add New Provider" button.** | ||
- One webhook secret can be registered per provider type. | ||
- Select Unleash in the dropdown that says "Select a provider". | ||
2. **Register the webhook URL**. | ||
- Go to your Unleash homepage and navigate to the `/integrations/` page, which can be found by clicking Integrations on the left-hand sidebar navigation, under the Configure heading. | ||
- Select the Webhook option. You should be on the `/integrations/create/webhook/` page. | ||
- Copy the provided Sentry webhook URL in settings and paste it into Unleash within their webhook integration UI. | ||
- Make sure the integration is toggled to Enabled. | ||
3. **Set the Signing Secret**. | ||
- In the Unleash webhook UI, under the Authorization input box, type in any 32-character string to use as your authorization token ("secret"). Keep this string safe and note it down somewhere in case you need it in the future; Unleash will not show you the token once you save the webhook. We recommend not using any sensitive tokens. | ||
- Copy your authorization token from the Unleash UI and paste it into the input box next to "Secret" in Sentry settings. | ||
4. **Configure your webhook.** | ||
- Under the Events input box, specify which feature flag events you'd like to send to Sentry. We currently support the following events: ![Supported Unleash events](./img/unleash-events.png) | ||
- Save the secret by clicking "Add Provider" in Sentry settings. | ||
- Save the webhook by clicking "Create" in Unleash. | ||
|
||
Once saved, Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint. | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: these 2 links don't exist yet
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Andrew will merge those soon. Let's wait until they're merged to merge this one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went ahead and set this to 'draft' to make sure we don't merge before these urls are working.