-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(flags): document statsig python integration #12722
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8de1cbf
feat(flags): document statsig python integration
aliu39 886927d
Statsig feature gates
aliu39 bd93541
Address todos
aliu39 8c9e73c
Add to integrations table
aliu39 420dab5
Merge branch 'master' into aliu/statsig-python
antonpirker 120719b
Fixed links
antonpirker 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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
title: Statsig | ||
description: "Learn how to use Sentry with Statsig." | ||
--- | ||
|
||
<PlatformContent includePath="feature-flags/prerelease-alert" /> | ||
|
||
The [Statsig](https://www.statsig.com/) integration tracks feature flag evaluations produced by the Statsig Python Server SDK. These evaluations are held in memory and sent to Sentry for review and analysis if an error occurs. **At the moment, we only support boolean flag evaluations from Statsig's `check_gate` function.** Learn more about [Statsig feature gates](https://docs.statsig.com/feature-flags/working-with/). | ||
|
||
## Install | ||
|
||
Install `sentry-sdk` from PyPI with the `statsig` extra. | ||
|
||
```bash | ||
pip install --upgrade 'sentry-sdk[statsig]' | ||
``` | ||
|
||
## Configure | ||
|
||
Add `StatsigIntegration` to your `integrations` list: | ||
|
||
```python | ||
import sentry_sdk | ||
from sentry_sdk.integrations.statsig import StatsigIntegration | ||
|
||
sentry_sdk.init( | ||
dsn="___PUBLIC_DSN___", | ||
# Add data like request headers and IP for users, if applicable; | ||
# see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info | ||
send_default_pii=True, | ||
integrations=[StatsigIntegration()], | ||
) | ||
``` | ||
|
||
For more information on how to use Statsig, read Statsig's [Python reference](https://docs.statsig.com/server/pythonSDK) and [quickstart guide](https://docs.statsig.com/guides/first-feature). | ||
|
||
## Verify | ||
|
||
Test the integration by evaluating a feature flag using your Statsig SDK before capturing an exception. | ||
|
||
```python {tabTitle: Python, using is_enabled} | ||
import sentry_sdk | ||
from statsig.statsig_user import StatsigUser | ||
from statsig import statsig | ||
|
||
statsig.initialize("server-secret-key") | ||
# TODO: wait for initialization to complete? | ||
|
||
result = statsig.check_gate(StatsigUser("my-user-id"), "my-feature-gate") | ||
sentry_sdk.capture_exception(Exception("Something went wrong!")) | ||
``` | ||
|
||
Visit the [Sentry website](https://sentry.io/issues/) and confirm that your error | ||
event has recorded the feature flag "my-feature-gate", and its value is equal to `result`. | ||
|
||
## Supported Versions | ||
|
||
- statsig >= 0.55.3 | ||
- sentry-sdk >= TODO: | ||
aliu39 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- python >= 3.7 | ||
|
||
<PlatformContent includePath="feature-flags/next-steps" /> |
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.