-
Notifications
You must be signed in to change notification settings - Fork 778
docs: clarify unit for OTEL_EXPORTER_OTLP_TIMEOUT default #4860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py
Show resolved
Hide resolved
emdneto
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This reminded me that we need to update matrix compliance #4044 (comment)
I think it is worth having a quick note on this env var stating it is not compliant and referring to #4044.
…__init__.py Co-authored-by: Emídio Neto <[email protected]>
Spec says it should be in milliseconds, but the current implementation is handling it in seconds, so that's why the Python SDK is not compliant. If you use the example as |
Description
Clarify the unit for the documented default value of
OTEL_EXPORTER_OTLP_TIMEOUTin the SDK environment variables docs.The current docs show
Default: 10without stating the unit, which can lead to operators misinterpreting the value (e.g., 10ms vs 10s). This PR updates only the default line to make the unit explicit while keeping the surrounding wording consistent with existing env var docs.Fixes #4858
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Repro steps:
python -m pip install -r docs-requirements.txtcd docs && python -m sphinx -b html -D master_doc=sdk/environment_variables . _build/html_envvarsDoes This PR Require a Contrib Repo Change?
Checklist: