Skip to content

docs(config): document OTEL_PYTHON_* bypass when OTEL_CONFIG_FILE is set #5353

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

Open
MikeGoldsmith wants to merge 3 commits into
base: main
Choose a base branch
from
+18 −2
Open

docs(config): document OTEL_PYTHON_* bypass when OTEL_CONFIG_FILE is set #5353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c541a4
document OTEL_PYTHON_* bypass when OTEL_CONFIG_FILE is set
MikeGoldsmith Jun 25, 2026
b42f422
rename changelog fragment to PR #5353
MikeGoldsmith Jun 25, 2026
4023d61
Merge branch 'main' into mike/document-otel-python-bypass
MikeGoldsmith Jun 25, 2026
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
1 change: 1 addition & 0 deletions .changelog/5353.added
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`opentelemetry-sdk`: document that Python-implementation extensions (`OTEL_PYTHON_*` variables) are bypassed when `OTEL_CONFIG_FILE` is set. The env-var initialisation path is skipped entirely in favour of the declarative file; honouring these alongside a config file is tracked as a follow-up.
7 changes: 7 additions & 0 deletions docs/sdk/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,13 @@ Behavior notes
not consulted. Environment variables can still be read indirectly by
components the file enables (for example resource detectors) and via
``${env:VAR}`` substitution.
* Python-implementation extensions (``OTEL_PYTHON_*`` variables such as
``OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED`` or
``OTEL_PYTHON_TRACER_CONFIGURATOR``) are **not** applied when
``OTEL_CONFIG_FILE`` is set: the env-var initialisation path is skipped
entirely. If your app currently relies on one of these and you are
migrating to a config file, plan to capture the equivalent behaviour in
the file (or in code) instead.
* Sections omitted from the file leave the corresponding global provider
unset (a no-op provider), per the specification.
* Setting ``disabled: true`` at the top level turns the SDK into a no-op.
Expand Down
12 changes: 10 additions & 2 deletions opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,16 @@
sole source for SDK construction. Spec-defined ``OTEL_*`` variables with
schema equivalents are ignored. Env vars may still be read indirectly by
components the file enables (e.g. resource detectors) and via
``${env:VAR}`` substitution inside the file. See the OpenTelemetry
declarative configuration specification for details.
``${env:VAR}`` substitution inside the file.

Python-implementation extensions outside the spec (``OTEL_PYTHON_*``
variables such as ``OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED`` or
:envvar:`OTEL_PYTHON_TRACER_CONFIGURATOR`) are also bypassed when
:envvar:`OTEL_CONFIG_FILE` is set, because the env-var initialisation path
is skipped entirely in favour of the declarative file. Honouring these
alongside a config file is tracked separately.

See the OpenTelemetry declarative configuration specification for details.
"""

OTEL_RESOURCE_ATTRIBUTES = "OTEL_RESOURCE_ATTRIBUTES"
Expand Down
Loading