master
yaml 713 lines 22.1 KB
Raw
1 plugin_name: apps.plugin
2 modules:
3 # removed system.processes_state
4 - meta:
5 plugin_name: apps.plugin
6 module_name: apps
7 monitored_instance:
8 name: Applications
9 link: ""
10 categories:
11 - data-collection.operating-systems
12 icon_filename: "applications.svg"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - applications
20 - processes
21 - os
22 - host monitoring
23 overview:
24 data_collection:
25 metrics_description: "Monitor Applications for optimal software performance and resource usage."
26 method_description: ""
27 supported_platforms:
28 include: []
29 exclude: []
30 multi_instance: true
31 additional_permissions:
32 description: ""
33 default_behavior:
34 auto_detection:
35 description: ""
36 limits:
37 description: ""
38 performance_impact:
39 description: ""
40 setup:
41 prerequisites:
42 list: []
43 configuration:
44 file:
45 name: ""
46 description: ""
47 options:
48 description: ""
49 folding:
50 title: ""
51 enabled: true
52 list: []
53 examples:
54 folding:
55 enabled: true
56 title: ""
57 list: []
58 troubleshooting:
59 problems:
60 list: []
61 alerts: []
62 metrics:
63 folding:
64 title: Metrics
65 enabled: false
66 description: ""
67 availability: []
68 scopes:
69 - name: applications group
70 description: These metrics refer to the application group.
71 labels:
72 - name: app_group
73 description: The name of the group defined in the configuration.
74 metrics:
75 - name: app.cpu_utilization
76 description: Apps CPU utilization (100% = 1 core)
77 unit: percentage
78 chart_type: stacked
79 dimensions:
80 - name: user
81 - name: system
82 - name: app.cpu_guest_utilization
83 description: Apps CPU guest utilization (100% = 1 core)
84 unit: percentage
85 chart_type: line
86 dimensions:
87 - name: guest
88 - name: app.cpu_context_switches
89 description: Apps CPU context switches
90 unit: switches/s
91 chart_type: stacked
92 dimensions:
93 - name: voluntary
94 - name: involuntary
95 - name: app.estimated_mem_usage
96 description: Apps estimated memory usage (RSS with shared scaling). Requires kernel 4.14+. Enabled by default, disable with --pss 0.
97 unit: MiB
98 chart_type: line
99 dimensions:
100 - name: mem
101 - name: app.mem_usage
102 description: Apps memory RSS usage
103 unit: MiB
104 chart_type: line
105 dimensions:
106 - name: rss
107 - name: app.mem_private_usage
108 description: Apps memory usage without shared
109 unit: MiB
110 chart_type: stacked
111 dimensions:
112 - name: mem
113 - name: app.vmem_usage
114 description: Apps virtual memory size
115 unit: MiB
116 chart_type: line
117 dimensions:
118 - name: vmem
119 - name: app.mem_page_faults
120 description: Apps memory page faults
121 unit: pgfaults/s
122 chart_type: stacked
123 dimensions:
124 - name: minor
125 - name: major
126 - name: app.swap_usage
127 description: Apps swap usage
128 unit: MiB
129 chart_type: area
130 dimensions:
131 - name: swap
132 - name: app.disk_physical_io
133 description: Apps disk physical IO
134 unit: KiB/s
135 chart_type: area
136 dimensions:
137 - name: reads
138 - name: writes
139 - name: app.disk_logical_io
140 description: Apps disk logical IO
141 unit: KiB/s
142 chart_type: area
143 dimensions:
144 - name: reads
145 - name: writes
146 - name: app.processes
147 description: Apps processes
148 unit: processes
149 chart_type: line
150 dimensions:
151 - name: processes
152 - name: app.threads
153 description: Apps threads
154 unit: threads
155 chart_type: line
156 dimensions:
157 - name: threads
158 - name: app.fds_open_limit
159 description: Apps open file descriptors limit
160 unit: percentage
161 chart_type: line
162 dimensions:
163 - name: limit
164 - name: app.fds_open
165 description: Apps open file descriptors
166 unit: fds
167 chart_type: stacked
168 dimensions:
169 - name: files
170 - name: sockets
171 - name: pipes
172 - name: inotifies
173 - name: event
174 - name: timer
175 - name: signal
176 - name: eventpolls
177 - name: other
178 - name: app.uptime
179 description: Apps uptime
180 unit: seconds
181 chart_type: line
182 dimensions:
183 - name: uptime
184 - name: app.uptime_summary
185 description: Apps uptime summary
186 unit: seconds
187 chart_type: area
188 dimensions:
189 - name: min
190 - name: avg
191 - name: max
192 - meta:
193 plugin_name: apps.plugin
194 module_name: groups
195 monitored_instance:
196 name: User Groups
197 link: ""
198 categories:
199 - data-collection.operating-systems
200 icon_filename: "user.svg"
201 related_resources:
202 integrations:
203 list: []
204 info_provided_to_referring_integrations:
205 description: ""
206 keywords:
207 - groups
208 - processes
209 - user auditing
210 - authorization
211 - os
212 - host monitoring
213 overview:
214 data_collection:
215 metrics_description: "This integration monitors resource utilization on a user groups context."
216 method_description: ""
217 supported_platforms:
218 include: []
219 exclude: []
220 multi_instance: true
221 additional_permissions:
222 description: ""
223 default_behavior:
224 auto_detection:
225 description: ""
226 limits:
227 description: ""
228 performance_impact:
229 description: ""
230 setup:
231 prerequisites:
232 list: []
233 configuration:
234 file:
235 name: ""
236 description: ""
237 options:
238 description: ""
239 folding:
240 title: ""
241 enabled: true
242 list: []
243 examples:
244 folding:
245 enabled: true
246 title: ""
247 list: []
248 troubleshooting:
249 problems:
250 list: []
251 alerts: []
252 metrics:
253 folding:
254 title: Metrics
255 enabled: false
256 description: ""
257 availability: []
258 scopes:
259 - name: user group
260 description: These metrics refer to the user group.
261 labels:
262 - name: user_group
263 description: The name of the user group.
264 metrics:
265 - name: usergroup.cpu_utilization
266 description: User Groups CPU utilization (100% = 1 core)
267 unit: percentage
268 chart_type: stacked
269 dimensions:
270 - name: user
271 - name: system
272 - name: usergroup.cpu_guest_utilization
273 description: User Groups CPU guest utilization (100% = 1 core)
274 unit: percentage
275 chart_type: line
276 dimensions:
277 - name: guest
278 - name: usergroup.cpu_context_switches
279 description: User Groups CPU context switches
280 unit: switches/s
281 chart_type: stacked
282 dimensions:
283 - name: voluntary
284 - name: involuntary
285 - name: usergroup.estimated_mem_usage
286 description: User Groups estimated memory usage (RSS with shared scaling). Requires kernel 4.14+. Enabled by default, disable with --pss 0.
287 unit: MiB
288 chart_type: area
289 dimensions:
290 - name: mem
291 - name: usergroup.mem_usage
292 description: User Groups memory RSS usage
293 unit: MiB
294 chart_type: area
295 dimensions:
296 - name: rss
297 - name: usergroup.mem_private_usage
298 description: User Groups memory usage without shared
299 unit: MiB
300 chart_type: area
301 dimensions:
302 - name: mem
303 - name: usergroup.vmem_usage
304 description: User Groups virtual memory size
305 unit: MiB
306 chart_type: line
307 dimensions:
308 - name: vmem
309 - name: usergroup.mem_page_faults
310 description: User Groups memory page faults
311 unit: pgfaults/s
312 chart_type: stacked
313 dimensions:
314 - name: minor
315 - name: major
316 - name: usergroup.swap_usage
317 description: User Groups swap usage
318 unit: MiB
319 chart_type: area
320 dimensions:
321 - name: swap
322 - name: usergroup.disk_physical_io
323 description: User Groups disk physical IO
324 unit: KiB/s
325 chart_type: area
326 dimensions:
327 - name: reads
328 - name: writes
329 - name: usergroup.disk_logical_io
330 description: User Groups disk logical IO
331 unit: KiB/s
332 chart_type: area
333 dimensions:
334 - name: reads
335 - name: writes
336 - name: usergroup.processes
337 description: User Groups processes
338 unit: processes
339 chart_type: line
340 dimensions:
341 - name: processes
342 - name: usergroup.threads
343 description: User Groups threads
344 unit: threads
345 chart_type: line
346 dimensions:
347 - name: threads
348 - name: usergroup.fds_open_limit
349 description: User Groups open file descriptors limit
350 unit: percentage
351 chart_type: line
352 dimensions:
353 - name: limit
354 - name: usergroup.fds_open
355 description: User Groups open file descriptors
356 unit: fds
357 chart_type: stacked
358 dimensions:
359 - name: files
360 - name: sockets
361 - name: pipes
362 - name: inotifies
363 - name: event
364 - name: timer
365 - name: signal
366 - name: eventpolls
367 - name: other
368 - name: usergroup.uptime
369 description: User Groups uptime
370 unit: seconds
371 chart_type: line
372 dimensions:
373 - name: uptime
374 - name: usergroup.uptime_summary
375 description: User Groups uptime summary
376 unit: seconds
377 chart_type: area
378 dimensions:
379 - name: min
380 - name: avg
381 - name: max
382 - meta:
383 plugin_name: apps.plugin
384 module_name: users
385 monitored_instance:
386 name: Users
387 link: ""
388 categories:
389 - data-collection.operating-systems
390 icon_filename: "users.svg"
391 related_resources:
392 integrations:
393 list: []
394 info_provided_to_referring_integrations:
395 description: ""
396 keywords:
397 - users
398 - processes
399 - os
400 - host monitoring
401 overview:
402 data_collection:
403 metrics_description: "This integration monitors resource utilization on a user context."
404 method_description: ""
405 supported_platforms:
406 include: []
407 exclude: []
408 multi_instance: true
409 additional_permissions:
410 description: ""
411 default_behavior:
412 auto_detection:
413 description: ""
414 limits:
415 description: ""
416 performance_impact:
417 description: ""
418 setup:
419 prerequisites:
420 list: []
421 configuration:
422 file:
423 name: ""
424 description: ""
425 options:
426 description: ""
427 folding:
428 title: ""
429 enabled: true
430 list: []
431 examples:
432 folding:
433 enabled: true
434 title: ""
435 list: []
436 troubleshooting:
437 problems:
438 list: []
439 alerts: []
440 metrics:
441 folding:
442 title: Metrics
443 enabled: false
444 description: ""
445 availability: []
446 scopes:
447 - name: user
448 description: These metrics refer to the user.
449 labels:
450 - name: user
451 description: The name of the user.
452 metrics:
453 - name: user.cpu_utilization
454 description: User CPU utilization (100% = 1 core)
455 unit: percentage
456 chart_type: stacked
457 dimensions:
458 - name: user
459 - name: system
460 - name: user.cpu_guest_utilization
461 description: User CPU guest utilization (100% = 1 core)
462 unit: percentage
463 chart_type: line
464 dimensions:
465 - name: guest
466 - name: user.cpu_context_switches
467 description: User CPU context switches
468 unit: switches/s
469 chart_type: stacked
470 dimensions:
471 - name: voluntary
472 - name: involuntary
473 - name: user.estimated_mem_usage
474 description: User memory estimated usage (RSS with shared scaling). Requires kernel 4.14+. Enabled by default, disable with --pss 0.
475 unit: MiB
476 chart_type: area
477 dimensions:
478 - name: mem
479 - name: user.mem_usage
480 description: User memory RSS usage
481 unit: MiB
482 chart_type: area
483 dimensions:
484 - name: rss
485 - name: user.mem_private_usage
486 description: User memory usage without shared
487 unit: MiB
488 chart_type: area
489 dimensions:
490 - name: mem
491 - name: user.vmem_usage
492 description: User virtual memory size
493 unit: MiB
494 chart_type: line
495 dimensions:
496 - name: vmem
497 - name: user.mem_page_faults
498 description: User memory page faults
499 unit: pgfaults/s
500 chart_type: stacked
501 dimensions:
502 - name: minor
503 - name: major
504 - name: user.swap_usage
505 description: User swap usage
506 unit: MiB
507 chart_type: area
508 dimensions:
509 - name: swap
510 - name: user.disk_physical_io
511 description: User disk physical IO
512 unit: KiB/s
513 chart_type: area
514 dimensions:
515 - name: reads
516 - name: writes
517 - name: user.disk_logical_io
518 description: User disk logical IO
519 unit: KiB/s
520 chart_type: area
521 dimensions:
522 - name: reads
523 - name: writes
524 - name: user.processes
525 description: User processes
526 unit: processes
527 chart_type: line
528 dimensions:
529 - name: processes
530 - name: user.threads
531 description: User threads
532 unit: threads
533 chart_type: line
534 dimensions:
535 - name: threads
536 - name: user.fds_open_limit
537 description: User open file descriptors limit
538 unit: percentage
539 chart_type: line
540 dimensions:
541 - name: limit
542 - name: user.fds_open
543 description: User open file descriptors
544 unit: fds
545 chart_type: stacked
546 dimensions:
547 - name: files
548 - name: sockets
549 - name: pipes
550 - name: inotifies
551 - name: event
552 - name: timer
553 - name: signal
554 - name: eventpolls
555 - name: other
556 - name: user.uptime
557 description: User uptime
558 unit: seconds
559 chart_type: line
560 dimensions:
561 - name: uptime
562 - name: user.uptime_summary
563 description: User uptime summary
564 unit: seconds
565 chart_type: area
566 dimensions:
567 - name: min
568 - name: avg
569 - name: max
570 - meta:
571 plugin_name: apps.plugin
572 module_name: services
573 monitored_instance:
574 name: Windows Services
575 link: ""
576 categories:
577 - data-collection.operating-systems
578 icon_filename: "windows.svg"
579 related_resources:
580 integrations:
581 list: []
582 info_provided_to_referring_integrations:
583 description: ""
584 keywords:
585 - windows
586 - services
587 - processes
588 - os
589 - host monitoring
590 overview:
591 data_collection:
592 metrics_description: "This integration monitors resource utilization grouped by Windows Service."
593 method_description: "It auto-discovers running Windows services via the Service Control Manager and groups each service's process tree to aggregate CPU, memory, I/O, and other metrics per service. Processes not belonging to any service are grouped under 'not-services'."
594 supported_platforms:
595 include:
596 - windows
597 exclude: []
598 multi_instance: true
599 additional_permissions:
600 description: ""
601 default_behavior:
602 auto_detection:
603 description: "All running Windows services are automatically discovered. No configuration is needed."
604 limits:
605 description: ""
606 performance_impact:
607 description: "No additional SCM query overhead. The service list is already queried by apps.plugin for process naming. Per-iteration work involves walking parent chains to assign service names."
608 setup:
609 prerequisites:
610 list: []
611 configuration:
612 file:
613 name: ""
614 description: ""
615 options:
616 description: "Service charts are enabled by default. Use the `without-services` (or `no-services`) command line option to disable them."
617 folding:
618 title: ""
619 enabled: true
620 list: []
621 examples:
622 folding:
623 enabled: true
624 title: ""
625 list: []
626 troubleshooting:
627 problems:
628 list: []
629 alerts: []
630 metrics:
631 folding:
632 title: Metrics
633 enabled: false
634 description: ""
635 availability:
636 - windows
637 scopes:
638 - name: windows service
639 description: These metrics refer to the Windows Service.
640 labels:
641 - name: service
642 description: The display name of the Windows service.
643 metrics:
644 - name: service.cpu_utilization
645 description: Windows Service CPU utilization (100% = 1 core)
646 unit: percentage
647 chart_type: stacked
648 dimensions:
649 - name: user
650 - name: system
651 - name: service.mem_usage
652 description: Windows Service memory RSS usage
653 unit: MiB
654 chart_type: area
655 dimensions:
656 - name: rss
657 - name: service.vmem_usage
658 description: Windows Service virtual memory size
659 unit: MiB
660 chart_type: line
661 dimensions:
662 - name: vmem
663 - name: service.mem_page_faults
664 description: Windows Service memory page faults
665 unit: pgfaults/s
666 chart_type: stacked
667 dimensions:
668 - name: minor
669 - name: service.swap_usage
670 description: Windows Service swap usage
671 unit: MiB
672 chart_type: area
673 dimensions:
674 - name: swap
675 - name: service.disk_logical_io
676 description: Windows Service disk logical IO
677 unit: KiB/s
678 chart_type: area
679 dimensions:
680 - name: reads
681 - name: writes
682 - name: service.fds_open
683 description: Windows Service open handles
684 unit: fds
685 chart_type: stacked
686 dimensions:
687 - name: handles
688 - name: service.processes
689 description: Windows Service processes
690 unit: processes
691 chart_type: line
692 dimensions:
693 - name: processes
694 - name: service.threads
695 description: Windows Service threads
696 unit: threads
697 chart_type: line
698 dimensions:
699 - name: threads
700 - name: service.uptime
701 description: Windows Service uptime
702 unit: seconds
703 chart_type: line
704 dimensions:
705 - name: uptime
706 - name: service.uptime_summary
707 description: Windows Service uptime summary
708 unit: seconds
709 chart_type: area
710 dimensions:
711 - name: min
712 - name: avg
713 - name: max