Add python documentation for OpenFeature implementation #33247
Merged
Conversation
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
dd-oleksii
force-pushed
the
oleksii/featureflags-python
branch
from
71fe69b to
2359937
Compare
Contributor
|
Opened DOCS-12872 to follow up with editorial review. |
Contributor
Preview links (active after the
|
leoromanovsky
approved these changes
Dec 9, 2025
|
|
||
| Before setting up the Python Feature Flags SDK, ensure you have: | ||
|
|
||
| - **Datadog Agent** with [Remote Configuration][2] enabled |
Contributor
There was a problem hiding this comment.
Good idea; I removed the min version from mine too
| export DD_EXPERIMENTAL_FLAGGING_PROVIDER_ENABLED=true | ||
| {{< /code-block >}} | ||
|
|
||
| ### Remote Configuration not working |
Contributor
There was a problem hiding this comment.
be more specific; what is not working
Member
Author
There was a problem hiding this comment.
Good callout. I actually don't know how this would manifest. Provider never initializing? Perhaps this can be a common section for all SDKs
| ### Remote Configuration not working | ||
|
|
||
| Verify that: | ||
| 1. Your Datadog Agent is version 7.55 or later |
Member
Author
There was a problem hiding this comment.
I know this one is high. The reasoning here is that this is the version we're sure works with feature flags. So in case of any issues, we're suggesting to upgrade to latest
1 task
leoromanovsky
added a commit
that referenced
this pull request
Dec 17, 2025
* add ffe server sdk landing page and stubs for each language * add to sidebar * poll * simpler setup * rebuild nav structure also: - rename `setup` to `client` - update links, other URL references * add tile layout for server landing page + also renames the tile partial in the client page for consistency * add go docs for openfeature implementation (#33234) * add go docs for openfeature implementation * add docs for blocking init, custom timeout, non blocking * no agent version * Documentation for dd-trace with feature flagging support (#33165) * Documentation for dd-trace with feature flagging support * Update content/en/feature_flags/setup/nodejs.md Co-authored-by: Leo Romanovsky <[email protected]> --------- Co-authored-by: Leo Romanovsky <[email protected]> * Add Ruby feature flags documentation (#33233) * Add Ruby feature flags server documentation - 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 * Update content/en/feature_flags/server/ruby.md Co-authored-by: Leo Romanovsky <[email protected]> --------- Co-authored-by: Leo Romanovsky <[email protected]> * Add python documentation for OpenFeature implementation (#33247) * consolidate duplicate files Files were in two different paths (older `setup` path and newer `server` path) * Add Java Feature Flags Setup Documentation (#33194) * Add Java Feature Flags setup documentation - Add comprehensive Java SDK onboarding guide - Include installation instructions for Maven and Gradle - Document OpenFeature provider initialization and usage - Add code examples for all flag types (boolean, string, int, double, object) - Document error handling and common error codes - Include best practices and troubleshooting guide - Add Java to feature flags setup page navigation - Document integration with Datadog APM and exposure tracking Related: FFE Server SDK code freeze preparation * fix(docs): Add missing bootstrap JAR and improve Java Feature Flags documentation Critical fixes: - Add missing dd-java-agent-feature-flagging-bootstrap dependency to all examples - Add Building from Source section with detailed instructions - Explain bootstrap module purpose (classloader communication) - Add troubleshooting for ClassNotFoundException Improvements to match Java APM documentation patterns: - Add application server configuration tabs (Spring Boot, Tomcat, JBoss, Jetty, Docker) - Update all code examples to use SLF4J logger instead of System.out/err - Add Compatibility requirements section - Add Getting started section - Update initialization example to show complete application structure Code quality: - Use logger.info/warn/error throughout with parameterized messages - Show proper exception handling with logger - Match actual implementation in ffe-dogfooding repo - Include named client usage ("my-app") The documentation now accurately reflects the required dependencies, follows established Datadog docs patterns, and provides complete setup instructions for the development build. * docs(java): Improve documentation based on review feedback Changes: - Add cross-linking to Configuration section from early warning - Add OpenFeature SDK to compatibility requirements (it is required) - Remove all local build instructions (only reference published X.X.X versions) - Add skip guidance for users with existing agent/remote-config setup - Clarify ProviderNotReadyError is OpenFeature exception (optional handling) - Update exception handling to be optional based on availability requirements - Note that not catching exception may prevent application startup Improvements: - Users with existing APM can skip to provider initialization - Users with existing remote-config can skip agent configuration - Clear guidance on when exception handling is optional vs required - Removed all references to building from source * docs(java): Add event state watching and clarify provider instance sharing Changes: - Add PROVIDER_ERROR and PROVIDER_STALE event listeners to async init example - Note that PROVIDER_CONFIGURATION_CHANGED is optional (depends on provider support) - Update multiple clients section: "organize context and flags" (not just flags) - Clarify that Provider instance is shared globally (client names are organizational only) The Provider constructor doesn't take a name parameter - it's a single shared instance. Named clients are just for organizing your application code, not separate providers. * docs(java): Align flag keys and attributes with mobile SDK conventions Changes: - Update all flag keys to use dot notation (matching Android/iOS): * new-checkout-flow -> checkout.new * ui-theme -> ui.theme * payment-api-endpoint -> payment.api.endpoint * max-retries -> retries.max * discount-rate -> pricing.discount.rate * feature-config -> ui.config * All other flags updated to dot notation - Standardize attribute to use "tier" consistently (not "plan") - Remove "country" attribute from basic example to match mobile simplicity This creates consistency across all SDK documentation and makes it easier for users to migrate between platforms or reference examples. * fix tile image, add page to side nav * headings: sentence-case capitalization * style linter, general style edits * Add Java Feature Flags setup documentation - Add comprehensive Java SDK onboarding guide - Include installation instructions for Maven and Gradle - Document OpenFeature provider initialization and usage - Add code examples for all flag types (boolean, string, int, double, object) - Document error handling and common error codes - Include best practices and troubleshooting guide - Add Java to feature flags setup page navigation - Document integration with Datadog APM and exposure tracking Related: FFE Server SDK code freeze preparation * fix(docs): Add missing bootstrap JAR and improve Java Feature Flags documentation Critical fixes: - Add missing dd-java-agent-feature-flagging-bootstrap dependency to all examples - Add Building from Source section with detailed instructions - Explain bootstrap module purpose (classloader communication) - Add troubleshooting for ClassNotFoundException Improvements to match Java APM documentation patterns: - Add application server configuration tabs (Spring Boot, Tomcat, JBoss, Jetty, Docker) - Update all code examples to use SLF4J logger instead of System.out/err - Add Compatibility requirements section - Add Getting started section - Update initialization example to show complete application structure Code quality: - Use logger.info/warn/error throughout with parameterized messages - Show proper exception handling with logger - Match actual implementation in ffe-dogfooding repo - Include named client usage ("my-app") The documentation now accurately reflects the required dependencies, follows established Datadog docs patterns, and provides complete setup instructions for the development build. * docs(java): Improve documentation based on review feedback Changes: - Add cross-linking to Configuration section from early warning - Add OpenFeature SDK to compatibility requirements (it is required) - Remove all local build instructions (only reference published X.X.X versions) - Add skip guidance for users with existing agent/remote-config setup - Clarify ProviderNotReadyError is OpenFeature exception (optional handling) - Update exception handling to be optional based on availability requirements - Note that not catching exception may prevent application startup Improvements: - Users with existing APM can skip to provider initialization - Users with existing remote-config can skip agent configuration - Clear guidance on when exception handling is optional vs required - Removed all references to building from source * docs(java): Add event state watching and clarify provider instance sharing Changes: - Add PROVIDER_ERROR and PROVIDER_STALE event listeners to async init example - Note that PROVIDER_CONFIGURATION_CHANGED is optional (depends on provider support) - Update multiple clients section: "organize context and flags" (not just flags) - Clarify that Provider instance is shared globally (client names are organizational only) The Provider constructor doesn't take a name parameter - it's a single shared instance. Named clients are just for organizing your application code, not separate providers. * docs(java): Align flag keys and attributes with mobile SDK conventions Changes: - Update all flag keys to use dot notation (matching Android/iOS): * new-checkout-flow -> checkout.new * ui-theme -> ui.theme * payment-api-endpoint -> payment.api.endpoint * max-retries -> retries.max * discount-rate -> pricing.discount.rate * feature-config -> ui.config * All other flags updated to dot notation - Standardize attribute to use "tier" consistently (not "plan") - Remove "country" attribute from basic example to match mobile simplicity This creates consistency across all SDK documentation and makes it easier for users to migrate between platforms or reference examples. * docs(java): Move Java Feature Flags docs to server/ directory - Move java.md from feature_flags/setup/ to feature_flags/setup/server/ - Update frontmatter to reference server-side landing page - Apply style edits from linter (sentence-case headings, consistent capitalization) * extra dev info * various style edits * section collapsing * better sections * reduce expanders --------- Co-authored-by: Joe Peeples <[email protected]> * remove Java from client-side tile partial * Python review edits also applied to other languages with the same text * Ruby review edits and other languages with same text * Go review edits and other languages with same text * Node.js review edits + other languages * clean up links --------- Co-authored-by: Joe Peeples <[email protected]> Co-authored-by: Greg Huels <[email protected]> Co-authored-by: Sameeran Kunche <[email protected]> Co-authored-by: Oleksii Shmalko <[email protected]> Co-authored-by: Tyler Potter <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do? What is the motivation?
This is documentation for Python integration with OpenFeature which is supported since ddtrace-3.19.0
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