Skip to content

docs(options): Promote usage of in_random_rollout #13265

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.

Sign up for GitHub

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
vgrozdanic merged 4 commits into from
Apr 7, 2025
Merged

docs(options): Promote usage of in_random_rollout #13265

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb0f657
docs(options): Promote usage of in_random_rollout
vgrozdanic Apr 7, 2025
be4de4e
better text
vgrozdanic Apr 7, 2025
f5b13b5
Merge branch 'master' into vgrozdanic/promote-random-rollout
vgrozdanic Apr 7, 2025
6bdf7e7
revert formatting
vgrozdanic Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions develop-docs/backend/application-domains/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,13 @@ If you expect to frequently update your option, you can make it editable in the
If you're working on a system-wide feature, you may choose to use options for your rollout instead of feature flags. Unlike feature flags, options don't allow for easy segmentation, but they are performant, stable, and simple to implement. e.g.,

```python
import random
from sentry import options
from sentry.options.rollout import in_random_rollout

rate = options.get("performance.some-feature-rate")
if rate > random.random():
if in_random_rollout("performance.some-feature-rate"):
do_feature_stuff()
```

However, be careful! Using `random.random` will cause your feature to be enabled and disabled randomly between page requests. This may be unacceptable for user-facing features. To avoid this, you can use the `sample_modulo` helper. e.g.,
However, be careful! `in_random_rollout` uses `random.random` under the hood, and will cause your feature to be enabled and disabled randomly between page requests. This may be unacceptable for user-facing features. To avoid this, you can use the `sample_modulo` helper. e.g.,

```python
from sentry.utils.options import sample_modulo
Expand Down