master
yaml 726 lines 27.5 KB
Raw
1 plugin_name: macos.plugin
2 modules:
3 - meta:
4 plugin_name: macos.plugin
5 module_name: mach_smi
6 monitored_instance:
7 name: macOS
8 link: "https://www.apple.com/macos"
9 categories:
10 - data-collection.operating-systems
11 icon_filename: "macos.svg"
12 related_resources:
13 integrations:
14 list: []
15 info_provided_to_referring_integrations:
16 description: ""
17 keywords:
18 - macos
19 - apple
20 - darwin
21 overview:
22 data_collection:
23 metrics_description: "Monitor macOS metrics for efficient operating system performance."
24 method_description: |
25 The plugin uses three different methods to collect data:
26 - The function `sysctlbyname` is called to collect network, swap, loadavg, and boot time.
27 - The functtion `host_statistic` is called to collect CPU and Virtual memory data;
28 - The function `IOServiceGetMatchingServices` to collect storage information.
29 supported_platforms:
30 include:
31 - macOS
32 exclude: []
33 multi_instance: false
34 additional_permissions:
35 description: ""
36 default_behavior:
37 auto_detection:
38 description: ""
39 limits:
40 description: ""
41 performance_impact:
42 description: ""
43 setup:
44 prerequisites:
45 list: []
46 configuration:
47 file:
48 name: "netdata.conf"
49 description: "The netdata main configuration file."
50 options:
51 description: |
52 There are three sections in the file which you can configure:
53
54 - `[plugin:macos:sysctl]` - Enable or disable monitoring for network, swap, loadavg, and boot time.
55 - `[plugin:macos:mach_smi]` - Enable or disable monitoring for CPU and Virtual memory.
56 - `[plugin:macos:iokit]` - Enable or disable monitoring for storage device.
57 folding:
58 title: "Config options"
59 enabled: true
60 list:
61 - name: enable load average
62 section_name: plugin:macos:sysctl
63 description: Enable or disable monitoring of load average metrics (load1, load5, load15).
64 default_value: yes
65 required: false
66 - name: system swap
67 section_name: plugin:macos:sysctl
68 description: Enable or disable monitoring of system swap metrics (free, used).
69 default_value: yes
70 required: false
71 - name: bandwidth
72 section_name: plugin:macos:sysctl
73 description: Enable or disable monitoring of network bandwidth metrics (received, sent).
74 default_value: yes
75 required: false
76 - name: ipv4 TCP packets
77 description: Enable or disable monitoring of IPv4 TCP total packets metrics (received, sent).
78 section_name: plugin:macos:sysctl
79 default_value: yes
80 required: false
81 - name: ipv4 TCP errors
82 section_name: plugin:macos:sysctl
83 description: Enable or disable monitoring of IPv4 TCP packets metrics (Input Errors, Checksum, Retransmission segments).
84 default_value: yes
85 required: false
86 - name: ipv4 TCP handshake issues
87 section_name: plugin:macos:sysctl
88 description: Enable or disable monitoring of IPv4 TCP handshake metrics (Established Resets, Active Opens, Passive Opens, Attempt Fails).
89 default_value: yes
90 required: false
91 - name: ECN packets
92 section_name: plugin:macos:sysctl
93 description: Enable or disable monitoring of ECN statistics metrics (InCEPkts, InNoECTPkts).
94 default_value: auto
95 required: false
96 - name: TCP SYN cookies
97 section_name: plugin:macos:sysctl
98 description: Enable or disable monitoring of TCP SYN cookies metrics (received, sent, failed).
99 default_value: auto
100 required: false
101 - name: TCP out-of-order queue
102 section_name: plugin:macos:sysctl
103 description: Enable or disable monitoring of TCP out-of-order queue metrics (inqueue).
104 default_value: auto
105 required: false
106 - name: TCP connection aborts
107 section_name: plugin:macos:sysctl
108 description: Enable or disable monitoring of TCP connection aborts metrics (Bad Data, User closed, No memory, Timeout).
109 default_value: auto
110 required: false
111 - name: ipv4 UDP packets
112 section_name: plugin:macos:sysctl
113 description: Enable or disable monitoring of ipv4 UDP packets metrics (sent, received.).
114 default_value: yes
115 required: false
116 - name: ipv4 UDP errors
117 section_name: plugin:macos:sysctl
118 description: Enable or disable monitoring of ipv4 UDP errors metrics (Recieved Buffer error, Input Errors, No Ports, IN Checksum Errors, Ignore Multi).
119 default_value: yes
120 required: false
121 - name: ipv4 icmp packets
122 section_name: plugin:macos:sysctl
123 description: Enable or disable monitoring of IPv4 ICMP packets metrics (sent, received, in error, OUT error, IN Checksum error).
124 default_value: yes
125 required: false
126 - name: ipv4 icmp messages
127 section_name: plugin:macos:sysctl
128 description: Enable or disable monitoring of ipv4 ICMP messages metrics (I/O messages, I/O Errors, In Checksum).
129 default_value: yes
130 required: false
131 - name: ipv4 packets
132 section_name: plugin:macos:sysctl
133 description: Enable or disable monitoring of ipv4 packets metrics (received, sent, forwarded, delivered).
134 default_value: yes
135 required: false
136 - name: ipv4 fragments sent
137 section_name: plugin:macos:sysctl
138 description: Enable or disable monitoring of IPv4 fragments sent metrics (ok, fails, creates).
139 default_value: yes
140 required: false
141 - name: ipv4 fragments assembly
142 section_name: plugin:macos:sysctl
143 description: Enable or disable monitoring of IPv4 fragments assembly metrics (ok, failed, all).
144 default_value: yes
145 required: false
146 - name: ipv4 errors
147 section_name: plugin:macos:sysctl
148 description: Enable or disable monitoring of IPv4 errors metrics (I/O discard, I/O HDR errors, In Addr errors, In Unknown protos, OUT No Routes).
149 default_value: yes
150 required: false
151 - name: ipv6 packets
152 section_name: plugin:macos:sysctl
153 description: Enable or disable monitoring of IPv6 packets metrics (received, sent, forwarded, delivered).
154 default_value: auto
155 required: false
156 - name: ipv6 fragments sent
157 section_name: plugin:macos:sysctl
158 description: Enable or disable monitoring of IPv6 fragments sent metrics (ok, failed, all).
159 default_value: auto
160 required: false
161 - name: ipv6 fragments assembly
162 section_name: plugin:macos:sysctl
163 description: Enable or disable monitoring of IPv6 fragments assembly metrics (ok, failed, timeout, all).
164 default_value: auto
165 required: false
166 - name: ipv6 errors
167 section_name: plugin:macos:sysctl
168 description: Enable or disable monitoring of IPv6 errors metrics (I/O Discards, In Hdr Errors, In Addr Errors, In Truncaedd Packets, I/O No Routes).
169 default_value: auto
170 required: false
171 - name: icmp
172 section_name: plugin:macos:sysctl
173 description: Enable or disable monitoring of ICMP metrics (sent, received).
174 default_value: auto
175 required: false
176 - name: icmp redirects
177 section_name: plugin:macos:sysctl
178 description: Enable or disable monitoring of ICMP redirects metrics (received, sent).
179 default_value: auto
180 required: false
181 - name: icmp errors
182 section_name: plugin:macos:sysctl
183 description: Enable or disable monitoring of ICMP metrics (I/O Errors, In Checksums, In Destination Unreachable, In Packet too big, In Time Exceeds, In Parm Problem, Out Dest Unreachable, Out Timee Exceeds, Out Parm Problems.).
184 default_value: auto
185 required: false
186 - name: icmp echos
187 section_name: plugin:macos:sysctl
188 description: Enable or disable monitoring of ICMP echos metrics (I/O Echos, I/O Echo Reply).
189 default_value: auto
190 required: false
191 - name: icmp router
192 section_name: plugin:macos:sysctl
193 description: Enable or disable monitoring of ICMP router metrics (I/O Solicits, I/O Advertisements).
194 default_value: auto
195 required: false
196 - name: icmp neighbor
197 section_name: plugin:macos:sysctl
198 description: Enable or disable monitoring of ICMP neighbor metrics (I/O Solicits, I/O Advertisements).
199 default_value: auto
200 required: false
201 - name: icmp types
202 section_name: plugin:macos:sysctl
203 description: Enable or disable monitoring of ICMP types metrics (I/O Type1, I/O Type128, I/O Type129, Out Type133, Out Type135, In Type136, Out Type145).
204 default_value: auto
205 required: false
206 - name: space usage for all disks
207 section_name: plugin:macos:sysctl
208 description: Enable or disable monitoring of space usage for all disks metrics (available, used, reserved for root).
209 default_value: yes
210 required: false
211 - name: inodes usage for all disks
212 section_name: plugin:macos:sysctl
213 description: Enable or disable monitoring of inodes usage for all disks metrics (available, used, reserved for root).
214 default_value: yes
215 required: false
216 - name: bandwidth
217 section_name: plugin:macos:sysctl
218 description: Enable or disable monitoring of bandwidth metrics (received, sent).
219 default_value: yes
220 required: false
221 - name: system uptime
222 section_name: plugin:macos:sysctl
223 description: Enable or disable monitoring of system uptime metrics (uptime).
224 default_value: yes
225 required: false
226 - name: cpu utilization
227 section_name: plugin:macos:mach_smi
228 description: Enable or disable monitoring of CPU utilization metrics (user, nice, system, idel).
229 default_value: yes
230 required: false
231 - name: system ram
232 section_name: plugin:macos:mach_smi
233 description: Enable or disable monitoring of system RAM metrics (Active, Wired, throttled, compressor, inactive, purgeable, speculative, free).
234 default_value: yes
235 required: false
236 - name: swap i/o
237 section_name: plugin:macos:mach_smi
238 description: Enable or disable monitoring of SWAP I/O metrics (I/O Swap).
239 default_value: yes
240 required: false
241 - name: memory page faults
242 section_name: plugin:macos:mach_smi
243 description: Enable or disable monitoring of memory page faults metrics (memory, cow, I/O page, compress, decompress, zero fill, reactivate, purge).
244 default_value: yes
245 required: false
246 - name: disk i/o
247 section_name: plugin:macos:iokit
248 description: Enable or disable monitoring of disk I/O metrics (In, Out).
249 default_value: yes
250 required: false
251 examples:
252 folding:
253 enabled: false
254 title: "Config"
255 list:
256 - name: Disable swap monitoring.
257 folding:
258 enabled: true
259 description: A basic example that discards swap monitoring
260 config: |
261 [plugin:macos:sysctl]
262 system swap = no
263 [plugin:macos:mach_smi]
264 swap i/o = no
265 - name: Disable complete Machine SMI section.
266 folding:
267 enabled: true
268 description: A basic example that discards swap monitoring
269 config: |
270 [plugin:macos:mach_smi]
271 cpu utilization = no
272 system ram = no
273 swap i/o = no
274 memory page faults = no
275 disk i/o = no
276 troubleshooting:
277 problems:
278 list: []
279 alerts:
280 - name: interface_speed
281 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf
282 metric: net.net
283 info: network interface ${label:device} current speed
284 os: "*"
285 metrics:
286 folding:
287 title: Metrics
288 enabled: false
289 description: ""
290 availability: []
291 scopes:
292 - name: global
293 description: |
294 These metrics refer to hardware and network monitoring.
295 labels: []
296 metrics:
297 - name: system.cpu
298 description: Total CPU utilization
299 unit: "percentage"
300 chart_type: stacked
301 dimensions:
302 - name: user
303 - name: nice
304 - name: system
305 - name: idle
306 - name: system.ram
307 description: System RAM
308 unit: "MiB"
309 chart_type: stacked
310 dimensions:
311 - name: active
312 - name: wired
313 - name: throttled
314 - name: compressor
315 - name: inactive
316 - name: purgeable
317 - name: speculative
318 - name: free
319 - name: mem.swapio
320 description: Swap I/O
321 unit: "KiB/s"
322 chart_type: area
323 dimensions:
324 - name: io
325 - name: out
326 - name: mem.pgfaults
327 description: Memory Page Faults
328 unit: "faults/s"
329 chart_type: line
330 dimensions:
331 - name: memory
332 - name: cow
333 - name: pagein
334 - name: pageout
335 - name: compress
336 - name: decompress
337 - name: zero_fill
338 - name: reactivate
339 - name: purge
340 - name: system.load
341 description: System Load Average
342 unit: "load"
343 chart_type: line
344 dimensions:
345 - name: load1
346 - name: load5
347 - name: load15
348 - name: mem.swap
349 description: System Swap
350 unit: "MiB"
351 chart_type: stacked
352 dimensions:
353 - name: free
354 - name: used
355 - name: system.ipv4
356 description: IPv4 Bandwidth
357 unit: "kilobits/s"
358 chart_type: area
359 dimensions:
360 - name: received
361 - name: sent
362 - name: ipv4.tcppackets
363 description: IPv4 TCP Packets
364 unit: "packets/s"
365 chart_type: line
366 dimensions:
367 - name: received
368 - name: sent
369 - name: ipv4.tcperrors
370 description: IPv4 TCP Errors
371 unit: "packets/s"
372 chart_type: line
373 dimensions:
374 - name: InErrs
375 - name: InCsumErrors
376 - name: RetransSegs
377 - name: ipv4.tcphandshake
378 description: IPv4 TCP Handshake Issues
379 unit: "events/s"
380 chart_type: line
381 dimensions:
382 - name: EstabResets
383 - name: ActiveOpens
384 - name: PassiveOpens
385 - name: AttemptFails
386 - name: ipv4.tcpconnaborts
387 description: TCP Connection Aborts
388 unit: "connections/s"
389 chart_type: line
390 dimensions:
391 - name: baddata
392 - name: userclosed
393 - name: nomemory
394 - name: timeout
395 - name: ipv4.tcpofo
396 description: TCP Out-Of-Order Queue
397 unit: "packets/s"
398 chart_type: line
399 dimensions:
400 - name: inqueue
401 - name: ipv4.tcpsyncookies
402 description: TCP SYN Cookies
403 unit: "packets/s"
404 chart_type: line
405 dimensions:
406 - name: received
407 - name: sent
408 - name: failed
409 - name: ipv4.ecnpkts
410 description: IPv4 ECN Statistics
411 unit: "packets/s"
412 chart_type: line
413 dimensions:
414 - name: CEP
415 - name: NoECTP
416 - name: ipv4.udppackets
417 description: IPv4 UDP Packets
418 unit: "packets/s"
419 chart_type: line
420 dimensions:
421 - name: received
422 - name: sent
423 - name: ipv4.udperrors
424 description: IPv4 UDP Errors
425 unit: "events/s"
426 chart_type: line
427 dimensions:
428 - name: RcvbufErrors
429 - name: InErrors
430 - name: NoPorts
431 - name: InCsumErrors
432 - name: IgnoredMulti
433 - name: ipv4.icmp
434 description: IPv4 ICMP Packets
435 unit: "packets/s"
436 chart_type: line
437 dimensions:
438 - name: received
439 - name: sent
440 - name: ipv4.icmp_errors
441 description: IPv4 ICMP Errors
442 unit: "packets/s"
443 chart_type: line
444 dimensions:
445 - name: InErrors
446 - name: OutErrors
447 - name: InCsumErrors
448 - name: ipv4.icmpmsg
449 description: IPv4 ICMP Messages
450 unit: "packets/s"
451 chart_type: line
452 dimensions:
453 - name: InEchoReps
454 - name: OutEchoReps
455 - name: InEchos
456 - name: OutEchos
457 - name: ipv4.packets
458 description: IPv4 Packets
459 unit: "packets/s"
460 chart_type: line
461 dimensions:
462 - name: received
463 - name: sent
464 - name: forwarded
465 - name: delivered
466 - name: ipv4.fragsout
467 description: IPv4 Fragments Sent
468 unit: "packets/s"
469 chart_type: line
470 dimensions:
471 - name: ok
472 - name: failed
473 - name: created
474 - name: ipv4.fragsin
475 description: IPv4 Fragments Reassembly
476 unit: "packets/s"
477 chart_type: line
478 dimensions:
479 - name: ok
480 - name: failed
481 - name: all
482 - name: ipv4.errors
483 description: IPv4 Errors
484 unit: "packets/s"
485 chart_type: line
486 dimensions:
487 - name: InDiscards
488 - name: OutDiscards
489 - name: InHdrErrors
490 - name: OutNoRoutes
491 - name: InAddrErrors
492 - name: InUnknownProtos
493 - name: ipv6.packets
494 description: IPv6 Packets
495 unit: "packets/s"
496 chart_type: line
497 dimensions:
498 - name: received
499 - name: sent
500 - name: forwarded
501 - name: delivers
502 - name: ipv6.fragsout
503 description: IPv6 Fragments Sent
504 unit: "packets/s"
505 chart_type: line
506 dimensions:
507 - name: ok
508 - name: failed
509 - name: all
510 - name: ipv6.fragsin
511 description: IPv6 Fragments Reassembly
512 unit: "packets/s"
513 chart_type: line
514 dimensions:
515 - name: ok
516 - name: failed
517 - name: timeout
518 - name: all
519 - name: ipv6.errors
520 description: IPv6 Errors
521 unit: "packets/s"
522 chart_type: line
523 dimensions:
524 - name: InDiscards
525 - name: OutDiscards
526 - name: InHdrErrors
527 - name: InAddrErrors
528 - name: InTruncatedPkts
529 - name: InNoRoutes
530 - name: OutNoRoutes
531 - name: ipv6.icmp
532 description: IPv6 ICMP Messages
533 unit: "messages/s"
534 chart_type: line
535 dimensions:
536 - name: received
537 - name: sent
538 - name: ipv6.icmpredir
539 description: IPv6 ICMP Redirects
540 unit: "redirects/s"
541 chart_type: line
542 dimensions:
543 - name: received
544 - name: sent
545 - name: ipv6.icmperrors
546 description: IPv6 ICMP Errors
547 unit: "errors/s"
548 chart_type: line
549 dimensions:
550 - name: InErrors
551 - name: OutErrors
552 - name: InCsumErrors
553 - name: InDestUnreachs
554 - name: InPktTooBigs
555 - name: InTimeExcds
556 - name: InParmProblems
557 - name: OutDestUnreachs
558 - name: OutTimeExcds
559 - name: OutParmProblems
560 - name: ipv6.icmpechos
561 description: IPv6 ICMP Echo
562 unit: "messages/s"
563 chart_type: line
564 dimensions:
565 - name: InEchos
566 - name: OutEchos
567 - name: InEchoReplies
568 - name: OutEchoReplies
569 - name: ipv6.icmprouter
570 description: IPv6 Router Messages
571 unit: "messages/s"
572 chart_type: line
573 dimensions:
574 - name: InSolicits
575 - name: OutSolicits
576 - name: InAdvertisements
577 - name: OutAdvertisements
578 - name: ipv6.icmpneighbor
579 description: IPv6 Neighbor Messages
580 unit: "messages/s"
581 chart_type: line
582 dimensions:
583 - name: InSolicits
584 - name: OutSolicits
585 - name: InAdvertisements
586 - name: OutAdvertisements
587 - name: ipv6.icmptypes
588 description: IPv6 ICMP Types
589 unit: "messages/s"
590 chart_type: line
591 dimensions:
592 - name: InType1
593 - name: InType128
594 - name: InType129
595 - name: InType136
596 - name: OutType1
597 - name: OutType128
598 - name: OutType129
599 - name: OutType133
600 - name: OutType135
601 - name: OutType143
602 - name: system.uptime
603 description: System Uptime
604 unit: "seconds"
605 chart_type: line
606 dimensions:
607 - name: uptime
608 - name: system.io
609 description: Disk I/O
610 unit: "KiB/s"
611 chart_type: area
612 dimensions:
613 - name: in
614 - name: out
615 - name: disk
616 description: ""
617 labels: []
618 metrics:
619 - name: disk.io
620 description: Disk I/O Bandwidth
621 unit: "KiB/s"
622 chart_type: area
623 dimensions:
624 - name: read
625 - name: writes
626 - name: disk.ops
627 description: Disk Completed I/O Operations
628 unit: "operations/s"
629 chart_type: line
630 dimensions:
631 - name: read
632 - name: writes
633 - name: disk.util
634 description: Disk Utilization Time
635 unit: "% of time working"
636 chart_type: area
637 dimensions:
638 - name: utilization
639 - name: disk.iotime
640 description: Disk Total I/O Time
641 unit: "milliseconds/s"
642 chart_type: line
643 dimensions:
644 - name: reads
645 - name: writes
646 - name: disk.await
647 description: Average Completed I/O Operation Time
648 unit: "milliseconds/operation"
649 chart_type: line
650 dimensions:
651 - name: reads
652 - name: writes
653 - name: disk.avgsz
654 description: Average Completed I/O Operation Bandwidth
655 unit: "KiB/operation"
656 chart_type: line
657 dimensions:
658 - name: reads
659 - name: writes
660 - name: disk.svctm
661 description: Average Service Time
662 unit: "milliseconds/operation"
663 chart_type: line
664 dimensions:
665 - name: svctm
666 - name: mount point
667 description: ""
668 labels: []
669 metrics:
670 - name: disk.space
671 description: Disk Space Usage for {mounted dir} [{mounted filesystem}]
672 unit: "GiB"
673 chart_type: stacked
674 dimensions:
675 - name: avail
676 - name: used
677 - name: reserved_for_root
678 - name: disk.inodes
679 description: Disk Files (inodes) Usage for {mounted dir} [{mounted filesystem}]
680 unit: "inodes"
681 chart_type: stacked
682 dimensions:
683 - name: avail
684 - name: used
685 - name: reserved_for_root
686 - name: network device
687 description: ""
688 labels: []
689 metrics:
690 - name: net.net
691 description: Bandwidth
692 unit: "kilobits/s"
693 chart_type: area
694 dimensions:
695 - name: received
696 - name: sent
697 - name: net.packets
698 description: Packets
699 unit: "packets/s"
700 chart_type: line
701 dimensions:
702 - name: received
703 - name: sent
704 - name: multicast_received
705 - name: multicast_sent
706 - name: net.errors
707 description: Interface Errors
708 unit: "errors/s"
709 chart_type: line
710 dimensions:
711 - name: inbound
712 - name: outbound
713 - name: net.drops
714 description: Interface Drops
715 unit: "drops/s"
716 chart_type: line
717 dimensions:
718 - name: inbound
719 - name: net.events
720 description: Network Interface Events
721 unit: "events/s"
722 chart_type: line
723 dimensions:
724 - name: frames
725 - name: collisions
726 - name: carrier