Skip to content

docs: clarify unit for OTEL_EXPORTER_OTLP_TIMEOUT default - #4860

Closed
ta-ke-inf wants to merge 3 commits into
open-telemetry:mainfrom
ta-ke-inf:feature
Closed

ta-ke-inf wants to merge 3 commits into
open-telemetry:mainfrom
ta-ke-inf:feature

Conversation

@ta-ke-inf

@ta-ke-inf ta-ke-inf commented Dec 17, 2025 •

Copy link
Copy Markdown

Description

Clarify the unit for the documented default value of OTEL_EXPORTER_OTLP_TIMEOUT in the SDK environment variables docs.

The current docs show Default: 10 without 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.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • Built the docs locally with Sphinx

Repro steps:

  • python -m pip install -r docs-requirements.txt
  • cd docs && python -m sphinx -b html -D master_doc=sdk/environment_variables . _build/html_envvars

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated (not needed for docs-only clarification)
  • Unit tests have been added (not applicable)
  • Documentation has been updated

@ta-ke-inf
ta-ke-inf requested a review from a team as a code owner December 17, 2025 05:10
@linux-foundation-easycla

linux-foundation-easycla Bot commented Dec 17, 2025 •

Copy link
Copy Markdown

CLA Signed

The committers listed above are authorized under a signed CLA.

@xrmx xrmx moved this to Easy to review / merge / close in Python PR digest Dec 17, 2025

@emdneto emdneto left a comment

Copy link
Copy Markdown
Member

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 <9735060+emdneto@users.noreply.github.com>
@ta-ke-inf
ta-ke-inf requested a review from emdneto December 18, 2025 04:39
@ta-ke-inf

Copy link
Copy Markdown
Author

@emdneto

a2a2ddf

Thank you! As also mentioned in #4044, it seems that OTEL_EXPORTER_OTLP_TIMEOUT currently needs to be specified in milliseconds, so to avoid confusion I propose updating the documentation to use 10000 instead of 10 for now.

@emdneto

emdneto commented Dec 24, 2025

Copy link
Copy Markdown
Member

@emdneto

a2a2ddf

Thank you! As also mentioned in #4044, it seems that OTEL_EXPORTER_OTLP_TIMEOUT currently needs to be specified in milliseconds, so to avoid confusion I propose updating the documentation to use 10000 instead of 10 for now.

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 10000, users can get confused and have 10000 seconds as a timeout instead 😓

@xrmx xrmx moved this from Easy to review / merge / close to Reviewed PRs that need fixes in Python PR digest Dec 31, 2025

@emdneto emdneto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest we keep it in seconds as the implementation

@xrmx

xrmx commented Feb 16, 2026

Copy link
Copy Markdown
Contributor

Thanks for your PR but I'm closing this as superseded by #4906

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Docs: clarify unit for OTEL_EXPORTER_OTLP_TIMEOUT (seconds vs milliseconds)

3 participants