1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
{
"definitions": {
"monitored_instance": {
"type": "object",
"description": "Information about the monitored instance (metrics source).",
"properties": {
"name": {
"description": "Metrics source name (e.g. VerneMQ, Network interfaces, Files and directories). Use official spelling for applications.",
"type": "string"
},
"link": {
"description": "Link to the monitored instance official website if any.",
"type": "string"
},
"categories": {
"type": "array",
"description": "Category IDs that this integration falls into. Category IDs can be found at integrations/categories.yaml.",
"items": {
"$ref": "#/definitions/category"
}
},
"icon_filename": {
"type": "string",
"description": "The filename of the integration's icon, as sourced from https://github.com/netdata/website/tree/master/themes/tailwind/static/img."
}
},
"required": [
"name",
"link",
"categories",
"icon_filename"
]
},
"category": {
"type": "string",
"description": "String defining integration category"
},
"alerts": {
"type": "array",
"description": "The list of configured alerts shipped with Netdata for this collector.",
"items": {
"type": "object",
"description": "Information about the configured alert.",
"properties": {
"name": {
"type": "string",
"description": "Alert's 'alarm' or 'template' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-alarm-or-template)."
},
"link": {
"type": "string",
"description": "Link to github .conf file that this alert originates from"
},
"metric": {
"type": "string",
"description": "Alert's 'on' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-on)."
},
"info": {
"type": "string",
"description": "Alert's 'info' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-info)."
},
"os": {
"type": "string",
"description": "Alert's 'os' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-os)."
}
},
"required": [
"name",
"link",
"metric",
"info"
]
}
},
"metrics": {
"type": "object",
"description": "Collected metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.",
"properties": {
"folding": {
"$ref": "#/definitions/folding"
},
"description": {
"type": "string",
"description": "General description of collected metrics/scopes."
},
"availability": {
"type": "array",
"description": "Metrics collection availability conditions. Some metrics are only available when certain conditions are met. For example, Apache exposes additional metrics when Extended status is configured, Consul exposes different set of metrics depends on its mode. This field should list the available conditions that will later be matched for each of the metrics.",
"items": {
"type": "string",
"description": "Availability condition name."
}
},
"scopes": {
"type": "array",
"description": "List of scopes and their metrics.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Scope name."
},
"description": {
"type": "string",
"description": "Scope description."
},
"labels": {
"type": "array",
"description": "Label set of the scope.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Label name."
},
"description": {
"type": "string",
"description": "Label description."
}
},
"required": [
"name",
"description"
]
}
},
"metrics": {
"type": "array",
"description": "List of collected metrics (chart contexts) in the scope.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Metric name (chart context)."
},
"availability": {
"type": "array",
"description": "Metric collection availability conditions. An empty list means that it is available for all conditions defined in 'metrics.availability'.",
"items": {
"type": "string",
"description": "Availability condition name."
}
},
"description": {
"type": "string",
"description": "Metric description (chart title)."
},
"unit": {
"type": "string",
"description": "Metric description (chart unit)."
},
"chart_type": {
"type": "string",
"description": "Metric description (chart type)."
},
"dimensions": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Dimension name."
}
},
"required": [
"name"
]
}
}
},
"required": [
"name",
"description",
"unit",
"chart_type",
"dimensions"
]
}
}
},
"required": [
"name",
"description",
"labels",
"metrics"
]
}
}
},
"required": [
"folding",
"description",
"availability",
"scopes"
]
},
"folding": {
"type": "object",
"description": "Content folding settings.",
"properties": {
"title": {
"description": "Folded content summary title.",
"type": "string"
},
"enabled": {
"description": "Determines if this content should be folded.",
"type": "boolean"
}
},
"required": [
"title",
"enabled"
]
},
"folding_relaxed": {
"type": "object",
"description": "Content folding settings with optional title.",
"properties": {
"title": {
"description": "Folded content summary title.",
"type": "string"
},
"enabled": {
"description": "Determines if this content should be folded.",
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"non-empty-string": {
"type": "string",
"minLength": 2
}
}
}
|
