Skip to content

Commit 58e643b

Browse files
sincejunedmitryax
andauthored
[cmd/mdatagen] Add definition of events to metadata-schema.yaml (#13058)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Add definition of `events` to `metadata-schema.yaml` <!-- Issue number if applicable --> #### Link to tracking issue Part of #12571 <!--Describe what testing was performed and which tests were added.--> #### Testing n/a <!--Describe the documentation added.--> #### Documentation Added <!--Please delete paragraphs that you did not use before submitting.--> --------- Co-authored-by: Dmitry Anoshin <[email protected]>
1 parent 749f997 commit 58e643b

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

cmd/mdatagen/metadata-schema.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,28 @@ metrics:
117117
# Optional: array of attributes that were defined in the attributes section that are emitted by this metric.
118118
attributes: [string]
119119

120+
# Optional: map of event names with the key being the event name and value
121+
# being described below.
122+
events:
123+
<event.name>:
124+
# Required: whether the event is collected by default.
125+
enabled: bool
126+
# Required: event description.
127+
description:
128+
# Optional: extended documentation of the event.
129+
extended_documentation:
130+
# Optional: warnings that will be shown to user under specified conditions.
131+
warnings:
132+
# A warning that will be displayed if the event is enabled in user config.
133+
# Should be used for deprecated default events that will be removed soon.
134+
if_enabled:
135+
# A warning that will be displayed if `enabled` field is not set explicitly in user config.
136+
if_enabled_not_set:
137+
# A warning that will be displayed if the event is configured by user in any way.
138+
if_configured:
139+
# Optional: array of attributes that were defined in the attributes section that are emitted by this event.
140+
attributes: [string]
141+
120142
# Lifecycle tests generated for this component.
121143
tests:
122144
config: # {} by default, specific testing configuration for lifecycle tests.

0 commit comments

Comments
 (0)