Add a schema for the categories.yaml file. (#15521)
Austin S. Hemmelgarn committed
Jul 25, 2023 at 13:10 UTC
f577a63ac044e8d4e038eaba526ad83bb5d16e79
2 files changed
+126
-2
integrations/categories.yaml
+73
-2
@@ -1,344 +1,415 @@
1
-- name: deploy
1
+- id: deploy
2
+ name: deploy
3
description: ""
4
most_popular: false
5
+ priority: -1
6
children:
7
- id: deploy.operating-systems
8
name: Operating Systems
9
description: ""
10
most_popular: false
11
+ priority: -1
12
children: []
13
- id: deploy.docker-kubernetes
14
name: Docker & Kubernetes
15
description: ""
16
most_popular: false
17
+ priority: -1
18
children: []
19
- id: deploy.provisioning-systems
20
parent: deploy
21
name: Provisioning Systems
22
description: ""
23
most_popular: false
24
+ priority: -1
25
children: []
21
-- name: data-collection
26
+- id: data-collection
27
+ name: data-collection
28
description: ""
29
most_popular: false
30
+ priority: -1
31
children:
32
- id: data-collection.other
33
name: Other
34
description: ""
35
most_popular: false
36
+ priority: -1
37
children: []
38
- id: data-collection.ebpf
39
name: eBPF
40
description: ""
41
most_popular: false
42
+ priority: -1
43
children: []
44
- id: data-collection.freebsd
45
name: FreeBSD
46
description: ""
47
most_popular: false
48
+ priority: -1
49
children: []
50
- id: data-collection.containers-and-vms
51
name: Containers and VMs
52
description: ""
53
most_popular: false
54
+ priority: -1
55
children: []
56
- id: data-collection.database-servers
57
name: Database Servers
58
description: ""
59
most_popular: false
60
+ priority: -1
61
children: []
62
- id: data-collection.kubernetes
63
name: Kubernetes
64
description: ""
65
most_popular: false
66
+ priority: -1
67
children: []
68
- id: data-collection.service-discovery-registry
69
name: Service Discovery / Registry
70
description: ""
71
most_popular: false
72
+ priority: -1
73
children: []
74
- id: data-collection.web-servers-and-web-proxies
75
name: Web Servers and Web Proxies
76
description: ""
77
most_popular: false
78
+ priority: -1
79
children: []
80
- id: data-collection.cloud-provider-managed
81
name: Cloud Provider Managed
82
description: ""
83
most_popular: false
84
+ priority: -1
85
children: []
86
- id: data-collection.windows-systems
87
name: Windows Systems
88
description: ""
89
most_popular: false
90
+ priority: -1
91
children: []
92
- id: data-collection.apm
93
name: APM
94
description: ""
95
most_popular: false
96
+ priority: -1
97
children: []
98
- id: data-collection.hardware-devices-and-sensors
99
name: Hardware Devices and Sensors
100
description: ""
101
most_popular: false
102
+ priority: -1
103
children: []
104
- id: data-collection.macos-systems
105
name: macOS Systems
106
description: ""
107
most_popular: false
108
+ priority: -1
109
children: []
110
- id: data-collection.message-brokers
111
name: Message Brokers
112
description: ""
113
most_popular: false
114
+ priority: -1
115
children: []
116
- id: data-collection.provisioning-systems
117
name: Provisioning Systems
118
description: ""
119
most_popular: false
120
+ priority: -1
121
children: []
122
- id: data-collection.search-engines
123
name: Search Engines
124
description: ""
125
most_popular: false
126
+ priority: -1
127
children: []
128
- id: data-collection.linux-systems
129
name: Linux Systems
130
description: ""
131
most_popular: false
132
+ priority: -1
133
children:
134
- id: data-collection.linux-systems.system-metrics
135
name: System Metrics
136
description: ""
137
most_popular: false
138
+ priority: -1
139
children: []
140
- id: data-collection.linux-systems.memory-metrics
141
name: Memory Metrics
142
description: ""
143
most_popular: false
144
+ priority: -1
145
children: []
146
- id: data-collection.linux-systems.cpu-metrics
147
name: CPU Metrics
148
description: ""
149
most_popular: false
150
+ priority: -1
151
children: []
152
- id: data-collection.linux-systems.pressure-metrics
153
name: Pressure Metrics
154
description: ""
155
most_popular: false
156
+ priority: -1
157
children: []
158
- id: data-collection.linux-systems.network-metrics
159
name: Network Metrics
160
description: ""
161
most_popular: false
162
+ priority: -1
163
children: []
164
- id: data-collection.linux-systems.ipc-metrics
165
name: IPC Metrics
166
description: ""
167
most_popular: false
168
+ priority: -1
169
children: []
170
- id: data-collection.linux-systems.disk-metrics
171
name: Disk Metrics
172
description: ""
173
most_popular: false
174
+ priority: -1
175
children: []
176
- id: data-collection.linux-systems.firewall-metrics
177
name: Firewall Metrics
178
description: ""
179
most_popular: false
180
+ priority: -1
181
children: []
182
- id: data-collection.linux-systems.power-supply-metrics
183
name: Power Supply Metrics
184
description: ""
185
most_popular: false
186
+ priority: -1
187
children: []
188
- id: data-collection.linux-systems.filesystem-metrics
189
name: Filesystem Metrics
190
description: ""
191
most_popular: false
192
+ priority: -1
193
children:
194
- id: data-collection.linux-systems.filesystem-metrics.zfs
195
name: ZFS
196
description: ""
197
most_popular: false
198
+ priority: -1
199
children: []
200
- id: data-collection.linux-systems.filesystem-metrics.btrfs
201
name: BTRFS
202
description: ""
203
most_popular: false
204
+ priority: -1
205
children: []
206
- id: data-collection.linux-systems.filesystem-metrics.nfs
207
name: NFS
208
description: ""
209
most_popular: false
210
+ priority: -1
211
children: []
212
- id: data-collection.linux-systems.kernel-metrics
213
name: Kernel Metrics
214
description: ""
215
most_popular: false
216
+ priority: -1
217
children: []
218
- id: data-collection.notifications
219
name: Notifications
220
description: ""
221
most_popular: false
222
+ priority: -1
223
children: []
224
- id: data-collection.networking-stack-and-network-interfaces
225
name: Networking Stack and Network Interfaces
226
description: ""
227
most_popular: false
228
+ priority: -1
229
children: []
230
- id: data-collection.synthetic-checks
231
name: Synthetic Checks
232
description: ""
233
most_popular: false
234
+ priority: -1
235
children: []
236
- id: data-collection.ci-cd-systems
237
name: CI/CD Systems
238
description: ""
239
most_popular: false
240
+ priority: -1
241
children: []
242
- id: data-collection.ups
243
name: UPS
244
description: ""
245
most_popular: false
246
+ priority: -1
247
children: []
248
- id: data-collection.freebsd-systems
249
name: FreeBSD Systems
250
description: ""
251
most_popular: false
252
+ priority: -1
253
children: []
254
- id: data-collection.logs-servers
255
name: Logs Servers
256
description: ""
257
most_popular: false
258
+ priority: -1
259
children: []
260
- id: data-collection.security-systems
261
name: Security Systems
262
description: ""
263
most_popular: false
264
+ priority: -1
265
children: []
266
- id: data-collection.observability
267
name: Observability
268
description: ""
269
most_popular: false
270
+ priority: -1
271
children: []
272
- id: data-collection.gaming
273
name: Gaming
274
description: ""
275
most_popular: false
276
+ priority: -1
277
children: []
278
- id: data-collection.iot-devices
279
name: IoT Devices
280
description: ""
281
most_popular: false
282
+ priority: -1
283
children: []
284
- id: data-collection.media-streaming-servers
285
name: Media Streaming Servers
286
description: ""
287
most_popular: false
288
+ priority: -1
289
children: []
290
- id: data-collection.authentication-and-authorization
291
name: Authentication and Authorization
292
description: ""
293
most_popular: false
294
+ priority: -1
295
children: []
296
- id: data-collection.project-management
297
name: Project Management
298
description: ""
299
most_popular: false
300
+ priority: -1
301
children: []
302
- id: data-collection.application-servers
303
name: Application Servers
304
description: ""
305
most_popular: false
306
+ priority: -1
307
children: []
308
- id: data-collection.export
309
name: Export
310
description: ""
311
most_popular: false
312
+ priority: -1
313
children: []
314
- id: data-collection.dns-and-dhcp-servers
315
name: DNS and DHCP Servers
316
description: ""
317
most_popular: false
318
+ priority: -1
319
children: []
320
- id: data-collection.mail-servers
321
name: Mail Servers
322
description: ""
323
most_popular: false
324
+ priority: -1
325
children: []
326
- id: data-collection.processes-and-system-services
327
name: Processes and System Services
328
description: ""
329
most_popular: false
330
+ priority: -1
331
children: []
332
- id: data-collection.storage-mount-points-and-filesystems
333
name: Storage, Mount Points and Filesystems
334
description: ""
335
most_popular: false
336
+ priority: -1
337
children: []
338
- id: data-collection.systemd
339
name: Systemd
340
description: ""
341
most_popular: false
342
+ priority: -1
343
children: []
344
- id: data-collection.telephony-servers
345
name: Telephony Servers
346
description: ""
347
most_popular: false
348
+ priority: -1
349
children: []
350
- id: data-collection.vpns
351
name: VPNs
352
description: ""
353
most_popular: false
354
+ priority: -1
355
children: []
356
- id: data-collection.blockchain-servers
357
name: Blockchain Servers
358
description: ""
359
most_popular: false
360
+ priority: -1
361
children: []
362
- id: data-collection.distributed-computing-systems
363
name: Distributed Computing Systems
364
description: ""
365
most_popular: false
366
+ priority: -1
367
children: []
368
- id: data-collection.generic-data-collection
369
name: Generic Data Collection
370
description: ""
371
most_popular: false
372
+ priority: -1
373
children: []
374
- id: data-collection.p2p
375
name: P2P
376
description: ""
377
most_popular: false
378
+ priority: -1
379
children: []
380
- id: data-collection.snmp-and-networked-devices
381
name: SNMP and Networked Devices
382
description: ""
383
most_popular: false
384
+ priority: -1
385
children: []
386
- id: data-collection.system-clock-and-ntp
387
name: System Clock and NTP
388
description: ""
389
most_popular: false
390
+ priority: -1
391
children: []
392
- id: data-collection.nas
393
name: NAS
394
description: ""
395
most_popular: false
396
+ priority: -1
397
children: []
398
- id: data-collection.api-gateways
399
name: API Gateways
400
description: ""
401
most_popular: false
402
+ priority: -1
403
children: []
404
- id: data-collection.task-queues
405
name: Task Queues
406
description: ""
407
most_popular: false
408
+ priority: -1
409
children: []
410
- id: data-collection.ftp-servers
411
name: FTP Servers
412
description: ""
413
most_popular: false
414
+ priority: -1
415
children: []
integrations/schemas/categories.json
new
+53
@@ -0,0 +1,53 @@
1
+{
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "array",
4
+ "title": "Category information for integrations.",
5
+ "items": {
6
+ "$ref": "#/$defs/category"
7
+ },
8
+ "$defs": {
9
+ "category": {
10
+ "type": "object",
11
+ "description": "An entry for a single category.",
12
+ "properties": {
13
+ "id": {
14
+ "type": "string",
15
+ "minLength": 1,
16
+ "description": "A unique ID for the category. Recommended format is a dot-separated list of categories that are parents of this category, followed by a unique value for this category. Must be URL safe."
17
+ },
18
+ "name": {
19
+ "type": "string",
20
+ "minLength": 1,
21
+ "description": "The display name for the category."
22
+ },
23
+ "description": {
24
+ "type": "string",
25
+ "description": "A description of the category."
26
+ },
27
+ "most_popular": {
28
+ "type": "boolean",
29
+ "description": "Indicates if the category should show up in the initial list of categories, or only in the full expanded list."
30
+ },
31
+ "priority": {
32
+ "type": "integer",
33
+ "description": "Indicates sort order for categories that are marked as most popular."
34
+ },
35
+ "children": {
36
+ "type": "array",
37
+ "description": "A list of categories that are children of this category.",
38
+ "items": {
39
+ "$ref": "#/$defs/category"
40
+ }
41
+ }
42
+ },
43
+ "required": [
44
+ "id",
45
+ "name",
46
+ "description",
47
+ "most_popular",
48
+ "priority",
49
+ "children"
50
+ ]
51
+ }
52
+ }
53
+}