-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add Flagsmith as feature flag provider #14126
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
Open
emyller
wants to merge
11
commits into
getsentry:master
Choose a base branch
from
Flagsmith:feat/flagsmith-integration
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.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
a34d813
Add Flagsmith to feature flags Change Tracking docs
emyller 8d2b60d
Add Flagsmith to feature flags Evaluation Tracking docs
emyller 723e5bb
Fix outdated path
emyller 97868b5
Improve wording
emyller 3bacab0
proposed updates to flagsmith integration docs
aliu39 dd8de37
proposed updates to flagsmith integration docs
aliu39 9993b98
Merge remote-tracking branch 'original/master' into feat/flagsmith-in…
emyller 87c881e
Merge remote-tracking branch 'original/aliu/flagsmith' into feat/flag…
emyller 156b6f4
Revert platform docs
emyller 8ad04c0
Link to Flagsmith docs for more info
emyller 6e58632
Update URL
emyller 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
Binary file added
BIN
+89.4 KB
...tion/integrations/feature-flag/flagsmith/img/flagsmith-sentry-webhook-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions
40
docs/organization/integrations/feature-flag/flagsmith/index.mdx
This file contains hidden or 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,40 @@ | ||
--- | ||
title: Flagsmith | ||
sidebar_order: 1 | ||
description: Learn about Sentry's Flagsmith integrations. | ||
--- | ||
|
||
## Evaluation Tracking | ||
|
||
Sentry can track flag evaluations as they happen within your application. Flag evaluations will appear in the "Feature Flag" section of the 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 | ||
|
||
Flagsmith recommends using an OpenFeature SDK combined with a [Flagsmith provider](https://openfeature.dev/ecosystem?instant_search%5Bquery%5D=flagsmith&instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=Provider) to evaluate feature flags. To track these evaluations, visit one of our supported languages pages for OpenFeature: | ||
* [JavaScript](/platforms/javascript/configuration/integrations/openfeature/) | ||
* [Python](/platforms/python/integrations/openfeature/) | ||
|
||
Visit the [Flagsmith documentation](https://docs.flagsmith.com/integrations/apm/sentry#evaluation-tracking-setup) for specific instructions on how to set up the OpenFeature SDK with the Flagsmith provider. | ||
|
||
## 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/change-tracking/) 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 Generic in the dropdown that says "Select a provider". | ||
2. **Register the webhook URL**. | ||
 | ||
- Go to your Flagsmith project dashboard and navigate to the `/project/:projectid/integrations` page, which can be found by clicking "Integrations" on the top navigation bar. | ||
- Find the Sentry option, and click "Add Integration", which will open a modal. | ||
- Select the Environment from which flag change events will trigger. | ||
- Copy the webhook URL from Sentry settings and paste it into "Webhook URL" in the Flagsmith "Sentry Integration" modal. | ||
3. **Set the Signing Secret**. | ||
- Still in the Flagsmith "Sentry Integration" modal, type in any string between 10 and 60 characters to use as your authorization token ("secret"). | ||
- Copy the authorization token from the previous step and paste it into the input box next to "Secret" in Sentry settings. | ||
|
||
Once saved, Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint. |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
1 change: 1 addition & 0 deletions
1
platform-includes/feature-flags/change-tracking-list/_default.mdx
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.