Skip to content
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

feat(flags): document python FeatureFlagsIntegration for custom flag tracking #12152

Closed
wants to merge 12 commits into from

Conversation

aliu39
Copy link
Member

@aliu39 aliu39 commented Dec 16, 2024

Do not merge until getsentry/sentry-python#3860 is released. This doc follows the structure of python/integrations/launchdarkly/ and openfeature/

Copy link

vercel bot commented Dec 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 8:50pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Jan 6, 2025 8:50pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jan 6, 2025 8:50pm

Copy link

codecov bot commented Dec 16, 2024

Bundle Report

Changes will increase total bundle size by 204 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.37MB 210 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.28MB 6 bytes (-0.0%) ⬇️

@aliu39 aliu39 requested a review from a team December 16, 2024 20:35
@aliu39 aliu39 changed the title feat(flags): document python FeatureFlagsIntegration for custom flag … feat(flags): document python FeatureFlagsIntegration for custom flag tracking Dec 16, 2024

## Install

Install `sentry-sdk` (>=TODO:) from PyPI.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO after release!


```python
import sentry_sdk
from sentry_sdk.integrations.featureflags import FeatureFlagsIntegration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The module's name need to be feature_flags. Spaces are rendered as underscores in Python module names. This needs to be fixed within the SDK code. You can keep the featureflags module for backwards compatibility reasons but we shouldn't document it. We probably don't need the backwards compatibility any way as I doubt anyone's using it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spaces are rendered as underscores in Python module names. This needs to be fixed within the SDK code.

What code are you referring to? Where do we have "feature flags"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aliu39
Copy link
Member Author

aliu39 commented Jan 6, 2025

Including this in another PR: https://github.com/getsentry/sentry-docs/pull/12203/files#r1904618798

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants