Skip to content

[otlptracegrpc] Grpc dialoption override bug - #8805

Merged
pellared merged 6 commits into
open-telemetry:mainfrom
ps-mir:grpc-dialoption-clobber-bug
Sep 1, 2026
Merged

pellared merged 6 commits into
open-telemetry:mainfrom
ps-mir:grpc-dialoption-clobber-bug

Conversation

@ps-mir

@ps-mir ps-mir commented Aug 19, 2026 •

Copy link
Copy Markdown
Member

Overview

User supplied grpc.DialOptions when supplied with otlptracegrpc.WithDialOption is being dropped because NewGRPCConfig applies its own internal defaults after applying user options.

This led to internally computed entries land (and override) after user-supplied ones leading to drop of some settings like transport credentials.

Resolves

Fix

Internal defaults are separated into its own slice (dialOptsPrefix). The final merging happens as

cfg.DialOptions = append(dialOptsPrefix, cfg.DialOptions...)

Which guarantees user supplied grpc options always take precedence, when used with WithDialOption. The change is made is shared .tmpl. The regenerated NewGRPCConfig is deadcode for otlptracehttp.

The fix is also consistent with WithDialOption comment:

// WithDialOption sets explicit grpc.DialOptions to use when making a
// connection. The options here are appended to the internal grpc.DialOptions
// used so they will take precedence over any other internal grpc.DialOptions
// they might conflict with.
// The [grpc.WithBlock], [grpc.WithTimeout], and [grpc.WithReturnConnectionError]
// grpc.DialOptions are ignored.

Followup

  • Check otlpmetricgrpc and otlploggrpc for same issue.

ps-mir added 2 commits August 19, 2026 13:38
Compute all internal defaults into a separate dialOptsPrefix slice,
then apply defaults first, user options after.

It guarantees user-supplied WithDialOption values always take precedence,
unconditionally, without needing to inspect them.
@ps-mir ps-mir changed the title Grpc dialoption clobber bug [otlptracegrpc] Grpc dialoption override bug Aug 19, 2026
@codecov

codecov Bot commented Aug 20, 2026 •

Copy link
Copy Markdown

Codecov Report

โŒ Patch coverage is 87.50000% with 2 lines in your changes missing coverage. Please review.
โœ… Project coverage is 88.4%. Comparing base (a22d2c0) to head (1681c89).

Files with missing lines Patch % Lines
...trace/otlptracehttp/internal/otlpconfig/options.go 75.0% 2 Missing โš ๏ธ
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##            main   #8805     +/-   ##
=======================================
- Coverage   88.4%   88.4%   -0.1%     
=======================================
  Files        331     331             
  Lines      21004   21006      +2     
=======================================
+ Hits       18575   18576      +1     
- Misses      2429    2430      +1     
Files with missing lines Coverage ฮ”
...trace/otlptracegrpc/internal/otlpconfig/options.go 94.5% <100.0%> (+<0.1%) โฌ†๏ธ
...trace/otlptracehttp/internal/otlpconfig/options.go 92.9% <75.0%> (+<0.1%) โฌ†๏ธ

... and 1 file with indirect coverage changes

๐Ÿš€ New features to boost your workflow:
  • โ„๏ธ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@pellared

Copy link
Copy Markdown
Member

Can you please add a changelog entry?

@ps-mir

ps-mir commented Aug 20, 2026

Copy link
Copy Markdown
Member Author

Can you please add a changelog entry?

Fixed.

@pellared pellared 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.

LGTM

The same documented-contract bug exists in both:

I am going to create issues for them to track them seperatly.

@ps-mir

ps-mir commented Aug 20, 2026 •

Copy link
Copy Markdown
Member Author

LGTM

The same documented-contract bug exists in both:

