MacOS System Metrics Details
Consult the reference for the metrics reported by the System Metrics Source on macOS.
Events generated by the System Metrics Source have metrics metadata to designate dimension and metric fields. The host field contains the hostname, and is included as a dimension in all of them. The collectors include:
In the Source’s configuration modal, you can set the level of detail for each type of metrics:
- Basic enables minimal metrics, averaged or aggregated.
- All enables full, detailed metrics, specified for individual CPUs, interfaces, and so on.
- Custom displays sub-menus and buttons from which you can choose a level of detail (Basic, All, Custom, or Disabled) for each type of event.
- Disabled means that no metrics will be generated.
Basic and Custom have different meanings depending on event type and are described in the following sections.
The tables outline the metrics emitted for each mode (Basic or Custom) and where applicable, the dimensions (to indicate where the metrics are coming from).
System
With System Metrics enabled, Cribl Edge captures CPU load averages, uptime, and count. The Custom option allows you to include process metrics that reflect the numbers of processes in various states.
Metrics for the overall system include the following:
| Name | Description | Type | Dimensions | Mode |
|---|---|---|---|---|
node_uname_info | Labeled system information as provided by the uname system call. | Counter | nodename, release, sysname, version | Basic |
node_cpu_count | The number of CPU cores. | Gauge | nodename, release, sysname, version | Basic |
node_uptime_seconds | System uptime in seconds. | Counter | N/A | Basic |
node_boot_time_seconds | Node boot time in Unix time. | Counter | N/A | Basic |
node_time_seconds | System time in seconds. | Counter | N/A | Basic |
node_load1 | 1m load average. | Gauge | N/A | Basic |
node_load5 | 5m load average. | Gauge | N/A | Basic |
node_load15 | 15m load average. | Gauge | N/A | Basic |
node_processes_state_all | Total number of running processes. | Gauge | N/A | Basic |
node_processes_threads | Total number of threads in the system. | Gauge | N/A | Basic |
CPU
Cribl Edge captures active, user, system, and idle percentages over all CPUs, with options to add per-CPU metrics, a nice breakdown, and raw time counters for each state.
Metrics for CPUs include the following:
| Name | Description | Type | Dimensions | Mode |
|---|---|---|---|---|
node_cpu_percent_active_all | Percent all the CPUs spent in activity. | Gauge | N/A | Basic |
node_cpu_seconds_active_all_total | Seconds all the CPUs spent in activity (excluding idle). | Counter | N/A | Custom: CPU time metrics |
node_cpu_seconds_active_total | Seconds each CPU spent in activity (excluding idle). | Counter | cpu | Custom: Per-CPU metrics and CPU time metrics |
node_cpu_seconds_all_total | Seconds for all CPUs usage. | Counter | mode | Custom: CPU time metrics |
node_cpu_seconds_total | Seconds for each CPU’s usage. | Counter | cpu, mode | Custom: Per-CPU metrics and CPU time metrics |
node_cpu_percent_active | Percent each CPU spent in activity. | Gauge | cpu | Custom: Per-CPU metrics |
node_cpu_percent_all | Percent CPU usage for all CPUs. | Gauge | mode | Custom: Detailed metrics |
node_cpu_percent | Percent CPU usage for each CPU. | Gauge | cpu, mode | Custom: Per-CPU metrics |
- The
Per-CPU metricsoption adds metrics with thecpudimension. - The
Detailed metricsoption addsniceas amodevalue.
Memory
With System Metrics enabled, Cribl Edge captures memory totals, used and available memory, swap usage, and virtual memory statistics derived from macOS. Optionally include detailed memory and vmstat-style breakdowns.
Metrics for memory include the following:
| Name | Description | Type | Dimensions | Mode |
|---|---|---|---|---|
node_memory_total_bytes | Total physical memory in bytes. | Gauge | N/A | Basic |
node_memory_used_bytes | Used memory in bytes. | Gauge | N/A | Basic |
node_memory_used_percent | Percent used memory. | Gauge | N/A | Basic |
node_memory_available_bytes | Available memory in bytes. | Gauge | N/A | Basic |
node_memory_available_percent | Percent memory available. | Gauge | N/A | Basic |
node_memory_internal_bytes | Memory used by the OS kernel and frameworks. | Gauge | N/A | Basic |
node_memory_swap_free_bytes | Free swap in bytes. | Gauge | N/A | Basic |
node_memory_swap_total_bytes | Total swap in bytes. | Gauge | N/A | Basic |
node_memory_swap_used_bytes | Used swap in bytes. | Gauge | N/A | Basic |
node_memory_swapped_in_bytes_total | Total bytes swapped in from disk. | Counter | N/A | Basic |
node_memory_swapped_out_bytes_total | Total bytes swapped out to disk. | Counter | N/A | Basic |
node_vmstat_pgfault | Page faults. | Counter | N/A | Basic |
node_vmstat_pgpgin | Page-in operations. | Counter | N/A | Basic |
node_vmstat_pgpgout | Page-out operations. | Counter | N/A | Basic |
node_vmstat_pswpin | Swap-in operations. | Counter | N/A | Basic |
node_vmstat_pswpout | Swap-out operations. | Counter | N/A | Basic |
node_memory_active_bytes | Active memory in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_memory_inactive_bytes | Inactive memory in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_memory_wired_bytes | Wired memory in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_memory_speculative_bytes | Speculative memory in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_memory_compressed_bytes | Compressed memory in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_memory_purgeable_bytes | Purgeable memory in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_memory_free_bytes | Free memory in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_vmstat_cow_faults | Copy-on-write faults. | Counter | N/A | Custom: Detailed metrics |
node_vmstat_compressions | Memory compressions. | Counter | N/A | Custom: Detailed metrics |
node_vmstat_decompressions | Memory decompressions. | Counter | N/A | Custom: Detailed metrics |
node_vmstat_purges | Memory purges. | Counter | N/A | Custom: Detailed metrics |
Network
With System Metrics enabled, Cribl Edge captures bytes, packets, errors, and multicast counts over all interfaces. The Custom option allows you to filter interfaces and to choose per-interface metrics.
Metrics for networks include the following:
| Name | Description | Type | Dimensions | Mode |
|---|---|---|---|---|
node_network_receive_bytes_all_total | Rolled-up sum of cumulative bytes received on all interfaces. | Counter | N/A | Basic |
node_network_receive_errs_all_total | Rolled-up sum of cumulative receive errors on all interfaces. | Counter | N/A | Basic |
node_network_receive_packets_all_total | Rolled-up sum of cumulative packets received on all interfaces. | Counter | N/A | Basic |
node_network_receive_multicast_all_total | Rolled-up sum of cumulative multicast packets received on all interfaces. | Counter | N/A | Basic |
node_network_transmit_bytes_all_total | Rolled-up sum of cumulative bytes transmitted on all interfaces. | Counter | N/A | Basic |
node_network_transmit_errs_all_total | Rolled-up sum of cumulative transmit errors on all interfaces. | Counter | N/A | Basic |
node_network_transmit_packets_all_total | Rolled-up sum of cumulative packets transmitted on all interfaces. | Counter | N/A | Basic |
node_network_transmit_multicast_all_total | Rolled-up sum of cumulative multicast packets transmitted on all interfaces. | Counter | N/A | Basic |
node_network_receive_bytes_total | Cumulative bytes received on device. | Counter | device | Custom: Per-interface metrics |
node_network_receive_errs_total | Cumulative receive errors on device. | Counter | device | Custom: Per-interface metrics |
node_network_receive_packets_total | Cumulative packets received on device. | Counter | device | Custom: Per-interface metrics |
node_network_receive_multicast_total | Cumulative multicast packets received on device. | Counter | device | Custom: Per-interface metrics |
node_network_transmit_bytes_total | Cumulative bytes transmitted on device. | Counter | device | Custom: Per-interface metrics |
node_network_transmit_errs_total | Cumulative transmit errors on device. | Counter | device | Custom: Per-interface metrics |
node_network_transmit_packets_total | Cumulative packets transmitted on device. | Counter | device | Custom: Per-interface metrics |
node_network_transmit_multicast_total | Cumulative multicast packets transmitted on device. | Counter | device | Custom: Per-interface metrics |
node_network_receive_drop_all_total | Rolled-up sum of cumulative input queue drops on all interfaces. | Counter | N/A | Custom: Detailed metrics |
node_network_receive_drop_total | Cumulative input queue drops on device. | Counter | device | Custom: Detailed metrics and Per-interface metrics |
node_network_transmit_colls_all_total | Rolled-up sum of cumulative output collisions on all interfaces. | Counter | N/A | Custom: Detailed metrics |
node_network_transmit_colls_total | Cumulative output collisions on device. | Counter | device | Custom: Detailed metrics and Per-interface metrics |
node_network_noproto_all_total | Rolled-up sum of cumulative packets received for an unsupported/unknown protocol on all interfaces. | Counter | N/A | Custom: Detailed metrics |
node_network_noproto_total | Cumulative noproto count on device. | Counter | device | Custom: Detailed metrics and Per-interface metrics |
Disk
With System Metrics enabled, Cribl Edge captures disk I/O (reads, writes, and optionally I/O time) and filesystem space usage. The Custom option allows you to filter devices, mountpoint, and filesystem type, and to choose per-device metrics, detailed disk metrics, and inode-related filesystem metrics.
For APFS, aggregate filesystem capacity avoids double-counting volumes that share a storage pool; inode metrics remain per mount.
Metrics for Disk include the following:
| Name | Description | Type | Dimensions | Mode |
|---|---|---|---|---|
node_disk_reads_completed_all_total | Total number of reads completed successfully. | Counter | N/A | Basic |
node_disk_read_bytes_all_total | Total number of bytes read successfully. | Counter | N/A | Basic |
node_disk_writes_completed_all_total | Total number of writes completed successfully. | Counter | N/A | Basic |
node_disk_written_bytes_all_total | Total number of bytes written successfully. | Counter | N/A | Basic |
node_filesystem_size_bytes_all | Filesystem size in bytes. | Gauge | N/A | Basic |
node_filesystem_used_percent_all | Percent filesystem used space. | Gauge | N/A | Basic |
node_filesystem_avail_bytes_all | Filesystem space available to non-root users in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_filesystem_used_bytes_all | Filesystem used space in bytes. | Gauge | N/A | Custom: Detailed metrics |
node_filesystem_files_all | Total file nodes on all tracked filesystems. | Gauge | N/A | Custom: Inode metrics |
node_filesystem_files_free_all | Free file nodes on all tracked filesystems. | Gauge | N/A | Custom: Inode metrics |
node_filesystem_files_used_all | Used file nodes on all tracked filesystems. | Gauge | N/A | Custom: Inode metrics |
node_filesystem_files_used_percent_all | Percent of file nodes in use across all tracked filesystems. | Gauge | N/A | Custom: Detailed metrics and Inode metrics |
node_filesystem_used_bytes | Filesystem used space in bytes per disk. | Gauge | device, fstype, mountpoint | Custom: Per-device metrics and Detailed metrics |
node_filesystem_used_percent | Percent filesystem used per disk. | Gauge | device, fstype, mountpoint | Custom: Per-device metrics |
node_disk_reads_completed_total | Total number of reads completed successfully per disk. | Counter | device | Custom: Per-device metrics |
node_disk_read_bytes_total | Total number of bytes read successfully per disk. | Counter | device | Custom: Per-device metrics |
node_disk_writes_completed_total | Total number of writes completed successfully per disk. | Counter | device | Custom: Per-device metrics |
node_disk_written_bytes_total | Total number of bytes written successfully per disk. | Counter | device | Custom: Per-device metrics |
node_disk_read_time_seconds_all_total | Total time spent on reads. | Counter | N/A | Custom: Detailed metrics |
node_disk_write_time_seconds_all_total | Total time spent on writes. | Counter | N/A | Custom: Detailed metrics |
node_disk_read_time_seconds_total | Time spent on reads per disk. | Counter | device | Custom: Per-device metrics and Detailed metrics |
node_disk_write_time_seconds_total | Time spent on writes per disk. | Counter | device | Custom: Per-device metrics and Detailed metrics |
node_filesystem_size_bytes | Filesystem size in bytes per disk. | Gauge | device, fstype, mountpoint | Custom: Per-device metrics and Detailed metrics |
node_filesystem_avail_bytes | Filesystem space available to non-root users in bytes per disk. | Gauge | device, fstype, mountpoint | Custom: Per-device metrics and Detailed metrics |
node_filesystem_files | Total file nodes per disk. | Gauge | device, fstype, mountpoint | Custom: Per-device metrics, Detailed metrics and Inode metrics |
node_filesystem_files_free | Free file nodes per disk. | Gauge | device, fstype, mountpoint | Custom: Per-device metrics, Detailed metrics and Inode metrics |
node_filesystem_files_used | Used file nodes per disk. | Gauge | device, fstype, mountpoint | Custom: Per-device metrics, Detailed metrics and Inode metrics |
node_filesystem_files_used_percent | Percent of file nodes in use per disk. | Gauge | device, fstype, mountpoint | Custom: Per-device metrics, Detailed metrics and Inode metrics |