Skip to content

Commit d41069e

Browse files
MikeGoldsmithJWinermaSplunk
authored andcommitted
docs: Clarify timeout units in env var docs (open-telemetry#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 open-telemetry#4858 * add changelog entry
1 parent e3436c1 commit d41069e

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

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
@@ -263,7 +263,7 @@
263263
"""
264264
.. envvar:: OTEL_EXPORTER_JAEGER_TIMEOUT
265265
266-
Maximum time the Jaeger exporter will wait for each batch export.
266+
Maximum time (in seconds) the Jaeger exporter will wait for each batch export.
267267
Default: 10
268268
"""
269269

@@ -350,7 +350,7 @@
350350
"""
351351
.. envvar:: OTEL_EXPORTER_OTLP_TIMEOUT
352352
353-
The :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` is the maximum time the OTLP exporter will wait for each batch export.
353+
The :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will wait for each batch export.
354354
Default: 10
355355
"""
356356

@@ -698,16 +698,18 @@ def channel_credential_provider() -> grpc.ChannelCredentials:
698698
"""
699699
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_TIMEOUT
700700
701-
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` is the maximum time the OTLP exporter will
701+
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will
702702
wait for each batch export for spans.
703+
Default: 10
703704
"""
704705

705706
OTEL_EXPORTER_OTLP_METRICS_TIMEOUT = "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT"
706707
"""
707708
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
708709
709-
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time the OTLP exporter will
710+
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will
710711
wait for each batch export for metrics.
712+
Default: 10
711713
"""
712714

713715
OTEL_EXPORTER_OTLP_METRICS_INSECURE = "OTEL_EXPORTER_OTLP_METRICS_INSECURE"
@@ -740,8 +742,9 @@ def channel_credential_provider() -> grpc.ChannelCredentials:
740742
"""
741743
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_TIMEOUT
742744
743-
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` is the maximum time the OTLP exporter will
745+
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` is the maximum time (in seconds) the OTLP exporter will
744746
wait for each batch export for logs.
747+
Default: 10
745748
"""
746749

747750
OTEL_EXPORTER_JAEGER_CERTIFICATE = "OTEL_EXPORTER_JAEGER_CERTIFICATE"

0 commit comments

Comments
 (0)