Skip to content

sdk/trace: apply AttributeValueLengthLimit to attribute.MAP - #8454

Merged
pellared merged 7 commits into
open-telemetry:mainfrom
pellared:map-limits
Jun 16, 2026
Merged

pellared merged 7 commits into
open-telemetry:mainfrom
pellared:map-limits

Conversation

@pellared

@pellared pellared commented Jun 12, 2026

Copy link
Copy Markdown
Member

Fixes #7956

Per the OTel spec, attribute value limits must be applied recursively to map values. Previously truncateAttr handled STRING, STRINGSLICE, BYTESLICE, and SLICE, but not MAP.

Add MAP handling to the trace SDK attribute limiter:

  • truncateAttr: truncates attribute.MAP values when needed.
  • truncateValue: recursively truncates MAP, SLICE, STRINGSLICE, STRING, and BYTESLICE values.
  • needsTruncation: pre-scan guard for MAP values to avoid rebuilding when no nested value changes.

benchstat for BenchmarkSpanLimits/AttributeValueLengthLimit (count=10):

SpanLimits/AttributeValueLengthLimit-20   14.88µ ± 16%   15.56µ ± 53%       ~ (p=0.739 n=10)
SpanLimits/AttributeValueLengthLimit-20   12.71Ki ± 0%   13.66Ki ± 0%   +7.52% (p=0.000 n=10)
SpanLimits/AttributeValueLengthLimit-20    47.00 ± 0%     56.00 ± 0%   +19.15% (p=0.000 n=10)

The extra allocations are expected in the truncation path because truncated MAP values are rebuilt recursively.

benchstat for BenchmarkSpanLimits/AttributeValueLengthLimit (count=10):

