Skip to content

Commit

Permalink
Incorporate histogram min and max fields into histogram language, add… (
Browse files Browse the repository at this point in the history
#1983)

* Incorporate histogram min and max fields into histogram language, add zero bucket histogram aggregation

* Change default aggregation temporality to Delta

* Rename zero bucket histogram to degenerate histogram

* Remove monotonic parameter from histgoram aggregation, rename degenerate histogram to trivial histogram

* Adjust language on exemplar resevoir selection

* Fix type in anchor

* Remove extra line

* Remove trivial histogram aggregation

* Add RecordMinMax to Explicit Bucket Histogram

Co-authored-by: Reiley Yang <reyang@microsoft.com>
Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>
  • Loading branch information
3 people authored Oct 21, 2021
1 parent 401bb9c commit f3fe34c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ release.
### Metrics

- Add optional min / max fields to histogram data model.
([#1915](https://github.com/open-telemetry/opentelemetry-specification/pull/1915))
([#1915](https://github.com/open-telemetry/opentelemetry-specification/pull/1915),
[#1983](https://github.com/open-telemetry/opentelemetry-specification/pull/1983))
- Add exponential histogram to the metrics data model.
([#1935](https://github.com/open-telemetry/opentelemetry-specification/pull/1935))
- Add clarifications on how to handle numerical limits.
Expand Down
9 changes: 6 additions & 3 deletions specification/metrics/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,7 @@ This Aggregation honors the following configuration parameters:
| --- | --- | --- | --- |
| Temporality | Delta, Cumulative | Cumulative | See [Temporality](./datamodel.md#temporality). |
| Boundaries | double\[\] | [ 0, 5, 10, 25, 50, 75, 100, 250, 500, 1000 ] | Array of increasing values representing explicit bucket boundary values.<br><br>The Default Value represents the following buckets:<br>(-&infin;, 0], (0, 5.0], (5.0, 10.0], (10.0, 25.0], (25.0, 50.0], (50.0, 75.0], (75.0, 100.0], (100.0, 250.0], (250.0, 500.0], (500.0, 1000.0], (1000.0, +&infin;) |
| RecordMinMax | true, false | true | Whether to record min and max. |

Note: This aggregator should not fill out `sum` when used with instruments
that record negative measurements, e.g. `UpDownCounter` or `ObservableGauge`.
Expand All @@ -393,6 +394,8 @@ This Aggregation informs the SDK to collect:

- Count of `Measurement` values falling within explicit bucket boundaries.
- Arithmetic sum of `Measurement` values in population.
- Min (optional) `Measurement` value in population.
- Max (optional) `Measurement` value in population.

## Attribute limits

Expand Down Expand Up @@ -485,9 +488,9 @@ The SDK will come with two types of built-in exemplar reservoirs:
1. SimpleFixedSizeExemplarReservoir
2. AlignedHistogramBucketExemplarReservoir

By default, fixed sized histogram aggregators will use
`AlignedHistogramBucketExemplarReservoir` and all other aggregaators will use
`SimpleFixedSizeExemplarReservoir`.
By default, explicit bucket histogram aggregators with more than 1 bucket will
use `AlignedHistogramBucketExemplarReservoir`. All other aggregators will
use `SimpleFixedSizeExemplarReservoir`.

*SimpleExemplarReservoir*
This Exemplar reservoir MAY take a configuration parameter for the size of
Expand Down

0 comments on commit f3fe34c

Please sign in to comment.