Skip to content

Commit

Permalink
Clarify View/Exemplar and View/attribute-keys (#2059)
Browse files Browse the repository at this point in the history
* Clarify View/Exemplar and View/attribute-keys

* remove passive voice

* improve wording

* fix typo

Co-authored-by: Bogdan Drutu <bogdandrutu@gmail.com>
Co-authored-by: Josh Suereth <joshuasuereth@google.com>
  • Loading branch information
3 people authored Nov 8, 2021
1 parent 31937da commit 5418462
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions specification/metrics/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,10 @@ are the inputs:
stream](./datamodel.md#events--data-stream--timeseries):
* The `description`. If not provided, the Instrument `description` would be
used by default.
* A list of `attribute keys` (optional). If not provided, all the attribute
keys will be used by default (TODO: once the Hint API is available, the
default behavior should respect the Hint if it is available).
* A list of `attribute keys` (optional). If provided, the attributes that are
not in the list will be ignored. If not provided, all the attribute keys
will be used by default (TODO: once the Hint API is available, the default
behavior should respect the Hint if it is available).
* The `extra dimensions` which come from Baggage/Context (optional). If not
provided, no extra dimension will be used. Please note that this only
applies to [synchronous Instruments](./api.md#synchronous-instrument).
Expand Down Expand Up @@ -292,9 +293,9 @@ meterProviderBuilder
);
```

**TBD:**
The [View](./sdk.md#view) may configure an `Aggregation` to collect
[Exemplars](./datamodel.md#exemplars).
TODO: after we release the initial Stable version of Metrics SDK specification,
we will explore how to allow configuring custom
[ExemplarReservoir](#exemplarreservoir)s with the [View](#view) API.

The SDK MUST provide the following `Aggregation` to support the
[Metric Points](./datamodel.md#metric-points) in the
Expand Down

0 comments on commit 5418462

Please sign in to comment.