Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorporate histogram min and max fields into histogram language, add… #1983

Merged
merged 15 commits into from
Oct 21, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions specification/metrics/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ The SDK MUST provide the following `Aggregation` to support the
- [Last Value](./sdk.md#last-value-aggregation)
- [Histogram](./sdk.md#histogram-aggregation)
- [Explicit Bucket Histogram](./sdk.md#explicit-bucket-histogram-aggregation)
- [Zero Bucket Histogram](./sdk.md#zero-bucket-histogram-aggregation)

#### None Aggregation

Expand Down Expand Up @@ -388,12 +389,33 @@ 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;) |

\[1\]: Language implementations may choose the best strategy for handling errors. (i.e. Log, Discard, etc...)

This Aggregation informs the SDK to collect:

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

#### Zero Bucket Histogram Aggregation

The Zero Bucket Aggregation informs the SDK to collect data for
the [Histogram Metric Point](./datamodel.md#histogram) using zero buckets. This
produces lightweight histogram data points which capture the min, max, sum, and
count of a population of measurements.

| Key | Value | Default Value | Description |
| --- | --- | --- | --- |
| Monotonic | boolean | true | if true, non-positive values are treated as errors<sup>1</sup>. |
| Temporality | Delta, Cumulative | Cumulative | See [Temporality](./datamodel.md#temporality). |

This Aggregation informs the SDK to collect:

- Count of `Measurement` values in population
- Arithmetic sum of `Measurement` values in population.
- Min `Measurement` value in population.
- Max `Measurement` value in population.

\[1\]: Language implementations may choose the best strategy for handling errors. (i.e. Log, Discard, etc...)

## Attribute limits

Expand Down