Skip to content

Commit

Permalink
[chore][mdatagen] Update schema with information on async telemetry m…
Browse files Browse the repository at this point in the history
…etrics (#10998)

#### Description
The `async` option was recently added to telemetry metrics, and I
believe this should be documented in the metadata schema. I've added a
short description about what it means, and its purpose.

#### Link to tracking issue
Resolves
#10990
  • Loading branch information
crobert-1 authored Aug 29, 2024
1 parent 047ce28 commit f641f23
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions cmd/mdatagen/metadata-schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,9 @@ telemetry:
unit:
# Required: metric type with its settings.
<sum|gauge|histogram>:
# Optional: Whether this metric is asynchronous. If async, a mechanism is required to be able to
# pass in options to the callbacks that are called when the metric is observed.
async: bool
# Required: type of number data point values.
value_type: <int|double>
# Required for sum metric: whether the metric is monotonic (no negative delta values).
Expand Down

0 comments on commit f641f23

Please sign in to comment.