fix(otlptrace,otlpmetric): remove endpoint URL path cleaning #6710

mjq · 2025-04-29T05:32:43Z

When setting an explicit OTLP traces endpoint URL (via otlptracehttp.WithEndpointURL or the OTEL_EXPORTER_OTLP_TRACES_ENDPOINT environment variable), any given trailing slash is stripped. This makes it impossible to export traces to an endpoint requiring a trailing slash. It also conflicts with the spec:

For the per-signal variables (OTEL_EXPORTER_OTLP_<signal>_ENDPOINT), the URL MUST be used as-is without any modification. The only exception is that if an URL contains no path part, the root path / MUST be used (see Example 2).

This stripping happens due to the use of path.Clean in otlpconfig.cleanPath. From the path.Clean docs:

The returned path ends in a slash only if it is the root "/".

Other signals appear to use path.Clean and might therefore have the same bug, but I've only tested and fixed traces.

Fixes #6709.

dmathieu · 2025-04-29T07:36:54Z

the URL MUST be used as-is without any modification

This kind of indicates we should remove path.Clean entirely.

pellared · 2025-05-13T08:51:19Z

@mjq, ping 😉

See: #6710 (comment)

mjq · 2025-05-31T03:46:51Z

@pellared Sorry for the delay! I incorporated @dmathieu's feedback re: removing the usage of path.Clean. I removed it from the equivalent config option in metrics as well for consistency.

I also realized I was changing generated files in the original commit - now the changes are made to the templates and applied with make generate.

pellared · 2025-06-01T20:19:26Z

What about otlplog?

codecov · 2025-06-01T20:20:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.3%. Comparing base (274e939) to head (7c0d68a).
Report is 1 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #6710   +/-   ##
=====================================
  Coverage   82.3%   82.3%           
=====================================
  Files        263     263           
  Lines      24421   24421           
=====================================
+ Hits       20099   20102    +3     
+ Misses      3940    3937    -3     
  Partials     382     382

Files with missing lines	Coverage Δ
...tlpmetric/otlpmetricgrpc/internal/oconf/options.go	`89.0% <100.0%> (ø)`
...tlpmetric/otlpmetrichttp/internal/oconf/options.go	`91.9% <100.0%> (ø)`
...trace/otlptracegrpc/internal/otlpconfig/options.go	`94.3% <100.0%> (ø)`
...trace/otlptracehttp/internal/otlpconfig/options.go	`91.1% <100.0%> (ø)`

... and 2 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

mjq · 2025-06-02T03:00:08Z

I fixed the failing changelog check (bad automatic merge with main).

What about otlplog?

@pellared With this change path.Clean no longer appears in the codebase, and from poking around I couldn't find any equivalent code for log configs.

CHANGELOG.md

pellared · 2025-06-02T08:57:01Z

I fixed the failing changelog check (bad automatic merge with main).

What about otlplog?

@pellared With this change path.Clean no longer appears in the codebase, and from poking around I couldn't find any equivalent code for log configs.

Thanks. I noticed that otlplog does not even do strings.TrimSpace which is probably OK 😉

Co-authored-by: Robert Pająk <pellared@hotmail.com>

mjq · 2025-06-03T00:21:01Z

@pellared @dmathieu I don't have permission to merge this, so please go ahead if everything looks good or let me know if there are any further changes I should make 👍 Thanks!

pellared · 2025-06-03T05:13:32Z

@mjq, thank you very much for your contribution.

