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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Netdata agent collector metadata.",
"properties": {
"plugin_name": {
"type": "string"
},
"modules": {
"description": "A list of module templates",
"items": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"plugin_name": {
"type": "string",
"description": "Plugin name (e.g. apps.plugin, proc.plugin, go.d.plugin). It must match the name of the executable file in the plugins.d directory."
},
"module_name": {
"type": "string",
"description": "Module name (e.g. apache, /proc/stat, httpcheck). It usually has the same name as the module configuration file (external plugin) or the section name in netdata.conf (internal plugin)."
},
"monitored_instance": {
"$ref": "./shared.json#/$defs/instance"
},
"keywords": {
"$ref": "./shared.json#/$defs/keywords"
},
"related_resources": {
"type": "object",
"description": "Available related resources for the monitored instance.",
"properties": {
"integrations": {
"type": "object",
"description": "All collectors that provide additional metrics for the monitored instance. This may include generic collectors, e.g. 'httpcheck' for web servers to monitor specific endpoints.",
"properties": {
"list": {
"type": "array",
"description": "List of related integrations.",
"items": {
"type": "object",
"properties": {
"plugin_name": {
"type": "string",
"description": "Related integration plugin name."
},
"module_name": {
"type": "string",
"description": "Related integration module name."
}
},
"required": [
"plugin_name",
"module_name"
]
}
}
},
"required": [
"list"
]
}
},
"required": [
"integrations"
]
},
"info_provided_to_referring_integrations": {
"type": "object",
"description": "Information that this collector can provide about itself when other integrations mention it. This text will not be appear on this collector's page.",
"properties": {
"description": {
"type": "string",
"description": "TODO"
}
},
"required": [
"description"
]
},
"most_popular": {
"type": "boolean",
"description": "Whether or not the integration is to be flagged as most-popular, meaning it will show up at the top of the menu."
},
"community": {
"type": "boolean",
"description": "Whether or not the integration should be flagged as community."
}
},
"required": [
"plugin_name",
"module_name",
"monitored_instance",
"keywords",
"related_resources",
"info_provided_to_referring_integrations",
"most_popular"
]
},
"overview": {
"type": "object",
"properties": {
"data_collection": {
"type": "object",
"description": "An overview of the collected metrics and a detailed description of the data collection method.",
"properties": {
"metrics_description": {
"type": "string",
"description": "Brief description of what metrics are collected. A suggested approach here is to talk about the areas covered (e.g. health, performance, errors) and the metric scopes."
},
"method_description": {
"type": "string",
"description": "Description of how metrics are collected (e.g. HTTP requests, establish a TCP connection and send a command, a specific binary execution). A suggested approach here is to provide a detailed description of how the collector gathers metrics: how many connections are established, exact requests/commands executed, exact endpoints used."
}
},
"required": [
"metrics_description",
"method_description"
]
},
"supported_platforms": {
"type": "object",
"description": "Supported OS/platforms. By default, all platforms supported by Netdata are considered supported. See https://learn.netdata.cloud/docs/installing/platform-support-policy#currently-supported-platforms.",
"properties": {
"include": {
"type": "array",
"description": "Only supported OS/platforms. Platforms supported by Netdata will be ignored, only those listed are considered supported.",
"items": {
"type": "string",
"minLength": 2
}
},
"exclude": {
"type": "array",
"description": "Unsupported OS/platforms. The result set is all platforms supported by Netdata except for those excluded.",
"items": {
"type": "string",
"minLength": 2
}
}
},
"required": [
"include",
"exclude"
]
},
"multi_instance": {
"type": "boolean",
"description": "Whether this collector supports collecting metrics from multiple (for example, local and remote) instances."
},
"additional_permissions": {
"type": "object",
"description": "Information about additional permissions other than those required by the Netdata process (e.g. setuid, specific Linux capabilities).",
"properties": {
"description": {
"type": "string"
}
},
"required": [
"description"
]
},
"default_behavior": {
"type": "object",
"description": "Descriptions of how the data collector works with the default configuration.",
"properties": {
"auto_detection": {
"type": "object",
"description": "Information about detecting (discovering) monitored instances with default configuration. Example: tries to connect to Apache running on localhost on ports 80, 443 and 8080.",
"properties": {
"description": {
"type": "string"
}
},
"required": [
"description"
]
},
"limits": {
"type": "object",
"description": "Information about limiting data collection, taking into account the default values of any configuration settings that restrict data collection (including filtering metrics).",
"properties": {
"description": {
"type": "string"
}
},
"required": [
"description"
]
},
"performance_impact": {
"type": "object",
"description": "Information about the known impact on the performance of the monitored application or system.",
"properties": {
"description": {
"type": "string"
}
},
"required": [
"description"
]
}
},
"required": [
"auto_detection",
"limits",
"performance_impact"
]
}
},
"required": [
"data_collection",
"supported_platforms",
"multi_instance",
"additional_permissions",
"default_behavior"
]
},
"setup": {
"$ref": "./shared.json#/$defs/full_setup"
},
"troubleshooting": {
"$ref": "./shared.json#/$defs/troubleshooting"
},
"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": "./shared.json#/$defs/_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).",
"enum": [
"line",
"area",
"stacked"
]
},
"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"
]
}
},
"required": [
"meta",
"overview",
"setup",
"troubleshooting",
"alerts",
"metrics"
]
}
}
},
"required": [
"plugin_name",
"modules"
]
}
|
