DOC(exporter-otlp-proto-http): clarify endpoint= kwarg requires full signal path - #5633
Open
karlhillx wants to merge 2 commits into
Open
DOC(exporter-otlp-proto-http): clarify endpoint= kwarg requires full signal path#5633karlhillx wants to merge 2 commits into
karlhillx wants to merge 2 commits into
Conversation
… path
The endpoint= kwarg is used verbatim, while OTEL_EXPORTER_OTLP_ENDPOINT
gets the signal path appended in _resolve_endpoint. The existing
docstring ('Target URL to which the exporter is going to send ...')
doesn't say which of the two the kwarg carries, so users who pass a
base URL with a settings layer or secrets manager get a permanent 404
at the collector with no hint why.
Document that endpoint= must include the full signal path, and that
OTEL_EXPORTER_OTLP_ENDPOINT is the right knob for a base URL.
Closes open-telemetry#5628.
|
|
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes are limited to accurate docstring clarifications consistent with the described behavior and scope (HTTP exporters only).
Pull request overview
This PR clarifies the OTLP/HTTP exporters’ endpoint= constructor argument semantics: when passed explicitly it must be the full signal-specific URL (including /v1/{signal}), while the base-URL behavior is provided via OTEL_EXPORTER_OTLP_ENDPOINT. This addresses the user confusion described in #5628 without changing runtime behavior.
Changes:
- Updated
endpointparameter docstring for the OTLP/HTTP trace exporter to require the full signal path and to referenceOTEL_EXPORTER_OTLP_ENDPOINTfor base-URL configuration. - Applied the same clarification to the OTLP/HTTP metrics exporter docstring.
- Applied the same clarification to the OTLP/HTTP logs exporter docstring.
File summaries
| File | Description |
|---|---|
| exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/trace_exporter/init.py | Clarifies endpoint= must include /v1/traces; points base-URL users to OTEL_EXPORTER_OTLP_ENDPOINT. |
| exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/metric_exporter/init.py | Clarifies endpoint= must include /v1/metrics; points base-URL users to OTEL_EXPORTER_OTLP_ENDPOINT. |
| exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_log_exporter/init.py | Clarifies endpoint= must include /v1/logs; points base-URL users to OTEL_EXPORTER_OTLP_ENDPOINT. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Pull request dashboard statusWaiting on reviewers · refreshed 2026-09-06 02:25 UTC Review the latest changes. Status above doesn't look right?
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #5628.
The
endpoint=kwarg is used verbatim, but the env-var path appendsthe signal path in
_resolve_endpoint. The previous docstring("Target URL to which the exporter is going to send ...") didn't
distinguish the two, so users passing a base URL got a permanent 404
at the collector with no hint why.
State the full signal path requirement on the kwarg and point at
OTEL_EXPORTER_OTLP_ENDPOINTfor the base-URL case. Behavior unchanged.Scope: the three HTTP exporters (trace, metric, log). The gRPC
exporters route by service, not path, so they were left alone.