Skip to content

Commit

Permalink
docs(flags): update generic docs (#12270)
Browse files Browse the repository at this point in the history
* docs(flags): update generic docs

* ♻️ remame to generic

* ✏️ lint
  • Loading branch information
michellewzhang committed Jan 7, 2025
1 parent 54a6fa3 commit 9c12252
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 20 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Self-Serve
sidebar_order: 1
description: Learn about Sentry's self-serve feature-flag integrations.
title: Generic
sidebar_order: 3
description: Learn about Sentry's generic feature-flag integrations.
---

## Evaluation Tracking
Expand All @@ -10,11 +10,11 @@ Sentry can track flag evaluations as they happen within your application. Flag

### Set Up Evaluation Tracking

To set up evaluation tracking visit the [explore page](/product/explore/feature-flags/) and select the language and SDK of your choice. Not using a supported SDK? That's okay. We support self-serve integrations with your existing system.
To set up evaluation tracking, visit the [explore page](/product/explore/feature-flags/) and select the language and SDK of your choice. Not using a supported SDK? That's okay. We support generic integrations with your existing system.

To set up self-serve evaluation tracking visit one of our supported languages pages:
* [JavaScript](/platforms/javascript/configuration/integrations/self-serve/)
* [Python](/platforms/python/integrations/feature-flags/self-serve/)
To set up self-serve evaluation tracking, visit one of our supported languages' pages:
* [JavaScript](/platforms/javascript/configuration/integrations/generic/)
* [Python](/platforms/python/integrations/feature-flags/generic/)

## Change Tracking

Expand All @@ -24,7 +24,7 @@ Sentry offers a change tracking feature which functions as an audit-log of featu

### API Documentation

If you're using a self-serve integration it means you will likely need to write code to support this endpoint. This section documents our authentication procedures as well as the resource's fields and structure.
If you're using a generic integration it means you will likely need to write code to support this endpoint. This section documents our authentication procedures as well as the resource's fields and structure.

#### Authentication

Expand All @@ -47,11 +47,12 @@ Enabling Change Tracking is a three step process. To get started visit the [feat

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**.
- Copy the provided Sentry webhook URL and configure your feature flagging system to emit web hooks to this URL.
3. **Set the Signing Secret**.
- In your feature flagging system's UI find the "Signing Secret".
- Copy the signing secret and paste it into the input box labeled "Secret" in Sentry.
- In Sentry, save the secret by clicking "Save Secret".
- In your feature flagging system's UI, find the "Signing Secret".
- Copy the signing secret and paste it into the input box next to "Secret" in Sentry settings.
- Save the secret by clicking "Add Provider" in Sentry settings.

Once saved Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint.
2 changes: 1 addition & 1 deletion docs/organization/integrations/feature-flag/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ description: "Learn more about Sentry's feature flag integrations."
---

- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
- [Self-Serve](/organization/integrations/feature-flag/self-serve/)
- [Generic](/organization/integrations/feature-flag/generic/)
- [Split](/organization/integrations/feature-flag/split/)
- [Unleash](/organization/integrations/feature-flag/unleash/)
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ 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).
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

To set up evaluation tracking visit one of our supported languages pages:
To set up evaluation tracking, visit one of our supported languages pages:
* [JavaScript](/platforms/javascript/configuration/integrations/launchdarkly/)
* [Python](/platforms/python/integrations/feature-flags/launchdarkly/)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Self-Serve Feature Flags Integration
title: Generic Feature Flags Integration
description: "Learn how to attach custom feature flag data to Sentry error events."
notSupported:
- javascript.aws-lambda
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/feature-flags/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ description: With Feature Flags, Sentry tracks feature flag evaluations in your
Evaluation tracking requires enabling an SDK integration. Integrations are provider specific. Documentation for supported providers is listed below.
- [OpenFeature](/platforms/javascript/configuration/integrations/openfeature/)
- [LaunchDarkly](/platforms/javascript/configuration/integrations/launchdarkly/)
- [Self-Serve](/platforms/javascript/configuration/integrations/self-serve/)
- [Generic](/platforms/javascript/configuration/integrations/generic/)

<PlatformContent includePath="feature-flags/enable-change-tracking" />
2 changes: 1 addition & 1 deletion docs/platforms/python/feature-flags/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ Evaluation tracking requires enabling an SDK integration. Integrations are provi

- [OpenFeature](/platforms/python/integrations/feature-flags/openfeature/)
- [LaunchDarkly](/platforms/python/integrations/feature-flags/launchdarkly/)
- [Self-Serve](/platforms/python/integrations/feature-flags/self-serve/)
- [Generic](/platforms/python/integrations/feature-flags/generic/)

<PlatformContent includePath="feature-flags/enable-change-tracking" />
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Self-Serve
title: Generic
description: "Learn how to attach custom feature flag data to Sentry error events."
---

<PlatformContent includePath="feature-flags/prerelease-alert" />

The Feature Flags integration allows you to manually track feature flag evaluations through an API. These evaluations are held in memory, and in the event an error occurs, sent to Sentry for review and analysis. Specifically, the self-serve integration enables users to integrate with proprietary (or otherwise unsupported) feature flagging solutions. **At the moment, we only support boolean flag evaluations.**
The Feature Flags integration allows you to manually track feature flag evaluations through an API. These evaluations are held in memory, and in the event an error occurs, sent to Sentry for review and analysis. Specifically, the generic integration enables users to integrate with proprietary (or otherwise unsupported) feature flagging solutions. **At the moment, we only support boolean flag evaluations.**

## Install

Expand Down
2 changes: 1 addition & 1 deletion docs/product/explore/feature-flags/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Change tracking enables Sentry to listen for additions, removals, and modificati

To set up change tracking, visit the webhook integration documentation for your provider:
* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking)
* [Self-Serve](/organization/integrations/feature-flag/self-serve/#change-tracking)
* [Generic](/organization/integrations/feature-flag/generic/#change-tracking)

0 comments on commit 9c12252

Please sign in to comment.