* [otlpmetricgrpc](https://github.com/open-telemetry/opentelemetry-go/blob/3b9a17270035e1336b66e7803cd09750fdad508b/exporters/otlp/otlpmetric/otlpmetricgrpc/internal/oconf/options.go#L147-L170)

* [otlploggrpc](https://github.com/open-telemetry/opentelemetry-go/blob/3b9a17270035e1336b66e7803cd09750fdad508b/exporters/otlp/otlplog/otlploggrpc/client.go#L96-L133)

I am going to create issues for them to track them seperatly.

Sounds good, I'll work on both.

waterWang added a commit to waterWang/opentelemetry-go that referenced this pull request Aug 20, 2026
โ€ฆrnal defaults (open-telemetry#8822)

User-supplied grpc.DialOption values passed via WithDialOption are
documented to be appended to internal options and therefore take precedence.
The current implementation places internal options after user options,
causing conflicting options like transport credentials to override
the user's choice.

Fix by separating internal defaults into a dialOptsPrefix slice that is
prepended to cfg.DialOptions, matching the fix applied to the trace
exporter in open-telemetry#8805.

References open-telemetry#8822.
@pellared
pellared merged commit 31dbd07 into open-telemetry:main Sep 1, 2026
49 of 51 checks passed
@pellared pellared added this to the v1.47.0 milestone Sep 1, 2026
pellared pushed a commit that referenced this pull request Sep 1, 2026
User supplied grpc.DialOptions when supplied with
otlpmetricgrpc.WithDialOption is being dropped because `NewGRPCConfig`
applies its own internal defaults after applying user options.

This led to internally computed entries land (and override) after
user-supplied ones, leading to drop of some settings like transport
credentials.

## Fix

This is the same bug and fix shape as #8805 (otlptracegrpc). One
structural difference: otlpmetricgrpc never had `grpc.WithUserAgent`
inside oconf's DialOptions to begin with (it's applied separately in
client.go), so dialOptsPrefix here only needs to hold the
service-config/credentials/compression/reconnect defaults.

Fixes #8822 

Related to #8805
pellared added a commit that referenced this pull request Oct 2, 2026
This release contains the first stable release of the OpenTelemetry Go
Logs API and SDK.
Our project stability guarantees now apply to the following modules:

- `go.opentelemetry.io/otel/log`
- `go.opentelemetry.io/otel/sdk/log`

See our [versioning
policy](https://github.com/open-telemetry/opentelemetry-go/blob/main/VERSIONING.md)
for more information about these stability guarantees.

### Added

- Add `String` method for `KeyValue` type in
`go.opentelemetry.io/otel/attribute`. (#8205)
- Add `String` method for `Set` type in
`go.opentelemetry.io/otel/attribute`. (#8347)
- Add `WithMaxExportBatchSize` to `go.opentelemetry.io/otel/sdk/metric`
to configure the maximum export batch size for `PeriodicReader`. (#8960)
- Add `WithAttributeValueDepthLimit`, `DefaultAttributeValueDepthLimit`,
and `SpanLimits.AttributeValueDepthLimit` in
`go.opentelemetry.io/otel/sdk/trace` to configure the maximum depth of
span, event, link, and instrumentation scope attribute values. (#8938)
- Add `WithAttributeValueDepthLimit` in
`go.opentelemetry.io/otel/sdk/log` to configure the maximum depth of log
record and instrumentation scope attribute values. (#8938)
- Add `WithMaxResponseSize` to
`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`,
`go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp`, and
  `go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp`. (#8941)
- Add experimental `ProbabilitySampler` in
`go.opentelemetry.io/otel/sdk/trace/x` that conforms to the
[OpenTelemetry specification's threshold-based sampling
algorithm](https://opentelemetry.io/docs/specs/otel/trace/sdk/#probabilitysampler).
(#8123)
- Add experimental `*Binder` extension interfaces in
`go.opentelemetry.io/otel/metric/x` for instruments that support binding
attributes ahead of time. (#8760)
- Add the experimental `Finisher` synchronous metric instrument
extension interface to `go.opentelemetry.io/otel/metric/x`. (#8906)

### Changed

- Use the [OpenTelemetry Attribute Collection representation for
non-OTLP
protocols](https://opentelemetry.io/docs/specs/otel/common/#attribute-collection-representation-for-non-otlp)
for metric data diffs in
`go.opentelemetry.io/otel/sdk/metric/metricdata/metricdatatest`. (#8993)
- Apply a maximum depth of 64 by default to span, event, link, log
record, and instrumentation scope attribute values in
`go.opentelemetry.io/otel/sdk/trace` and
`go.opentelemetry.io/otel/sdk/log`. (#8938)
- Reduce allocations when applying attribute value length limits in
`go.opentelemetry.io/otel/sdk/trace` and
`go.opentelemetry.io/otel/sdk/log` by rebuilding composite values only
when truncation is needed. (#8912)
- Decode `traceparent` using a hex lookup table in
`go.opentelemetry.io/otel/propagation`, which rejects the
specification-disallowed upper-case characters without a separate scan
of the header. (#8739)
- Decode all characters at constant indices in `TraceIDFromHex` and
`SpanIDFromHex` in `go.opentelemetry.io/otel/trace` to eliminate bounds
checks. (#8740)

### Fixed

- Count valid U+FFFD replacement characters toward attribute value
length limits in `go.opentelemetry.io/otel/trace`,
`go.opentelemetry.io/otel/sdk/trace`, and
`go.opentelemetry.io/otel/sdk/log`.
- Truncate string attribute values to empty strings when the configured
length limit is zero, including malformed UTF-8, in
`go.opentelemetry.io/otel/trace`, `go.opentelemetry.io/otel/sdk/trace`,
and `go.opentelemetry.io/otel/sdk/log`. (#9054)
- Fix a data race in `NewPeriodicReader` where `r.inst` was assigned
after the background goroutine was launched in
`go.opentelemetry.io/otel/sdk/metric`. (#9028)
- Prevent precision loss for large `int64` values in `Sum`, `Histogram`,
and `ExponentialHistogram` aggregations in
`go.opentelemetry.io/otel/sdk/metric`. (#8981)
- Ensure `grpc.DialOption` values passed via `WithDialOption` take
precedence over conflicting internally-computed defaults in
  `go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc`,
`go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc`, and
`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc`.
(#8805, #8834, #8836)
- Treat overflowing `OTEL_METRIC_EXPORT_INTERVAL` and
`OTEL_METRIC_EXPORT_TIMEOUT` values as invalid in
`go.opentelemetry.io/otel/sdk/metric`. (#8800)
- Prevent a panic in `NewFixedSizeReservoir` and
`FixedSizeReservoirProvider` when given a negative size in
`go.opentelemetry.io/otel/sdk/metric/exemplar`; negative sizes are now
clamped to zero, consistent with a size of zero. (#8832)
- Preserve exponential histogram `ZeroThreshold` during OTLP metric
export in `go.opentelemetry.io/otel/exporters/otlp/otlpmetric`. (#8801)
- Ensure metric helpers in `go.opentelemetry.io/otel/semconv/v1.32.0`,
`go.opentelemetry.io/otel/semconv/v1.33.0`, and
`go.opentelemetry.io/otel/semconv/v1.34.0` record measurements only once
when no attributes are provided. (#8849)
- Treat empty `OTEL_TRACES_SAMPLER` and `OTEL_TRACES_SAMPLER_ARG` values
as unset in `go.opentelemetry.io/otel/sdk/trace`. (#8873)
- Normalize global `OTEL_EXPORTER_OTLP_ENDPOINT` path joining in
`go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp` so
trailing-slash base URLs do not produce double-slash log export paths.
(#8864)
- Prevent a deadlock when formatting an error passed to `RecordError`
calls back into the span in `go.opentelemetry.io/otel/sdk/trace`.
(#8815)
- Prevent `SimpleSpanProcessor.Shutdown` from panicking when constructed
with a nil exporter in `go.opentelemetry.io/otel/sdk/trace`. (#8844)
- Propagate invalid exponential histogram scale errors to Prometheus
exporter self-observability metrics in
`go.opentelemetry.io/otel/exporters/prometheus`. (#8839)
- Retain instrument advisory attributes configured with
`go.opentelemetry.io/otel/metric/x.WithDefaultAttributes` when a
matching View in `go.opentelemetry.io/otel/sdk/metric` does not specify
an attribute filter. (#8859)
- Ignore HTTP URL paths when building OTLP/gRPC metric exporter targets
from `OTEL_EXPORTER_OTLP_ENDPOINT` and
`OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`, while preserving `unix://` and
`unix-abstract://` targets; treat `unix-abstract://` endpoints as
insecure in
`go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc` and
`go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp`.
(#8862)
- Ignore HTTP(S) paths when deriving gRPC trace exporter endpoints from
`OTEL_EXPORTER_OTLP_ENDPOINT` and `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`
in `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc`.
(#8852)
- Bound memory used while parsing dense W3C property metadata by storing
it compactly and materializing `Property` values on demand in
`go.opentelemetry.io/otel/baggage` and
`go.opentelemetry.io/otel/propagation`.

### Removed

- Remove the experimental `OTEL_GO_X_METRIC_EXPORT_BATCH_SIZE`
environment variable in `go.opentelemetry.io/otel/sdk/metric`.
  Use the `WithMaxExportBatchSize` option instead. (#8960)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants