Skip to content

Commit

Permalink
Recommend a default size of 1 for the `SimpleFixedSizeExemplarReservo…
Browse files Browse the repository at this point in the history
…ir` (#3670)
  • Loading branch information
MrAlias authored Aug 24, 2023
1 parent d2f4c8e commit 59455fc
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ release.
([#3600](https://github.com/open-telemetry/opentelemetry-specification/pull/3600))
- Clarify that advice is non-identifying.
([#3661](https://github.com/open-telemetry/opentelemetry-specification/pull/3661))
- Define the default size of the `SimpleFixedSizeExemplarReservoir` to be `1`.
([#3670](https://github.com/open-telemetry/opentelemetry-specification/pull/3670))

### Logs

Expand Down
1 change: 1 addition & 0 deletions spec-compliance-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@ formats is required. Implementing more than one format is optional.
| The metrics SDK provides an `ExemplarReservoir` interface or extension point. | X | | - | | - | | | + | | | - | |
| An `ExemplarReservoir` has an `offer` method with access to the measurement value, attributes, `Context` and timestamp. | X | | - | | - | | | + | | | - | |
| The metrics SDK provides a `SimpleFixedSizeExemplarReservoir` that is used by default for all aggregations except `ExplicitBucketHistogram`. | | | + | | - | | | + | | | - | |
| The default size of the `SimpleFixedSizeExemplarReservoir` is `1`. | | | | | | | | | | | | |
| The metrics SDK provides an `AlignedHistogramBucketExemplarReservoir` that is used by default for `ExplicitBucketHistogram` aggregation. | | | + | | - | | | | | | - | |
| The metrics SDK provides an `ExemplarFilter` interface or extension point. | X | | - | | - | | | + | | | - | |
| An `ExemplarFilter` has access to the measurement value, attributes, `Context` and timestamp. | X | | - | | - | | | + | | | - | |
Expand Down
3 changes: 2 additions & 1 deletion specification/metrics/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -1033,7 +1033,8 @@ cycle. For the above example, that would mean that the `num_measurements_seen`
count is reset every time the reservoir is collected.

This Exemplar reservoir MAY take a configuration parameter for the size of the
reservoir pool.
reservoir pool. If no size configuration is provided, the default size of `1`
SHOULD be used.

#### AlignedHistogramBucketExemplarReservoir

Expand Down

0 comments on commit 59455fc

Please sign in to comment.