SpanLimits/None-20   14.18µ ± 7%   12.86µ ± 18%   -9.31% (p=0.043 n=10)
SpanLimits/None-20   12.16Ki ± 0%  12.16Ki ± 0%       ~ (p=1.000 n=10)
SpanLimits/None-20   38.00 ± 0%    38.00 ± 0%          ~ (p=1.000 n

No extra allocations where nothing needs to be rebuild.

@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 90.90909% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.5%. Comparing base (6e2b921) to head (80f1b72).

Files with missing lines Patch % Lines
sdk/trace/span.go 90.9% 1 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #8454   +/-   ##
=====================================
  Coverage   83.4%   83.5%           
=====================================
  Files        322     322           
  Lines      25645   25667   +22     
=====================================
+ Hits       21410   21434   +24     
+ Misses      3853    3852    -1     
+ Partials     382     381    -1     
Files with missing lines Coverage Δ
sdk/trace/span_limits.go 100.0% <ø> (ø)
sdk/trace/span.go 87.4% <90.9%> (+0.1%) ⬆️

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

@pellared
pellared requested a review from Copilot June 12, 2026 10:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the trace SDK’s attribute value truncation logic to comply with the OpenTelemetry spec requirement that attribute value length limits be applied recursively to attribute.MAP values (and nested values within maps).

Changes:

  • Extend truncateAttr, truncateValue, and needsTruncation in sdk/trace/span.go to recursively truncate attribute.MAP values while avoiding rebuilds when no nested value changes.
  • Add unit tests covering truncation behavior for MAP values, including nested MAP/SLICE combinations and UTF-8 edge cases.
  • Update SpanLimits documentation, benchmarks, and the changelog to reflect MAP support.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
sdk/trace/span.go Adds recursive truncation and pre-scan guard logic for attribute.MAP values.
sdk/trace/span_test.go Adds comprehensive test cases validating MAP truncation behavior (including nested structures).
sdk/trace/span_limits.go Updates AttributeValueLengthLimit documentation to include MAP semantics.
sdk/trace/benchmark_test.go Includes MAP attributes in the SpanLimits benchmarks to exercise the new truncation path.
CHANGELOG.md Documents recursive AttributeValueLengthLimit application for attribute.MAP in the trace SDK.

@pellared
pellared marked this pull request as ready for review June 12, 2026 10:27
@pellared pellared added this to the v1.45.0 milestone Jun 12, 2026
@pellared
pellared merged commit e708781 into open-telemetry:main Jun 16, 2026
34 checks passed
NesterovYehor pushed a commit to NesterovYehor/opentelemetry-go that referenced this pull request Jul 15, 2026
…emetry#8454)

Fixes open-telemetry#7956

Per the OTel spec, attribute value limits must be applied recursively to
map values. Previously `truncateAttr` handled `STRING`, `STRINGSLICE`,
`BYTESLICE`, and `SLICE`, but not `MAP`.

Add `MAP` handling to the trace SDK attribute limiter:
- `truncateAttr`: truncates `attribute.MAP` values when needed.
- `truncateValue`: recursively truncates `MAP`, `SLICE`, `STRINGSLICE`,
`STRING`, and `BYTESLICE` values.
- `needsTruncation`: pre-scan guard for `MAP` values to avoid rebuilding
when no nested value changes.


`benchstat` for `BenchmarkSpanLimits/AttributeValueLengthLimit`
(`count=10`):

```
SpanLimits/AttributeValueLengthLimit-20   14.88µ ± 16%   15.56µ ± 53%       ~ (p=0.739 n=10)
SpanLimits/AttributeValueLengthLimit-20   12.71Ki ± 0%   13.66Ki ± 0%   +7.52% (p=0.000 n=10)
SpanLimits/AttributeValueLengthLimit-20    47.00 ± 0%     56.00 ± 0%   +19.15% (p=0.000 n=10)
```

The extra allocations are expected in the truncation path because
truncated `MAP` values are rebuilt recursively.

`benchstat` for `BenchmarkSpanLimits/AttributeValueLengthLimit`
(`count=10`):

```
SpanLimits/None-20   14.18µ ± 7%   12.86µ ± 18%   -9.31% (p=0.043 n=10)
SpanLimits/None-20   12.16Ki ± 0%  12.16Ki ± 0%       ~ (p=1.000 n=10)
SpanLimits/None-20   38.00 ± 0%    38.00 ± 0%          ~ (p=1.000 n
```

No extra allocations where nothing needs to be rebuild.
@MrAlias MrAlias mentioned this pull request Aug 3, 2026
MrAlias added a commit that referenced this pull request Aug 3, 2026
### Added

- Add experimental observability metrics to `BatchProcessor` in
`go.opentelemetry.io/otel/sdk/log`. (#7124)
- Add the experimental `WithUnsafeAttributes` no-copy attribute option
to `go.opentelemetry.io/otel/metric/x` for future performance
improvements. This API is a work in progress. (#8251)
- Add `Map` and `MapValue` functions for the new `MAP` attribute type in
`go.opentelemetry.io/otel/attribute`. (#8445)
- Support `MAP` attributes in
`go.opentelemetry.io/otel/exporters/otlp/otlptrace`. (#8453)
- Support `MAP` attributes in
`go.opentelemetry.io/otel/exporters/otlp/otlplog`. (#8453)
- Support `MAP` attributes in
`go.opentelemetry.io/otel/exporters/otlp/otlpmetric`. (#8453)
- Support `MAP` attributes in
`go.opentelemetry.io/otel/exporters/zipkin`. (#8453)
- Apply `AttributeValueLengthLimit` recursively to values contained in
`attribute.MAP` attributes in `go.opentelemetry.io/otel/sdk/trace`.
(#8454)
- Remove duplicate keys from `attribute.MAP` values in
`go.opentelemetry.io/otel/sdk/resource` using last-value-wins semantics.
(#8471)
- Remove duplicate keys by default from `attribute.MAP` values in
instrumentation scope attributes in `go.opentelemetry.io/otel/sdk/log`
using last-value-wins semantics. (#8471)
- Remove duplicate keys by default from `attribute.MAP` values in span,
event, link, and instrumentation scope attributes in
`go.opentelemetry.io/otel/sdk/trace` using last-value-wins semantics.
(#8471)
- Remove duplicate keys by default from `attribute.MAP` values in
measurement and instrumentation scope attributes in
`go.opentelemetry.io/otel/sdk/metric` using last-value-wins semantics.
(#8471)
- Extend `WithAllowKeyDuplication` in `go.opentelemetry.io/otel/sdk/log`
to disable duplicate-key removal in `attribute.MAP` values for
instrumentation scope attributes. (#8471)
- Add the `go.opentelemetry.io/otel/semconv/v1.42.0` package.
The package contains semantic conventions from the `v1.42.0` version of
the OpenTelemetry Semantic Conventions.
See the [migration documentation](./semconv/v1.42.0/MIGRATION.md) for
information on how to upgrade from
`go.opentelemetry.io/otel/semconv/v1.41.0`. (#8484)
- Add `WithoutPanicRecording` as a `TracerProviderOption` in
`go.opentelemetry.io/otel/sdk/trace` to disable exception event
recording for panics. (#8532)
- Add the `go.opentelemetry.io/otel/semconv/v1.43.0` package.
The package contains semantic conventions from the `v1.43.0` version of
the OpenTelemetry Semantic Conventions.
See the [migration documentation](./semconv/v1.43.0/MIGRATION.md) for
information on how to upgrade from
`go.opentelemetry.io/otel/semconv/v1.42.0`. (#8628)

### Changed

- `HistogramReservoir` in `go.opentelemetry.io/otel/sdk/metric/exemplar`
now uses a time-unbiased sampling algorithm for exemplars. (#8306)
- ⚠️ **Breaking Change:** Use `go.opentelemetry.io/otel/attribute.Value`
and `go.opentelemetry.io/otel/attribute.KeyValue` for log bodies and
attributes in `go.opentelemetry.io/otel/log`,
`go.opentelemetry.io/otel/log/logtest`,
`go.opentelemetry.io/otel/sdk/log`, and
`go.opentelemetry.io/otel/sdk/log/logtest`. (#8490)
- Encode log bodies and attributes as
`go.opentelemetry.io/otel/attribute.Value` JSON in
`go.opentelemetry.io/otel/exporters/stdout/stdoutlog`. (#8490)
- Improve the performance of hashing `BOOLSLICE`, `INT64SLICE`,
`FLOAT64SLICE`, and `STRINGSLICE` attribute values by avoiding
reflection for short slices in `go.opentelemetry.io/otel/attribute`.
(#8511)
- ⚠️ **Breaking Change:** `WithEndpointURL` in
`go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp` no
longer appends the default signal path when an endpoint URL has no path,
making the behavior consistent with
`go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp` and with
setting the endpoint through `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`. If
the URL has no path component, the root path (`/`) is used. Use
`WithEndpointURL(url.JoinPath(endpoint, "/v1/metrics"))` to preserve the
previous behavior. (#8538)
- ⚠️ **Breaking Change:** `WithEndpointURL` in
`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp` no
longer appends the default signal path when an endpoint URL has no path,
making the behavior consistent with
`go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp` and with
setting the endpoint through `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`. If
the URL has no path component, the root path (`/`) is used. Use
`WithEndpointURL(url.JoinPath(endpoint, "/v1/traces"))` to preserve the
previous behavior. (#8538)

### Deprecated

- Deprecate `WithExportBufferSize` in
`go.opentelemetry.io/otel/sdk/log`. The option remains available for
source compatibility but no longer affects behavior; `BatchProcessor` no
longer maintains a separate export-request buffer. (#8620)

### Removed

- ⚠️ **Breaking Change:** Remove `Kind`, `Value`, `KeyValue`, their
constructors, and attribute conversion helpers from
`go.opentelemetry.io/otel/log`. (#8490)
- ⚠️ **Breaking Change:** Remove the `AttributeValueLengthLimit` and
`AttributeCountLimit` fields from `RecordFactory` in
`go.opentelemetry.io/otel/sdk/log/logtest`; records produced by the
factory now keep attribute limits disabled so test code can append exact
attributes. (#8556)

### Fixed

- Fix an off-by-one error in `FixedSizeReservoir` in
`go.opentelemetry.io/otel/sdk/metric/exemplar` that prevented the first
exemplar from being sampled after the reservoir was filled. (#8309)
- Interpret HTTP `Retry-After` header values as seconds instead of
nanoseconds when retrying OTLP HTTP exports in
`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`. (#8383)
- Fix a memory leak in the `Reservoir` implementation in
`go.opentelemetry.io/otel/sdk/metric/exemplar`, where storing the full
`context.Context` pinned large objects such as gRPC transport buffers.
(#8389)
- Prevent a non-empty attribute set whose computed hash is zero from
collapsing to an empty set in `go.opentelemetry.io/otel/attribute`.
(#8402)
- Fix histogram data point reuse in
`go.opentelemetry.io/otel/sdk/metric` aggregation to avoid leaking stale
sum, minimum, and maximum values when they are disabled in subsequent
collections. (#8403)
- Avoid preallocating scope attributes when they are disabled in
`go.opentelemetry.io/otel/exporters/prometheus`. (#8404)
- Support HTTP-date values in the HTTP `Retry-After` header when
retrying OTLP HTTP exports in
`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`. (#8417)
- Reduce histogram heap allocations by reusing `BucketCounts` and
`Exemplars` slices across `Collect` cycles in the cumulative histogram
aggregation in `go.opentelemetry.io/otel/sdk/metric`. (#8428)
- Fix `go.opentelemetry.io/otel/exporters/stdout/stdouttrace`
self-observability to record `error.type` on the operation-duration
histogram when the `exportedSpans` metric is disabled. (#8432)
- Stop including trace exporter endpoint configuration in internal logs
from `go.opentelemetry.io/otel/sdk/trace`,
`go.opentelemetry.io/otel/exporters/otlp/otlptrace`,
`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc`,
`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`, and
`go.opentelemetry.io/otel/exporters/zipkin`. (#8438)
- Fix invalid error formatting for out-of-range JSON code values in
`go.opentelemetry.io/otel/codes`. (#8497)
- Clarify in `go.opentelemetry.io/otel/log` that `Logger.Enabled` should
be checked for every log emission because its result may change over
time. (#8565)
- Preserve user-provided exception attributes while independently
deriving missing exception message and type attributes in
`go.opentelemetry.io/otel/sdk/log`. (#8566)
- Make `WithAttributeCountLimit(0)` and
`OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT=0` discard all log record
attributes in `go.opentelemetry.io/otel/sdk/log`. (#8570)
- Clarify that the `Record` methods of `Float64Histogram` and
`Int64Histogram` in `go.opentelemetry.io/otel/metric` expect
non-negative values. (#8574)
- Clarify in `go.opentelemetry.io/otel/log` that `LoggerProvider`
implementations should retain an empty `Logger` name instead of
replacing it with a default. (#8587)
- Ensure that the built-in processors in
`go.opentelemetry.io/otel/sdk/log` call exporter `ForceFlush` during
`Shutdown`. (#8599)
- Prevent panics in `go.opentelemetry.io/otel/bridge/opentracing` when
OpenTracing baggage is propagated concurrently with
`Span.SetBaggageItem`.
([GHSA-42cj-99w8-cp2p](GHSA-42cj-99w8-cp2p))
- Prevent processor operations in `go.opentelemetry.io/otel/sdk/log`
from overlapping with processor shutdown or running after
`LoggerProvider` shutdown. (#8608)
- Prevent `BatchProcessor` in `go.opentelemetry.io/otel/sdk/log` from
busy-spinning under exporter backpressure and serialize dequeue, export,
force-flush, and shutdown work in one worker. (#8620)
- Make `BatchProcessor` in `go.opentelemetry.io/otel/sdk/log` return
errors encountered while draining records during `ForceFlush` and
`Shutdown`, while continuing to attempt later batches as long as the
request context remains valid. (#8620)
- Keep the default `BatchProcessor` maximum export batch size in
`go.opentelemetry.io/otel/sdk/log` at or below the configured maximum
queue size. (#8620)
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.

sdk: Apply attribute value limit for MAP

4 participants