From 7145a5d2ae302070033c2088a2416812edb7f878 Mon Sep 17 00:00:00 2001 From: jack-berg <34418638+jack-berg@users.noreply.github.com> Date: Wed, 20 Mar 2024 12:40:42 -0500 Subject: [PATCH] Clarify that exemplar reservoir default may change in a minor version (#3943) Related to #3756. See this [conversation](https://github.com/open-telemetry/opentelemetry-specification/pull/3870#discussion_r1483140692) for context. --------- Co-authored-by: Reiley Yang --- CHANGELOG.md | 3 +++ specification/metrics/sdk.md | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a19777790b..7b0fdbb46bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,9 @@ release. ### Metrics +- Clarify that exemplar reservoir default may change in a minor version. + ([#3943](https://github.com/open-telemetry/opentelemetry-specification/pull/3943)) + ### Logs - Refine description of Instrumentation Scope. diff --git a/specification/metrics/sdk.md b/specification/metrics/sdk.md index bb2381b608c..280c5ae8b4f 100644 --- a/specification/metrics/sdk.md +++ b/specification/metrics/sdk.md @@ -1052,6 +1052,11 @@ use `AlignedHistogramBucketExemplarReservoir`. twenty (e.g. `min(20, max_buckets)`). - All other aggregations will use `SimpleFixedSizeExemplarReservoir`. +Exemplar default reservoirs MAY change in +a [minor version bump](./../versioning-and-stability.md#minor-version-bump). No +guarantees are made on the shape or statistical properties of returned +exemplars. + #### SimpleFixedSizeExemplarReservoir This reservoir MUST use an uniformly-weighted sampling algorithm based on the