docs: Clarify timeout units in env var docs #4906
Open
+10
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Clarifies timeout units in environment variable documentation. Users were confused whether
OTEL_EXPORTER_OTLP_TIMEOUT=10meant 10ms or 10s.Added "(in seconds)" to documentation for:
OTEL_EXPORTER_OTLP_TIMEOUTOTEL_EXPORTER_OTLP_TRACES_TIMEOUTOTEL_EXPORTER_OTLP_METRICS_TIMEOUTOTEL_EXPORTER_OTLP_LOGS_TIMEOUTOTEL_EXPORTER_JAEGER_TIMEOUT(bonus fix for consistency)Also added missing "Default: 10" to signal-specific timeout vars.
Fixes #4858
Type of change
How Has This Been Tested?
Does This PR Require a Contrib Repo Change?
Checklist: