docs(config): document OTEL_PYTHON_* bypass when OTEL_CONFIG_FILE is set#5353
Open
MikeGoldsmith wants to merge 3 commits into
Open
docs(config): document OTEL_PYTHON_* bypass when OTEL_CONFIG_FILE is set#5353MikeGoldsmith wants to merge 3 commits into
MikeGoldsmith wants to merge 3 commits into
Conversation
MikeGoldsmith
added
the
config
ocelotl
approved these changes
Jun 26, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Documents the current behaviour of
OTEL_PYTHON_*Python-implementation extensions whenOTEL_CONFIG_FILEis set: they are bypassed entirely because the env-var initialisation path is skipped in favour of the declarative file.Two surfaces touched:
OTEL_CONFIG_FILEdocstring inopentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py.docs/sdk/configuration.rst.This closes #5335 (the current-behaviour decision). The future-state work, where
OTEL_PYTHON_*extensions could continue to apply alongside a config file, is tracked separately in #5352.Fixes #5335
Type of change
How Has This Been Tested?
tox -e docsbuilds clean.Does This PR Require a Contrib Repo Change?
Checklist: