-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
proposed updates for flagsmith integration docs #14225
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
Closed
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
37 changes: 37 additions & 0 deletions
37
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,37 @@ | ||
| --- | ||
| 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 a OpenFeature SDK and [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/) | ||
|
|
||
| ## 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 provided Sentry webhook URL 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
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.
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.
The only changed content for this file. The rest can stay the same, other than sidebar_order: 1