### Added - The `go.opentelemetry.io/otel/semconv/v1.33.0` package. The package contains semantic conventions from the `v1.33.0` version of the OpenTelemetry Semantic Conventions. See the [migration documentation](./semconv/v1.33.0/MIGRATION.md) for information on how to upgrade from `go.opentelemetry.io/otel/semconv/v1.32.0.`(#6799) - The `go.opentelemetry.io/otel/semconv/v1.34.0` package. The package contains semantic conventions from the `v1.34.0` version of the OpenTelemetry Semantic Conventions. (#6812) - Add metric's schema URL as `otel_scope_schema_url` label in `go.opentelemetry.io/otel/exporters/prometheus`. (#5947) - Add metric's scope attributes as `otel_scope_[attribute]` labels in `go.opentelemetry.io/otel/exporters/prometheus`. (#5947) - Add `EventName` to `EnabledParameters` in `go.opentelemetry.io/otel/log`. (#6825) - Add `EventName` to `EnabledParameters` in `go.opentelemetry.io/otel/sdk/log`. (#6825) - Changed handling of `go.opentelemetry.io/otel/exporters/prometheus` metric renaming to add unit suffixes when it doesn't match one of the pre-defined values in the unit suffix map. (#6839) ### Changed - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/bridge/opentracing`. (#6827) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/exporters/zipkin`. (#6829) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/metric`. (#6832) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/sdk/resource`. (#6834) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/sdk/trace`. (#6835) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/trace`. (#6836) - `Record.Resource` now returns `*resource.Resource` instead of `resource.Resource` in `go.opentelemetry.io/otel/sdk/log`. (#6864) - Retry now shows error cause for context timeout in `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc`, `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc`, `go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc`, `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`, `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp`, `go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp`. (#6898) ### Fixed - Stop stripping trailing slashes from configured endpoint URL in `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc`. (#6710) - Stop stripping trailing slashes from configured endpoint URL in `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`. (#6710) - Stop stripping trailing slashes from configured endpoint URL in `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc`. (#6710) - Stop stripping trailing slashes from configured endpoint URL in `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp`. (#6710) - Validate exponential histogram scale range for Prometheus compatibility in `go.opentelemetry.io/otel/exporters/prometheus`. (#6822) - Context cancellation during metric pipeline produce does not corrupt data in `go.opentelemetry.io/otel/sdk/metric`. (#6914) ### Removed - `go.opentelemetry.io/otel/exporters/prometheus` no longer exports `otel_scope_info` metric. (#6770)

fix(otlptracehttp): keep traces endpoint URL trailing slashes

7931d86

mjq requested review from MrAlias, XSAM, dashpole, pellared and dmathieu as code owners April 29, 2025 05:32

mjq changed the title ~~Ffix(otlptracehttp): keep traces endpoint URL trailing slashes~~ fix(otlptracehttp): keep traces endpoint URL trailing slashes Apr 29, 2025

add changelog

20ae89c

mjq added 2 commits May 31, 2025 11:30

remove path.Clean from otlptracehttp's options

1f5403f

apply to trace and metrics via templates

bb3fc07

mjq force-pushed the mjq-fix-traces-trailing-slash branch from b07ccf5 to bb3fc07 Compare May 31, 2025 03:44

mjq changed the title ~~fix(otlptracehttp): keep traces endpoint URL trailing slashes~~ fix(otlptrace,otlpmetric): remove endpoint URL path cleaning May 31, 2025

Merge branch 'main' into mjq-fix-traces-trailing-slash

8d9f666

mjq force-pushed the mjq-fix-traces-trailing-slash branch from c017642 to 8d9f666 Compare June 2, 2025 02:38

dmathieu approved these changes Jun 2, 2025

View reviewed changes

pellared approved these changes Jun 2, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

a801c1f

Co-authored-by: Robert Pająk <pellared@hotmail.com>

Merge branch 'main' into mjq-fix-traces-trailing-slash

7c0d68a

pellared merged commit 1636bcd into open-telemetry:main Jun 3, 2025
31 of 32 checks passed

MrAlias added this to the v1.37.0 milestone Jun 18, 2025

pellared mentioned this pull request Jun 24, 2025

Release 1.37.0/0.59.0/0.13.0 #6925

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(otlptrace,otlpmetric): remove endpoint URL path cleaning #6710

fix(otlptrace,otlpmetric): remove endpoint URL path cleaning #6710

Uh oh!

mjq commented Apr 29, 2025

Uh oh!

dmathieu commented Apr 29, 2025

Uh oh!

pellared commented May 13, 2025

Uh oh!

mjq commented May 31, 2025

Uh oh!

pellared commented Jun 1, 2025

Uh oh!

codecov bot commented Jun 1, 2025 •

edited

Loading

Uh oh!

mjq commented Jun 2, 2025

Uh oh!

Uh oh!

pellared commented Jun 2, 2025 •

edited

Loading

Uh oh!

mjq commented Jun 3, 2025

Uh oh!

Uh oh!

pellared commented Jun 3, 2025

Uh oh!

Uh oh!

fix(otlptrace,otlpmetric): remove endpoint URL path cleaning #6710

fix(otlptrace,otlpmetric): remove endpoint URL path cleaning #6710

Uh oh!

Conversation

mjq commented Apr 29, 2025

Uh oh!

dmathieu commented Apr 29, 2025

Uh oh!

pellared commented May 13, 2025

Uh oh!

mjq commented May 31, 2025

Uh oh!

pellared commented Jun 1, 2025

Uh oh!

codecov bot commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mjq commented Jun 2, 2025

Uh oh!

Uh oh!

pellared commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mjq commented Jun 3, 2025

Uh oh!

Uh oh!

pellared commented Jun 3, 2025

Uh oh!

Uh oh!

codecov bot commented Jun 1, 2025 •

edited

Loading

pellared commented Jun 2, 2025 •

edited

Loading