Skip to content

Commit ba5fc05

Browse files
docs: Clarify timeout units in env var docs (#4906)
* 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 * add changelog entry
1 parent 681384e commit ba5fc05

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212

1313
## Unreleased
1414

15+
- `opentelemetry-sdk`: Clarify timeout units in environment variable documentation
16+
([#4906](https://github.com/open-telemetry/opentelemetry-python/pull/4906))
1517
- `opentelemetry-exporter-otlp-proto-grpc`: Fix re-initialization of gRPC channel on UNAVAILABLE error
1618
([#4825](https://github.com/open-telemetry/opentelemetry-python/pull/4825))
1719
- `opentelemetry-exporter-prometheus`: Fix duplicate HELP/TYPE declarations for metrics with different label sets

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@
247247
"""
248248
.. envvar:: OTEL_EXPORTER_JAEGER_TIMEOUT
249249
250-
Maximum time the Jaeger exporter will wait for each batch export.
250+
Maximum time (in seconds) the Jaeger exporter will wait for each batch export.
251251
Default: 10
252252
"""
253253

@@ -334,7 +334,7 @@
334334
"""
335335
.. envvar:: OTEL_EXPORTER_OTLP_TIMEOUT
336336
337-
The :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` is the maximum time the OTLP exporter will wait for each batch export.
337+
The :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will wait for each batch export.
338338
Default: 10
339339
"""
340340

@@ -682,16 +682,18 @@ def channel_credential_provider() -> grpc.ChannelCredentials:
682682
"""
683683
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_TIMEOUT
684684
685-
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` is the maximum time the OTLP exporter will
685+
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will
686686
wait for each batch export for spans.
687+
Default: 10
687688
"""
688689

689690
OTEL_EXPORTER_OTLP_METRICS_TIMEOUT = "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT"
690691
"""
691692
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
692693
693-
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time the OTLP exporter will
694+
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will
694695
wait for each batch export for metrics.
696+
Default: 10
695697
"""
696698

697699
OTEL_EXPORTER_OTLP_METRICS_INSECURE = "OTEL_EXPORTER_OTLP_METRICS_INSECURE"
@@ -724,8 +726,9 @@ def channel_credential_provider() -> grpc.ChannelCredentials:
724726
"""
725727
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_TIMEOUT
726728
727-
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` is the maximum time the OTLP exporter will
729+
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will
728730
wait for each batch export for logs.
731+
Default: 10
729732
"""
730733

731734
OTEL_EXPORTER_JAEGER_CERTIFICATE = "OTEL_EXPORTER_JAEGER_CERTIFICATE"

0 commit comments

Comments
 (0)