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.

Sign up for GitHub

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

Fill out Summary metric details #2002

Merged
merged 4 commits into from
Oct 18, 2021
Merged

Fill out Summary metric details #2002

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bfce314
Fix TBD on gauge start time, and fill out details of Summary metric t…
jsuereth Oct 7, 2021
100382f
Apply suggestions from code review
jsuereth Oct 18, 2021
d2186c3
Merge branch 'main' into wip-fill-out-summary
jsuereth Oct 18, 2021
6c1c3f7
Update specification/metrics/datamodel.md
jmacd Oct 18, 2021
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
24 changes: 23 additions & 1 deletion specification/metrics/datamodel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,9 @@ in OTLP represents a sampled value at a given time. A Gauge stream consists of:
- An independent set of Attribute name-value pairs.
- A sampled value (e.g. current cpu temperature)
- A timestamp when the value was sampled (`time_unix_nano`)
- (optional) A timestamp (`start_time_unix_nano`) which has [TBD semantics](https://github.com/open-telemetry/opentelemetry-proto/pull/295).
- (optional) A timestamp (`start_time_unix_nano`) which best represents the
first possible moment a measurement could be recorded. This is commonly
set to the timestamp when a metric collection system started.
- (optional) a set of examplars (see [Exemplars](#exemplars)).

In OTLP, a point within a Gauge stream represents the last-sampled event for a
Expand Down Expand Up @@ -691,6 +693,26 @@ OpenTelemetry, Summary points cannot always be merged in a meaningful
way. This point type is not recommended for new applications and
exists for compatibility with other formats.

Summary consists of the following:

- A set of data points, each containing:
- An independent set of Attribute name-value pairs.
- A timestamp when the value was sampled (`time_unix_nano`)
- (optional) A timestamp (`start_time_unix_nano`) that denotes the start time
of observation collection for the summary.
- A count of the number of observations in the population of the data point.
- A sum of the values in the population.
- A set of quantile values (in strictly increasing order) consisting of:
- The quantile of a distribution, within the interval `[0.0, 1.0]`. For
jsuereth marked this conversation as resolved.
Show resolved Hide resolved
example, the value `0.9` would represent the 90th-percentile.
- The value of the quantile. This MUST be non-negative.

jsuereth marked this conversation as resolved.
Show resolved Hide resolved
jsuereth marked this conversation as resolved.
Show resolved Hide resolved
Quantile values 0.0 and 1.0 are defined to be equal to the minimum and maximum values, respectively.
jmacd marked this conversation as resolved.
Show resolved Hide resolved

Quantile values do not need to represent values observed between
`start_time_unix_nano` and `time_unix_nano` and are expected to be calculated
against recent time windows, typically the last 5-10 minutes.

## Exemplars

**Status**: [Stable](../document-status.md)
Expand Down