Add Ruby feature flags documentation #33233
Conversation
Preview links (active after the
|
| Before setting up the Ruby Feature Flags SDK, ensure you have: | ||
|
|
||
| - **Datadog Agent** with [Remote Configuration][1] enabled | ||
| - **Datadog Ruby tracer** `datadog` version 2.23.0 or later |
There was a problem hiding this comment.
Not yet published. Assuming this will be in the next minor release https://github.com/DataDog/dd-trace-rb/releases
| client = OpenFeature::SDK.build_client | ||
| ``` | ||
|
|
||
| The client returns default values until remote configuration loads in the background. This approach keeps your application responsive during startup but may serve defaults for early requests. |
There was a problem hiding this comment.
Provider eventing is not yet supported in OpenFeature: https://github.com/open-feature/ruby-sdk?tab=readme-ov-file#eventing
Eventing is needed for proper separation of non-blocking-vs-blocking between set_provider vs set_provider_and_wait so I'm leaving that out of the docs for now. I'm currently working on a pull request to get OpenFeature's set_provider_and_wait to match the event-based OpenFeature spec and then I can add a section for the blocking version of setting the provider to this doc (which is likely a common use-case)
- Port content from setup/ruby.md to server/ruby.md - Maintain all Vale linting fixes from previous commits - Include prerequisites, installation, usage examples, and troubleshooting - Support for boolean, string, number, object flags and evaluation context
sameerank
force-pushed
the
sameerank/feature-flags-ruby
branch
from
44b7ec5 to
955af79
Compare
|
Whoops sorry about the mess above. I had mistakenly started the branch off master 😅 |
|
|
||
| - **Datadog Agent** with [Remote Configuration][1] enabled | ||
| - **Datadog Ruby tracer** `datadog` version 2.23.0 or later | ||
| - **OpenFeature Ruby SDK** `openfeature-sdk` version 0.4.1 or later |
Co-authored-by: Leo Romanovsky <[email protected]>
Add setup documentation for using Datadog Feature Flags with Ruby applications. Includes installation, configuration, and usage examples for all flag types.
Not yet in https://github.com/DataDog/dd-trace-rb/releases but will be with 2.23.0
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes