Skip to content

Commit f641f23

Browse files
authored
[chore][mdatagen] Update schema with information on async telemetry metrics (#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
1 parent 047ce28 commit f641f23

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

cmd/mdatagen/metadata-schema.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,9 @@ telemetry:
158158
unit:
159159
# Required: metric type with its settings.
160160
<sum|gauge|histogram>:
161+
# Optional: Whether this metric is asynchronous. If async, a mechanism is required to be able to
162+
# pass in options to the callbacks that are called when the metric is observed.
163+
async: bool
161164
# Required: type of number data point values.
162165
value_type: <int|double>
163166
# Required for sum metric: whether the metric is monotonic (no negative delta values).

0 commit comments

Comments
 (0)