Skip to content

Prevent panic in FixedSizeReservoir for negative sizes - #8832

Merged
pellared merged 6 commits into
open-telemetry:mainfrom
chiliec:fix/fixed-size-reservoir-negative-size
Aug 28, 2026
Merged

pellared merged 6 commits into
open-telemetry:mainfrom
chiliec:fix/fixed-size-reservoir-negative-size

Conversation

@chiliec

@chiliec chiliec commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Fixes #8777.

Problem

exemplar.NewFixedSizeReservoir forwards its size argument directly to make([]measurement, k), which panics with makeslice: len out of range when k is negative:

exemplar.NewFixedSizeReservoir(-1) // panic: runtime error: makeslice: len out of range

FixedSizeReservoirProvider has the same behavior because it calls the constructor. The constructor cannot return an error, so an invalid size should be handled gracefully rather than bringing down the application.

Fix

Clamp negative sizes to zero, treating them as an empty reservoir. This is consistent with the existing behavior for a size of zero (the reservoir already short-circuits on len(storage) == 0 in both Offer and Collect), and it restores the negative-size guard that previously existed in #7447 before that change was reverted in #8249. Handling of size zero was added in #8295 (issue #8232); this extends the same treatment to negative sizes.

Tests

Added to sdk/metric/exemplar/fixed_size_reservoir_test.go:

  • TestNewFixedSizeReservoirNegativeSize โ€” asserts the constructor does not panic on -1, and that the resulting reservoir samples and collects nothing (behaves like size zero).
  • TestFixedSizeReservoirProviderNegativeSize โ€” asserts the provider path does not panic either.

Verified locally (REDโ†’GREEN): the new test panics on main, passes with the fix; the full ./exemplar package suite passes with no regressions; gofmt clean.

Added a CHANGELOG.md entry under Unreleased โ†’ Fixed.

NewFixedSizeReservoir forwards its size argument directly to
make([]measurement, k), which panics with "makeslice: len out of range"
when k is negative. FixedSizeReservoirProvider has the same behavior since
it calls the constructor.

The constructor cannot return an error, so an invalid size should be
handled without bringing down the application. Clamp negative sizes to
zero, treating them as an empty reservoir โ€” consistent with the existing
behavior for a size of zero (issue open-telemetry#8232 / open-telemetry#8295), and restoring the guard
that previously existed in open-telemetry#7447 before it was reverted in open-telemetry#8249.

Fixes open-telemetry#8777.

Signed-off-by: Vladimir Babin <vovababin@gmail.com>
@linux-foundation-easycla

linux-foundation-easycla Bot commented Aug 21, 2026 •

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

Signed-off-by: Vladimir Babin <vovababin@gmail.com>
@pellared

Copy link
Copy Markdown
Member

@dashpole, can you take a look please?

@codecov

codecov Bot commented Aug 21, 2026 •

Copy link
Copy Markdown

Codecov Report

โœ… All modified and coverable lines are covered by tests.
โœ… Project coverage is 88.4%. Comparing base (deedb7c) to head (3d88d4a).

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #8832   +/-   ##
=====================================
  Coverage   88.4%   88.4%           
=====================================
  Files        331     331           
  Lines      20999   21001    +2     
=====================================
+ Hits       18569   18571    +2     
  Misses      2430    2430           
Files with missing lines Coverage ฮ”
sdk/metric/exemplar/fixed_size_reservoir.go 100.0% <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.

dashpole and others added 3 commits August 27, 2026 10:28
The entry was under the released [1.46.0] section (1.46.0 was cut after
this PR branched), which trips the protect-released-changelog check.
Move it to [Unreleased] > Fixed where a still-unreleased change belongs.
@MrAlias

MrAlias commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

@chiliec please update the CHANGELOG to have your entry not in the last release.

@pellared
pellared merged commit 1ad6638 into open-telemetry:main Aug 28, 2026
50 checks passed
@pellared pellared added this to the v1.47.0 milestone Aug 28, 2026
@chiliec

chiliec commented Aug 29, 2026

Copy link
Copy Markdown
Contributor Author

@MrAlias done โ€” I've moved the entry out of the released [1.46.0] section up to [Unreleased] > Fixed. (The entry got stranded there when 1.46.0 was cut after this PR branched.) I also updated the branch with main. Let me know if you'd like anything else.

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.

NewFixedSizeReservoir panics for negative reservoir sizes

4 participants