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

Jump to bottom

Metrics SDK fixes #1917

Merged
merged 6 commits into from
Sep 16, 2021
Merged

Metrics SDK fixes #1917

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1e11e07
update diagram wording
reyang Sep 10, 2021
ad6d892
update toc
reyang Sep 10, 2021
26fcd44
better consistency
reyang Sep 10, 2021
a202d84
Merge branch 'main' into reyang/metrics-sdk-fixes
reyang Sep 14, 2021
e13fbe3
Merge branch 'main' into reyang/metrics-sdk-fixes
jmacd Sep 14, 2021
2f800cf
Merge branch 'main' into reyang/metrics-sdk-fixes
bogdandrutu Sep 16, 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
13 changes: 9 additions & 4 deletions specification/metrics/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,16 @@ Table of Contents
* [MeterProvider](#meterprovider)
* [Attribute Limits](#attribute-limits)
* [MeasurementProcessor](#measurementprocessor)
* [Exemplar](#exemplar)
* [ExemplarFilter](#exemplarfilter)
* [ExemplarReservoir](#exemplarreservoir)
* [Exemplar Defaults](#exemplar-defaults)
* [MetricReader](#metricreader)
* [Periodic exporting MetricReader](#periodic-exporting-metricreader)
* [MetricExporter](#metricexporter)
* [Push Metric Exporter](#push-metric-exporter)
* [Pull Metric Exporter](#pull-metric-exporter)
* [Defaults and Configuration](#defaults-and-configuration)

</details>

Expand Down Expand Up @@ -437,7 +442,7 @@ active span](../trace/api.md#context-interaction)).
+------------------+
```

## Exemplars
## Exemplar

An [Exemplar](./datamodel.md#exemplars) is a recorded measurement that exposes
the following pieces of information:
Expand All @@ -461,7 +466,7 @@ A Metric SDK SHOULD provide extensible hooks for Exemplar sampling, specifically
- `ExemplarFilter`: filter which measurements can become exemplars
- `ExemplarReservoir`: determine how to store exemplars.

### Exemplar Filter
### ExemplarFilter
jmacd marked this conversation as resolved.
Show resolved Hide resolved

The `ExemplarFilter` interface MUST provide a method to determine if a
measurement should be sampled.
Expand All @@ -476,7 +481,7 @@ This interface SHOULD have access to:
See [Defaults and Configuration](#defaults-and-configuration) for built-in
filters.

### Exemplar Reservoir
### ExemplarReservoir

The `ExemplarReservoir` interface MUST provide a method to offer measurements
to the reservoir and another to collect accumulated Exemplars.
Expand Down Expand Up @@ -768,7 +773,7 @@ modeled to interact with other components in the SDK:
```text
+-----------------+ +-----------------------------+
| | Metrics... | |
| In-memory state +------------> Base exporting MetricReader |
| In-memory state +------------> Exporting MetricReader |
| | | |
+-----------------+ | +-----------------------+ |
| | | |
Expand Down