Skip to content

docs: Clarify timeout units in env var docs#4906

Open
MikeGoldsmith wants to merge 3 commits intoopen-telemetry:mainfrom
honeycombio:mike/4858-clarify-timeout-units
Open

docs: Clarify timeout units in env var docs#4906
MikeGoldsmith wants to merge 3 commits intoopen-telemetry:mainfrom
honeycombio:mike/4858-clarify-timeout-units

Conversation

@MikeGoldsmith
Copy link
Member

@MikeGoldsmith MikeGoldsmith commented Feb 11, 2026

Description

Clarifies timeout units in environment variable documentation. Users were confused whether OTEL_EXPORTER_OTLP_TIMEOUT=10 meant 10ms or 10s.

Added "(in seconds)" to documentation for:

  • OTEL_EXPORTER_OTLP_TIMEOUT
  • OTEL_EXPORTER_OTLP_TRACES_TIMEOUT
  • OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
  • OTEL_EXPORTER_OTLP_LOGS_TIMEOUT
  • OTEL_EXPORTER_JAEGER_TIMEOUT (bonus fix for consistency)

Also added missing "Default: 10" to signal-specific timeout vars.

Fixes #4858

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

  • Documentation-only change, verified formatting

Does This PR Require a Contrib Repo Change?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

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
@MikeGoldsmith MikeGoldsmith requested a review from a team as a code owner February 11, 2026 16:27
@emdneto emdneto moved this to Easy to review / merge / close in @xrmx's Python PR digest Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Easy to review / merge / close

Development

Successfully merging this pull request may close these issues.

Docs: clarify unit for OTEL_EXPORTER_OTLP_TIMEOUT (seconds vs milliseconds)

3 participants