From 9124ad61a1e1a6cd5e07cabfcd47a2e8f3df9ff4 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Wed, 11 Feb 2026 16:25:25 +0000 Subject: [PATCH 1/2] Clarify timeout units in env var docs OTLP timeout env vars lacked unit specification, causing confusion. Added (in seconds) to docs for OTEL_EXPORTER_OTLP_TIMEOUT and related vars. Fixes #4858 --- .../sdk/environment_variables/__init__.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py index 5baf5fcd55..a5a601a72f 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py @@ -247,7 +247,7 @@ """ .. envvar:: OTEL_EXPORTER_JAEGER_TIMEOUT -Maximum time the Jaeger exporter will wait for each batch export. +Maximum time (in seconds) the Jaeger exporter will wait for each batch export. Default: 10 """ @@ -334,7 +334,7 @@ """ .. envvar:: OTEL_EXPORTER_OTLP_TIMEOUT -The :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` is the maximum time the OTLP exporter will wait for each batch export. +The :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will wait for each batch export. Default: 10 """ @@ -682,16 +682,18 @@ def channel_credential_provider() -> grpc.ChannelCredentials: """ .. envvar:: OTEL_EXPORTER_OTLP_TRACES_TIMEOUT -The :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` is the maximum time the OTLP exporter will +The :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will wait for each batch export for spans. +Default: 10 """ OTEL_EXPORTER_OTLP_METRICS_TIMEOUT = "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT" """ .. envvar:: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT -The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time the OTLP exporter will +The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will wait for each batch export for metrics. +Default: 10 """ OTEL_EXPORTER_OTLP_METRICS_INSECURE = "OTEL_EXPORTER_OTLP_METRICS_INSECURE" @@ -724,8 +726,9 @@ def channel_credential_provider() -> grpc.ChannelCredentials: """ .. envvar:: OTEL_EXPORTER_OTLP_LOGS_TIMEOUT -The :envvar:`OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` is the maximum time the OTLP exporter will +The :envvar:`OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will wait for each batch export for logs. +Default: 10 """ OTEL_EXPORTER_JAEGER_CERTIFICATE = "OTEL_EXPORTER_JAEGER_CERTIFICATE" From 433e67a8a785c534b917a97f8b92ee67a88e4759 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Wed, 11 Feb 2026 16:28:59 +0000 Subject: [PATCH 2/2] add changelog entry --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 203845656c..1be14d9af3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased +- `opentelemetry-sdk`: Clarify timeout units in environment variable documentation + ([#4906](https://github.com/open-telemetry/opentelemetry-python/pull/4906)) - `opentelemetry-exporter-otlp-proto-grpc`: Fix re-initialization of gRPC channel on UNAVAILABLE error ([#4825](https://github.com/open-telemetry/opentelemetry-python/pull/4825)) - `opentelemetry-exporter-prometheus`: Fix duplicate HELP/TYPE declarations for metrics with different label sets