diff options
Diffstat (limited to '')
| -rw-r--r-- | collectors/macos.plugin/metadata.yaml (renamed from collectors/macos.plugin/multi_metadata.yaml) | 596 |
1 files changed, 263 insertions, 333 deletions
diff --git a/collectors/macos.plugin/multi_metadata.yaml b/collectors/macos.plugin/metadata.yaml index 38668fdc..cc159ad1 100644 --- a/collectors/macos.plugin/multi_metadata.yaml +++ b/collectors/macos.plugin/metadata.yaml @@ -1,94 +1,288 @@ -name: macos.plugin +plugin_name: macos.plugin modules: - meta: plugin_name: macos.plugin module_name: mach_smi monitored_instance: - name: macos mach_smi - link: '' - categories: [] - icon_filename: '' + name: macOS + link: "https://www.apple.com/macos" + categories: + - data-collection.macos-systems + icon_filename: "macos.svg" related_resources: integrations: list: [] info_provided_to_referring_integrations: - description: '' - keywords: [] + description: "" + keywords: + - macos + - apple + - darwin most_popular: false overview: data_collection: - metrics_description: '' - method_description: '' + metrics_description: "Monitor macOS metrics for efficient operating system performance." + method_description: | + The plugin uses three different methods to collect data: + - The function `sysctlbyname` is called to collect network, swap, loadavg, and boot time. + - The functtion `host_statistic` is called to collect CPU and Virtual memory data; + - The function `IOServiceGetMatchingServices` to collect storage information. supported_platforms: - include: [] + include: + - macOS exclude: [] - multi-instance: true + multi_instance: false additional_permissions: - description: '' + description: "" default_behavior: auto_detection: - description: '' + description: "" limits: - description: '' + description: "" performance_impact: - description: '' + description: "" setup: prerequisites: list: [] configuration: file: - name: '' - description: '' + name: "netdata.conf" + description: "The netdata main configuration file." options: - description: '' + description: | + There are three sections in the file which you can configure: + + - `[plugin:macos:sysctl]` - Enable or disable monitoring for network, swap, loadavg, and boot time. + - `[plugin:macos:mach_smi]` - Enable or disable monitoring for CPU and Virtual memory. + - `[plugin:macos:iokit]` - Enable or disable monitoring for storage device. folding: - title: '' + title: "Config options" enabled: true - list: [] + list: + - name: enable load average + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of load average metrics (load1, load5, load15). + default_value: yes + required: false + - name: system swap + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of system swap metrics (free, used). + default_value: yes + required: false + - name: bandwidth + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of network bandwidth metrics (received, sent). + default_value: yes + required: false + - name: ipv4 TCP packets + description: Enable or disable monitoring of IPv4 TCP total packets metrics (received, sent). + section_name: plugin:macos:sysctl + default_value: yes + required: false + - name: ipv4 TCP errors + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of IPv4 TCP packets metrics (Input Errors, Checksum, Retransmission segments). + default_value: yes + required: false + - name: ipv4 TCP handshake issues + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of IPv4 TCP handshake metrics (Established Resets, Active Opens, Passive Opens, Attempt Fails). + default_value: yes + required: false + - name: ECN packets + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ECN statistics metrics (InCEPkts, InNoECTPkts). + default_value: auto + required: false + - name: TCP SYN cookies + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of TCP SYN cookies metrics (received, sent, failed). + default_value: auto + required: false + - name: TCP out-of-order queue + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of TCP out-of-order queue metrics (inqueue). + default_value: auto + required: false + - name: TCP connection aborts + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of TCP connection aborts metrics (Bad Data, User closed, No memory, Timeout). + default_value: auto + required: false + - name: ipv4 UDP packets + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ipv4 UDP packets metrics (sent, received.). + default_value: yes + required: false + - name: ipv4 UDP errors + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ipv4 UDP errors metrics (Recieved Buffer error, Input Errors, No Ports, IN Checksum Errors, Ignore Multi). + default_value: yes + required: false + - name: ipv4 icmp packets + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of IPv4 ICMP packets metrics (sent, received, in error, OUT error, IN Checksum error). + default_value: yes + required: false + - name: ipv4 icmp messages + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ipv4 ICMP messages metrics (I/O messages, I/O Errors, In Checksum). + default_value: yes + required: false + - name: ipv4 packets + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ipv4 packets metrics (received, sent, forwarded, delivered). + default_value: yes + required: false + - name: ipv4 fragments sent + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of IPv4 fragments sent metrics (ok, fails, creates). + default_value: yes + required: false + - name: ipv4 fragments assembly + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of IPv4 fragments assembly metrics (ok, failed, all). + default_value: yes + required: false + - name: ipv4 errors + section_name: plugin:macos:sysctl + 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). + default_value: yes + required: false + - name: ipv6 packets + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of IPv6 packets metrics (received, sent, forwarded, delivered). + default_value: auto + required: false + - name: ipv6 fragments sent + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of IPv6 fragments sent metrics (ok, failed, all). + default_value: auto + required: false + - name: ipv6 fragments assembly + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of IPv6 fragments assembly metrics (ok, failed, timeout, all). + default_value: auto + required: false + - name: ipv6 errors + section_name: plugin:macos:sysctl + 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). + default_value: auto + required: false + - name: icmp + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ICMP metrics (sent, received). + default_value: auto + required: false + - name: icmp redirects + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ICMP redirects metrics (received, sent). + default_value: auto + required: false + - name: icmp errors + section_name: plugin:macos:sysctl + 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.). + default_value: auto + required: false + - name: icmp echos + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ICMP echos metrics (I/O Echos, I/O Echo Reply). + default_value: auto + required: false + - name: icmp router + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ICMP router metrics (I/O Solicits, I/O Advertisements). + default_value: auto + required: false + - name: icmp neighbor + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of ICMP neighbor metrics (I/O Solicits, I/O Advertisements). + default_value: auto + required: false + - name: icmp types + section_name: plugin:macos:sysctl + 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). + default_value: auto + required: false + - name: space usage for all disks + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of space usage for all disks metrics (available, used, reserved for root). + default_value: yes + required: false + - name: inodes usage for all disks + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of inodes usage for all disks metrics (available, used, reserved for root). + default_value: yes + required: false + - name: bandwidth + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of bandwidth metrics (received, sent). + default_value: yes + required: false + - name: system uptime + section_name: plugin:macos:sysctl + description: Enable or disable monitoring of system uptime metrics (uptime). + default_value: yes + required: false + - name: cpu utilization + section_name: plugin:macos:mach_smi + description: Enable or disable monitoring of CPU utilization metrics (user, nice, system, idel). + default_value: yes + required: false + - name: system ram + section_name: plugin:macos:mach_smi + description: Enable or disable monitoring of system RAM metrics (Active, Wired, throttled, compressor, inactive, purgeable, speculative, free). + default_value: yes + required: false + - name: swap i/o + section_name: plugin:macos:mach_smi + description: Enable or disable monitoring of SWAP I/O metrics (I/O Swap). + default_value: yes + required: false + - name: memory page faults + section_name: plugin:macos:mach_smi + description: Enable or disable monitoring of memory page faults metrics (memory, cow, I/O page, compress, decompress, zero fill, reactivate, purge). + default_value: yes + required: false + - name: disk i/o + section_name: plugin:macos:iokit + description: Enable or disable monitoring of disk I/O metrics (In, Out). + default_value: yes + required: false examples: folding: - enabled: true - title: '' - list: [] + enabled: false + title: "Config" + list: + - name: Disable swap monitoring. + folding: + enabled: true + description: A basic example that discards swap monitoring + config: | + [plugin:macos:sysctl] + system swap = no + [plugin:macos:mach_smi] + swap i/o = no + - name: Disable complete Machine SMI section. + folding: + enabled: true + description: A basic example that discards swap monitoring + config: | + [plugin:macos:mach_smi] + cpu utilization = no + system ram = no + swap i/o = no + memory page faults = no + disk i/o = no troubleshooting: problems: list: [] alerts: - - name: 10min_cpu_usage - link: https://github.com/netdata/netdata/blob/master/health/health.d/cpu.conf - metric: system.cpu - info: average CPU utilization over the last 10 minutes (excluding iowait, nice and steal) - os: "linux" - - name: 10min_cpu_iowait - link: https://github.com/netdata/netdata/blob/master/health/health.d/cpu.conf - metric: system.cpu - info: average CPU iowait time over the last 10 minutes - os: "linux" - - name: 20min_steal_cpu - link: https://github.com/netdata/netdata/blob/master/health/health.d/cpu.conf - metric: system.cpu - info: average CPU steal time over the last 20 minutes - os: "linux" - - name: 10min_cpu_usage - link: https://github.com/netdata/netdata/blob/master/health/health.d/cpu.conf - metric: system.cpu - info: average CPU utilization over the last 10 minutes (excluding nice) - os: "freebsd" - - name: ram_in_use - link: https://github.com/netdata/netdata/blob/master/health/health.d/ram.conf - metric: system.ram - info: system memory utilization - os: "linux" - - name: ram_in_use - link: https://github.com/netdata/netdata/blob/master/health/health.d/ram.conf - metric: system.ram - info: system memory utilization - os: "freebsd" - - name: 30min_ram_swapped_out - link: https://github.com/netdata/netdata/blob/master/health/health.d/swap.conf - metric: system.swapio - info: percentage of the system RAM swapped in the last 30 minutes - os: "linux freebsd" + - name: interface_speed + link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf + metric: net.net + info: network interface ${label:device} current speed + os: "*" metrics: folding: title: Metrics @@ -97,7 +291,8 @@ modules: availability: [] scopes: - name: global - description: "" + description: | + These metrics refer to hardware and network monitoring. labels: [] metrics: - name: system.cpu @@ -122,7 +317,7 @@ modules: - name: purgeable - name: speculative - name: free - - name: system.swapio + - name: mem.swapio description: Swap I/O unit: "KiB/s" chart_type: area @@ -143,126 +338,6 @@ modules: - name: zero_fill - name: reactivate - name: purge - - meta: - plugin_name: macos.plugin - module_name: sysctl - monitored_instance: - name: macos sysctl - link: '' - categories: [] - icon_filename: '' - related_resources: - integrations: - list: [] - info_provided_to_referring_integrations: - description: '' - keywords: [] - most_popular: false - overview: - data_collection: - metrics_description: '' - method_description: '' - supported_platforms: - include: [] - exclude: [] - multi-instance: true - additional_permissions: - description: '' - default_behavior: - auto_detection: - description: '' - limits: - description: '' - performance_impact: - description: '' - setup: - prerequisites: - list: [] - configuration: - file: - name: '' - description: '' - options: - description: '' - folding: - title: '' - enabled: true - list: [] - examples: - folding: - enabled: true - title: '' - list: [] - troubleshooting: - problems: - list: [] - alerts: - - name: load_cpu_number - link: https://github.com/netdata/netdata/blob/master/health/health.d/load.conf - metric: system.load - info: number of active CPU cores in the system - os: "linux" - - name: load_average_15 - link: https://github.com/netdata/netdata/blob/master/health/health.d/load.conf - metric: system.load - info: system fifteen-minute load average - os: "linux" - - name: load_average_5 - link: https://github.com/netdata/netdata/blob/master/health/health.d/load.conf - metric: system.load - info: system five-minute load average - os: "linux" - - name: load_average_1 - link: https://github.com/netdata/netdata/blob/master/health/health.d/load.conf - metric: system.load - info: system one-minute load average - os: "linux" - - name: used_swap - link: https://github.com/netdata/netdata/blob/master/health/health.d/swap.conf - metric: system.swap - info: swap memory utilization - os: "linux freebsd" - - name: 1m_ipv4_tcp_resets_sent - link: https://github.com/netdata/netdata/blob/master/health/health.d/tcp_resets.conf - metric: ipv4.tcphandshake - info: average number of sent TCP RESETS over the last minute - os: "linux" - - name: 10s_ipv4_tcp_resets_sent - link: https://github.com/netdata/netdata/blob/master/health/health.d/tcp_resets.conf - metric: ipv4.tcphandshake - info: average number of sent TCP RESETS over the last 10 seconds. This can indicate a port scan, or that a service running on this host has crashed. Netdata will not send a clear notification for this alarm. - os: "linux" - - name: 1m_ipv4_tcp_resets_received - link: https://github.com/netdata/netdata/blob/master/health/health.d/tcp_resets.conf - metric: ipv4.tcphandshake - info: average number of received TCP RESETS over the last minute - os: "linux freebsd" - - name: 10s_ipv4_tcp_resets_received - link: https://github.com/netdata/netdata/blob/master/health/health.d/tcp_resets.conf - metric: ipv4.tcphandshake - info: average number of received TCP RESETS over the last 10 seconds. This can be an indication that a service this host needs has crashed. Netdata will not send a clear notification for this alarm. - os: "linux freebsd" - - name: 1m_ipv4_udp_receive_buffer_errors - link: https://github.com/netdata/netdata/blob/master/health/health.d/udp_errors.conf - metric: ipv4.udperrors - info: average number of UDP receive buffer errors over the last minute - os: "linux freebsd" - - name: 1m_ipv4_udp_send_buffer_errors - link: https://github.com/netdata/netdata/blob/master/health/health.d/udp_errors.conf - metric: ipv4.udperrors - info: average number of UDP send buffer errors over the last minute - os: "linux" - metrics: - folding: - title: Metrics - enabled: false - description: "" - availability: [] - scopes: - - name: global - description: "" - labels: [] - metrics: - name: system.load description: System Load Average unit: "load" @@ -271,7 +346,7 @@ modules: - name: load1 - name: load5 - name: load15 - - name: system.swap + - name: mem.swap description: System Swap unit: "MiB" chart_type: stacked @@ -531,147 +606,13 @@ modules: chart_type: line dimensions: - name: uptime - - meta: - plugin_name: macos.plugin - module_name: iokit - monitored_instance: - name: macos iokit - link: '' - categories: [] - icon_filename: '' - related_resources: - integrations: - list: [] - info_provided_to_referring_integrations: - description: '' - keywords: [] - most_popular: false - overview: - data_collection: - metrics_description: '' - method_description: '' - supported_platforms: - include: [] - exclude: [] - multi-instance: true - additional_permissions: - description: '' - default_behavior: - auto_detection: - description: '' - limits: - description: '' - performance_impact: - description: '' - setup: - prerequisites: - list: [] - configuration: - file: - name: '' - description: '' - options: - description: '' - folding: - title: '' - enabled: true - list: [] - examples: - folding: - enabled: true - title: '' - list: [] - troubleshooting: - problems: - list: [] - alerts: - - name: 10min_disk_utilization - link: https://github.com/netdata/netdata/blob/master/health/health.d/disks.conf - metric: disk.util - info: average percentage of time ${label:device} disk was busy over the last 10 minutes - os: "linux freebsd" - - name: disk_space_usage - link: https://github.com/netdata/netdata/blob/master/health/health.d/disks.conf - metric: disk.space - info: disk ${label:mount_point} space utilization - os: "linux freebsd" - - name: disk_inode_usage - link: https://github.com/netdata/netdata/blob/master/health/health.d/disks.conf - metric: disk.inodes - info: disk ${label:mount_point} inode utilization - os: "linux freebsd" - - name: interface_speed - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.net - info: network interface ${label:device} current speed - os: "*" - - name: 1m_received_traffic_overflow - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.net - info: average inbound utilization for the network interface ${label:device} over the last minute - os: "linux" - - name: 1m_sent_traffic_overflow - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.net - info: average outbound utilization for the network interface ${label:device} over the last minute - os: "linux" - - name: inbound_packets_dropped_ratio - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.packets - info: ratio of inbound dropped packets for the network interface ${label:device} over the last 10 minutes - os: "linux" - - name: outbound_packets_dropped_ratio - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.packets - info: ratio of outbound dropped packets for the network interface ${label:device} over the last 10 minutes - os: "linux" - - name: wifi_inbound_packets_dropped_ratio - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.packets - info: ratio of inbound dropped packets for the network interface ${label:device} over the last 10 minutes - os: "linux" - - name: wifi_outbound_packets_dropped_ratio - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.packets - info: ratio of outbound dropped packets for the network interface ${label:device} over the last 10 minutes - os: "linux" - - name: 1m_received_packets_rate - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.packets - info: average number of packets received by the network interface ${label:device} over the last minute - os: "linux freebsd" - - name: 10s_received_packets_storm - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.packets - info: ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute - os: "linux freebsd" - - name: interface_inbound_errors - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.errors - info: number of inbound errors for the network interface ${label:device} in the last 10 minutes - os: "freebsd" - - name: interface_outbound_errors - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.errors - info: number of outbound errors for the network interface ${label:device} in the last 10 minutes - os: "freebsd" - - name: inbound_packets_dropped - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.drops - info: number of inbound dropped packets for the network interface ${label:device} in the last 10 minutes - os: "linux" - - name: outbound_packets_dropped - link: https://github.com/netdata/netdata/blob/master/health/health.d/net.conf - metric: net.drops - info: number of outbound dropped packets for the network interface ${label:device} in the last 10 minutes - os: "linux" - metrics: - folding: - title: Metrics - enabled: false - description: "" - availability: [] - scopes: + - name: system.io + description: Disk I/O + unit: "KiB/s" + chart_type: area + dimensions: + - name: in + - name: out - name: disk description: "" labels: [] @@ -723,17 +664,6 @@ modules: chart_type: line dimensions: - name: svctm - - name: global - description: "" - labels: [] - metrics: - - name: system.io - description: Disk I/O - unit: "KiB/s" - chart_type: area - dimensions: - - name: in - - name: out - name: mount point description: "" labels: [] |