-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(flags): Consolidate feature flags pull requests #12005
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
Changes from all commits
0011f2d
0dc00d1
1cf3e8e
b0bbf64
5a0e779
1800bb4
f00a3fa
22d9ec4
920a532
cd6ecee
de57663
2e6e233
acb2b71
4243227
1b0e3d4
db5797d
22a253e
b5976c1
dc5b2e5
b26e949
8e0051d
4cd2f65
097e4d1
d8a6795
6bd4dad
0bb8b8e
9254bba
0ef3d1f
bf215f8
8eddd68
00bdf22
e6da619
4912ba9
cdb050e
88185d6
a802fe9
1b77eef
89f2523
e056c39
749e07f
aa00323
cb10216
840c8bf
74f5c55
cf2e160
508f25f
6cc14db
3ab0ace
9e800c1
d8b31b0
6ebb3d1
3740542
f7e656d
2ab3dbb
74b5262
8182477
8fae723
e49e493
2645fec
1e46d9e
bcfed7b
07ce47d
570eef8
3c5845b
911624a
64a4b1a
5ab81f0
c0cf29b
d30f40e
17bde53
7848850
d7d99c6
edaf723
5e1d399
fe48814
b4db6e7
39405a6
dca8e06
19001cb
b01d851
7273956
c84b3fd
4eaf357
647fa56
28d7b3f
9bba3b8
ab1eb40
4b732fa
4df3cb4
d43968d
815af0b
4a8663b
a675ddd
b0d0cb5
d3c93e9
9928928
ab05155
c1e4b07
63e2ba6
9c445d3
a2fcb6d
f7c670a
ab4356f
daf487a
91b6f88
11e9502
f564cc2
8e02180
fb1ff75
d69bf09
6af548d
94f6320
93483d7
d60a56a
82fde33
8ec9626
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -1,12 +1,43 @@ | ||||||||||
--- | ||||||||||
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. | ||||||||||
description: Learn about Sentry's LaunchDarkly 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). | ||||||||||
|
||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
### Set Up Evaluation Tracking | ||||||||||
|
||||||||||
To set up evaluation tracking visit one of our supported languages pages: | ||||||||||
* [JavaScript](/platforms/javascript/configuration/integrations/launchdarkly/) | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this link isn't working, not sure what it should be yet... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i expected this to work but its seems like it's not:
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
* [Python](/platforms/python/integrations/launchdarkly/) | ||||||||||
|
||||||||||
## Change Tracking | ||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
|
||||||||||
Sentry can track changes to feature flag definitions and report suspicious feature flag edits. | ||||||||||
|
||||||||||
### Set Up Change Tracking | ||||||||||
|
||||||||||
Enabling Change Tracking is a two 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. **Register the webhook URL**. | ||||||||||
- Under the "Integrate Feature Flag Service" heading a Sentry webhook URL has been provided. | ||||||||||
- Copy the Sentry webhook URL revealed in the fly out and paste it into LaunchDarkly within their [webhook integration UI](https://app.launchdarkly.com/settings/integrations/webhooks/new). | ||||||||||
2. **Set the Signing Secret**. | ||||||||||
- In the LaunchDarkly webhook UI check the box that says "Sign this webhook". | ||||||||||
- Copy the signing secret in the revealed input box and paste it into the input box labeled "Secret" on the Sentry fly out. | ||||||||||
- Save the secret by clicking "Save Secret" in the Sentry fly out. | ||||||||||
- Save the webhook by clicking "Save Settings" in LaunchDarkly. | ||||||||||
|
||||||||||
Once saved Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint. | ||||||||||
|
||||||||||
## Metrics Integration | ||||||||||
|
||||||||||
This integration is maintained and supported by the company that created it. For more details or questions, feel free to contact rrosefigura@launchdarkly.com. | ||||||||||
|
||||||||||
## Install and Configure | ||||||||||
### Install and Configure | ||||||||||
|
||||||||||
<Note> | ||||||||||
|
||||||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
title: LaunchDarkly | ||
description: "Learn how to use Sentry with LaunchDarkly." | ||
notSupported: | ||
- javascript.aws-lambda | ||
- javascript.azure-functions | ||
- javascript.bun | ||
- javascript.capacitor | ||
- javascript.cloudflare | ||
- javascript.connect | ||
- javascript.cordova | ||
- javascript.deno | ||
- javascript.electron | ||
- javascript.express | ||
- javascript.fastify | ||
- javascript.gcp-functions | ||
- javascript.hapi | ||
- javascript.koa | ||
- javascript.nestjs | ||
- javascript.nodejs | ||
- javascript.wasm | ||
--- | ||
|
||
<PlatformContent includePath="feature-flags/prerelease-alert" /> | ||
|
||
<Alert level="info"> | ||
|
||
This integration only works inside a browser environment. | ||
|
||
</Alert> | ||
|
||
The [LaunchDarkly](https://launchdarkly.com/) integration tracks feature flag evaluations produced by the LaunchDarkly 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.** | ||
|
||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
_Import names: `Sentry.launchDarklyIntegration` and `Sentry.buildLaunchDarklyFlagUsedHandler`_ | ||
|
||
## Install | ||
|
||
Install [`@sentry/browser`](https://www.npmjs.com/package/@sentry/browser) and [`launchdarkly-js-client-sdk`](https://www.npmjs.com/package/launchdarkly-js-client-sdk) from npm. | ||
|
||
## Configure | ||
|
||
```JavaScript | ||
import * as Sentry from '@sentry/browser'; | ||
import * as LaunchDarkly from 'launchdarkly-js-client-sdk'; | ||
|
||
Sentry.init({ | ||
dsn: "___PUBLIC_DSN___", | ||
integrations: [Sentry.launchDarklyIntegration()] | ||
}); | ||
|
||
const ldClient = LaunchDarkly.initialize( | ||
'my-client-ID', | ||
{kind: 'user', key: 'my-user-context-key'}, | ||
{inspectors: [Sentry.buildLaunchDarklyFlagUsedHandler()]} | ||
); | ||
``` | ||
|
||
Learn more about the [LaunchDarkly SDK](https://docs.launchdarkly.com/sdk/client-side/javascript). At the moment, **we aren't officially supporting framework-specific LaunchDarkly SDKs.** However, you may reuse the setup code for [React](https://www.npmjs.com/package/launchdarkly-react-client-sdk) and [client-side Node.js](https://www.npmjs.com/package/launchdarkly-node-client-sdk). | ||
|
||
## Verify | ||
|
||
The integration is tested by evaluating a feature flag with your LaunchDarkly SDK before capturing an exception. | ||
|
||
```JavaScript | ||
import * as Sentry from '@sentry/browser'; | ||
import * as LaunchDarkly from 'launchdarkly-js-client-sdk'; | ||
|
||
// Evaluate a flag with a default value, with the ldClient from the Configure step. | ||
// You may have to wait for your client to initialize before doing this. | ||
ldClient?.variation("hello", false); | ||
|
||
Sentry.captureException(Exception("Something went wrong!")) | ||
``` | ||
|
||
Visit the Sentry website and confirm that your error event has recorded the feature flag "hello" and its value "false". | ||
|
||
<PlatformContent includePath="feature-flags/next-steps" /> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
title: OpenFeature | ||
description: "Learn how to use Sentry with OpenFeature." | ||
notSupported: | ||
- javascript.aws-lambda | ||
- javascript.azure-functions | ||
- javascript.bun | ||
- javascript.capacitor | ||
- javascript.cloudflare | ||
- javascript.connect | ||
- javascript.cordova | ||
- javascript.deno | ||
- javascript.electron | ||
- javascript.express | ||
- javascript.fastify | ||
- javascript.gcp-functions | ||
- javascript.hapi | ||
- javascript.koa | ||
- javascript.nestjs | ||
- javascript.nodejs | ||
- javascript.wasm | ||
--- | ||
|
||
<PlatformContent includePath="feature-flags/prerelease-alert" /> | ||
|
||
<Alert level="info"> | ||
|
||
This integration only works inside a browser environment. | ||
|
||
</Alert> | ||
|
||
The [OpenFeature](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.** | ||
|
||
_Import name: `Sentry.openFeatureIntegration` and `Sentry.OpenFeatureIntegrationHook`_ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @aliu39 Is this meant to be shown to the user? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Our code example already includes @lizokm maybe you have a preference. I see the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I agree with this! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That makes sense to me. Let's leave it. I think it would flow better if we moved it under the first paragraph though.
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Install | ||
|
||
Install [`@sentry/browser`](https://www.npmjs.com/package/@sentry/browser) and [`@openfeature/web-sdk`](https://www.npmjs.com/package/@openfeature/web-sdk) from npm. | ||
|
||
## Configure | ||
|
||
```JavaScript | ||
import * as Sentry from '@sentry/browser'; | ||
import { OpenFeature } from '@openfeature/web-sdk'; | ||
|
||
Sentry.init({ | ||
dsn: "___PUBLIC_DSN___", | ||
integrations: [Sentry.openFeatureIntegration()] | ||
}); | ||
|
||
OpenFeature.setProvider(new MyProviderOfChoice()); | ||
|
||
// Option 1: track all OpenFeature evaluations. | ||
OpenFeature.addHooks(new Sentry.OpenFeatureIntegrationHook()); | ||
|
||
// Option 2: only track evaluations by a specific client. | ||
const client = OpenFeature.getClient(); | ||
client.addHooks(new Sentry.OpenFeatureIntegrationHook()); | ||
``` | ||
|
||
Learn more about OpenFeature providers [here](https://openfeature.dev/docs/reference/concepts/provider). | ||
|
||
## Verify | ||
|
||
The integration is tested by evaluating a feature flag with your OpenFeature SDK before capturing an exception. | ||
|
||
```JavaScript | ||
import * as Sentry from '@sentry/browser'; | ||
import { OpenFeature } from '@openfeature/web-sdk'; | ||
|
||
// Evaluate a flag with a default value. If you added the hook to a client in | ||
// the Configure step, make sure to use the same client here. | ||
const client = OpenFeature.getClient(); | ||
const result = client.getBooleanValue('hello', false); | ||
|
||
Sentry.captureException(Exception("Something went wrong!")) | ||
``` | ||
|
||
Visit the Sentry website and confirm that your error event has recorded the feature flag "hello" and its value "false". | ||
|
||
<PlatformContent includePath="feature-flags/next-steps" /> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
title: Set Up Feature Flags | ||
sidebar_order: 7000 | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
notSupported: | ||
- javascript.aws-lambda | ||
- javascript.azure-functions | ||
- javascript.bun | ||
- javascript.capacitor | ||
- javascript.cloudflare | ||
- javascript.connect | ||
- javascript.cordova | ||
- javascript.deno | ||
- javascript.electron | ||
- javascript.express | ||
- javascript.fastify | ||
- javascript.gcp-functions | ||
- javascript.hapi | ||
- javascript.koa | ||
- javascript.nestjs | ||
- javascript.nodejs | ||
- javascript.wasm | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
description: With Feature Flags, Sentry tracks feature flag evaluations in your application, keeps an audit log feature flag changes, and reports any suspicious updates that may have caused an error. | ||
--- | ||
|
||
<PlatformContent includePath="feature-flags/prerelease-alert" /> | ||
|
||
## Prerequisites | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* You have the <PlatformLink to="/">JavaScript SDK installed</PlatformLink> (version 8.41.0-beta.1). | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Enable Evaluation Tracking | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Evaluation tracking requires enabling an SDK integration. Integrations are provider specific. Documentation for supported providers is listed below. | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [OpenFeature](/platforms/javascript/configuration/integrations/openfeature/) | ||
- [LaunchDarkly](/platforms/javascript/configuration/integrations/launchdarkly/) | ||
Comment on lines
+34
to
+35
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. these links arn't working either There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yeah that page is broken i think. the links should work when its fixed. |
||
|
||
<PlatformContent includePath="feature-flags/enable-change-tracking" /> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: Set Up Feature Flags | ||
sidebar_order: 7000 | ||
description: With Feature Flags, Sentry tracks feature flag evaluations in your application, keeps an audit log feature flag changes, and reports any suspicious updates that may have caused an error. | ||
--- | ||
|
||
<PlatformContent includePath="feature-flags/prerelease-alert" /> | ||
|
||
## Prerequisites | ||
|
||
* You have the <PlatformLink to="/">Python SDK installed</PlatformLink> (version 2.18.0 or higher). | ||
|
||
## Enable Evaluation Tracking | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Evaluation tracking requires enabling an SDK integration. Integrations are provider specific. Documentation for supported providers is listed below. | ||
|
||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [OpenFeature](/platforms/python/integrations/openfeature/) | ||
- [LaunchDarkly](/platforms/python/integrations/launchdarkly/) | ||
|
||
<PlatformContent includePath="feature-flags/enable-change-tracking" /> |
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,28 @@ | ||||||||||||||||||||
--- | ||||||||||||||||||||
title: "Feature Flags" | ||||||||||||||||||||
sidebar_order: 100 | ||||||||||||||||||||
description: "Learn how to set up and interact with Sentry's feature flag evaluation tracking and feature flag change tracking." | ||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||
--- | ||||||||||||||||||||
|
||||||||||||||||||||
<PlatformContent includePath="feature-flags/prerelease-alert" /> | ||||||||||||||||||||
|
||||||||||||||||||||
Enabling a feature flag integration provides deep insights into the state of your application prior to an error. A list of flags and their evaluation results are displayed on each error event in the order of evaluation. Integrating Sentry with your feature flag provider enables Sentry to correlate feature flag changes with new error events and mark certain changes as suspicious. | ||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||
|
||||||||||||||||||||
## Evaluation Tracking | ||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||
|
||||||||||||||||||||
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). | ||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
Comment on lines
+12
to
+13
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||
|
||||||||||||||||||||
### Set Up Evaluation Tracking | ||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||
|
||||||||||||||||||||
To set up evaluation tracking visit your provider's integration documentation page: | ||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm, but we're not linking to the integration page here? Maybe we should say something like "Evaluation tracking is currently available for LaunchDarkly and the OpenFeature API. See the supported SDKs and set up instructions below." There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. +1 to this. I'd tweak wording slightly to: "Evaluation-tracking is currently available for LaunchDarkly and the OpenFeature API. See all supported SDKs and their set up instructions below:" |
||||||||||||||||||||
* [JavaScript](/platforms/javascript/feature-flags/) | ||||||||||||||||||||
* [Python](/platforms/python/feature-flags/) | ||||||||||||||||||||
|
||||||||||||||||||||
## Change Tracking | ||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||
|
||||||||||||||||||||
Change tracking enables Sentry to listen for additions, removals, and modifications to your feature flags. On change, we'll record the change event in the audit log. The audit log appears in the "event volume" chart and presents itself as a "release" line. If the change is responsible for a new error event, we'll notify you by marking the feature flag as "suspect" on the Issue Details page. Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details documentation](/product/issues/issue-details/#feature-flags). | ||||||||||||||||||||
|
||||||||||||||||||||
Comment on lines
+22
to
+24
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||
### Set Up Change Tracking | ||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||
|
||||||||||||||||||||
To set up change tracking visit your provider's integration documentation page: | ||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||
* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking) |
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -142,3 +142,15 @@ The Contexts section contains related key/value items (not just strings) that yo | |||||||||||||||||||||||||||||||||||||||||
The issue details page only displays context for the individual event, and context cannot be searched. If you require searching for your data, use [Tags](#tags) instead. | ||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
You can set up your own context items to collect useful debugging information in your next event, as described in <PlatformLink to="/enriching-events/context/">Structured Context</PlatformLink>. | ||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
## Feature Flags | ||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
Enabling one or more of our [evaluation tracking integrations](/product/explore/feature-flags/#evaluation-tracking) will reveal the feature flag evaluation table. Here you can see an ordered list (in order of evaluation) of all the flags evaluated and their evaluation results prior to the error event. | ||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
 | ||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
Enabling a [change tracking integration](/product/explore/feature-flags/#change-tracking) will enable annotations on the event volume chart. These lines mark feature flag changes and can help identify regressions caused by a feature flag definition change. | ||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
 | ||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
Enabling both a change tracking integration and a evaluation tracking integration will enable suspect feature flag detection. Sentry will attempt to identify feature flags which might have caused an error event and highlight them for review. | ||||||||||||||||||||||||||||||||||||||||||
Comment on lines
+147
to
+156
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,9 @@ | ||||||||||||||||||||||||||||
## Change Tracking | ||||||||||||||||||||||||||||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Sentry can track changes to feature flag definitions and report suspicious feature flag edits. To enable the change tracking integration click the "Set Up Integration" button on the feature flag table contained within the Issue Details page. This will trigger a fly out which will guide you through the two step process. | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Comment on lines
+3
to
+4
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||
 | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Under the "Integrate Feature Flag Service" heading a Sentry webhook URL has been provided. Additionally, a link to LaunchDarkly's webhook registration interface has been provided. Paste the Sentry webhook URL into the input box labeled "URL" within the LaunchDarkly webhook registration UI. | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Next a signing secret must be created. Check the box that says "Sign this webhook". This will reveal an input element which contains your signing secret. Copy and paste this signing secret into the input box labeled "Secret" on the Sentry fly out. Click "Save Secret" in the Sentry UI, then click "Save Settings" in the LaunchDarkly UI, and you're done. Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint. | ||||||||||||||||||||||||||||
Comment on lines
+7
to
+9
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## Enable Change Tracking | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Change tracking requires registering a Sentry webhook with your feature flag provider. Set up varies by provider and is documented in detail [here](/product/explore/feature-flags/#change-tracking). | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<Alert level="warning" title="Next Steps"> | ||
|
||
- **Track feature flag evaluations in other parts of your codebase.** If needed, you can set up evaluation tracking for more than one SDK. [Read the docs](/product/explore/feature-flags/#set-up-evaluation-tracking) to learn more. | ||
- **Set up your change tracking webhook.** In order to take full advantage of the feature flag capabilities Sentry offers there is an additional setup step needed. Your feature flag provider needs to notify Sentry when a feature flag definition has changed. A Sentry webhook URL can be registered with your provider. Learn [how](/product/explore/feature-flags/#set-up-change-tracking). | ||
|
||
</Alert> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
<Alert level="info" title="Currently in Beta"> | ||
|
||
Feature flag change tracking and feature flag evaluation tracking is currently in open beta. | ||
cmanallen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
</Alert> |
Uh oh!
There was an error while loading. Please reload this page.