On This Page

Home / Edge/ Reference/MacOS System Metrics Details

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:

NameDescriptionTypeDimensionsMode
node_uname_infoLabeled system information as provided by the uname system call.Counternodename, release, sysname, versionBasic
node_cpu_countThe number of CPU cores.Gaugenodename, release, sysname, versionBasic
node_uptime_secondsSystem uptime in seconds.CounterN/ABasic
node_boot_time_secondsNode boot time in Unix time.CounterN/ABasic
node_time_secondsSystem time in seconds.CounterN/ABasic
node_load11m load average.GaugeN/ABasic
node_load55m load average.GaugeN/ABasic
node_load1515m load average.GaugeN/ABasic
node_processes_state_allTotal number of running processes.GaugeN/ABasic
node_processes_threadsTotal number of threads in the system.GaugeN/ABasic

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:

NameDescriptionTypeDimensionsMode
node_cpu_percent_active_allPercent all the CPUs spent in activity.GaugeN/ABasic
node_cpu_seconds_active_all_totalSeconds all the CPUs spent in activity (excluding idle).CounterN/ACustom: CPU time metrics
node_cpu_seconds_active_totalSeconds each CPU spent in activity (excluding idle).CountercpuCustom: Per-CPU metrics and CPU time metrics
node_cpu_seconds_all_totalSeconds for all CPUs usage.CountermodeCustom: CPU time metrics
node_cpu_seconds_totalSeconds for each CPU’s usage.Countercpu, modeCustom: Per-CPU metrics and CPU time metrics
node_cpu_percent_activePercent each CPU spent in activity.GaugecpuCustom: Per-CPU metrics
node_cpu_percent_allPercent CPU usage for all CPUs.GaugemodeCustom: Detailed metrics
node_cpu_percentPercent CPU usage for each CPU.Gaugecpu, modeCustom: Per-CPU metrics
  • The Per-CPU metrics option adds metrics with the cpu dimension.
  • The Detailed metrics option adds nice as a mode value.

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:

NameDescriptionTypeDimensionsMode
node_memory_total_bytesTotal physical memory in bytes.GaugeN/ABasic
node_memory_used_bytesUsed memory in bytes.GaugeN/ABasic
node_memory_used_percentPercent used memory.GaugeN/ABasic
node_memory_available_bytesAvailable memory in bytes.GaugeN/ABasic
node_memory_available_percentPercent memory available.GaugeN/ABasic
node_memory_internal_bytesMemory used by the OS kernel and frameworks.GaugeN/ABasic
node_memory_swap_free_bytesFree swap in bytes.GaugeN/ABasic
node_memory_swap_total_bytesTotal swap in bytes.GaugeN/ABasic
node_memory_swap_used_bytesUsed swap in bytes.GaugeN/ABasic
node_memory_swapped_in_bytes_totalTotal bytes swapped in from disk.CounterN/ABasic
node_memory_swapped_out_bytes_totalTotal bytes swapped out to disk.CounterN/ABasic
node_vmstat_pgfaultPage faults.CounterN/ABasic
node_vmstat_pgpginPage-in operations.CounterN/ABasic
node_vmstat_pgpgoutPage-out operations.CounterN/ABasic
node_vmstat_pswpinSwap-in operations.CounterN/ABasic
node_vmstat_pswpoutSwap-out operations.CounterN/ABasic
node_memory_active_bytesActive memory in bytes.GaugeN/ACustom: Detailed metrics
node_memory_inactive_bytesInactive memory in bytes.GaugeN/ACustom: Detailed metrics
node_memory_wired_bytesWired memory in bytes.GaugeN/ACustom: Detailed metrics
node_memory_speculative_bytesSpeculative memory in bytes.GaugeN/ACustom: Detailed metrics
node_memory_compressed_bytesCompressed memory in bytes.GaugeN/ACustom: Detailed metrics
node_memory_purgeable_bytesPurgeable memory in bytes.GaugeN/ACustom: Detailed metrics
node_memory_free_bytesFree memory in bytes.GaugeN/ACustom: Detailed metrics
node_vmstat_cow_faultsCopy-on-write faults.CounterN/ACustom: Detailed metrics
node_vmstat_compressionsMemory compressions.CounterN/ACustom: Detailed metrics
node_vmstat_decompressionsMemory decompressions.CounterN/ACustom: Detailed metrics
node_vmstat_purgesMemory purges.CounterN/ACustom: 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:

NameDescriptionTypeDimensionsMode
node_network_receive_bytes_all_totalRolled-up sum of cumulative bytes received on all interfaces.CounterN/ABasic
node_network_receive_errs_all_totalRolled-up sum of cumulative receive errors on all interfaces.CounterN/ABasic
node_network_receive_packets_all_totalRolled-up sum of cumulative packets received on all interfaces.CounterN/ABasic
node_network_receive_multicast_all_totalRolled-up sum of cumulative multicast packets received on all interfaces.CounterN/ABasic
node_network_transmit_bytes_all_totalRolled-up sum of cumulative bytes transmitted on all interfaces.CounterN/ABasic
node_network_transmit_errs_all_totalRolled-up sum of cumulative transmit errors on all interfaces.CounterN/ABasic
node_network_transmit_packets_all_totalRolled-up sum of cumulative packets transmitted on all interfaces.CounterN/ABasic
node_network_transmit_multicast_all_totalRolled-up sum of cumulative multicast packets transmitted on all interfaces.CounterN/ABasic
node_network_receive_bytes_totalCumulative bytes received on device.CounterdeviceCustom: Per-interface metrics
node_network_receive_errs_totalCumulative receive errors on device.CounterdeviceCustom: Per-interface metrics
node_network_receive_packets_totalCumulative packets received on device.CounterdeviceCustom: Per-interface metrics
node_network_receive_multicast_totalCumulative multicast packets received on device.CounterdeviceCustom: Per-interface metrics
node_network_transmit_bytes_totalCumulative bytes transmitted on device.CounterdeviceCustom: Per-interface metrics
node_network_transmit_errs_totalCumulative transmit errors on device.CounterdeviceCustom: Per-interface metrics
node_network_transmit_packets_totalCumulative packets transmitted on device.CounterdeviceCustom: Per-interface metrics
node_network_transmit_multicast_totalCumulative multicast packets transmitted on device.CounterdeviceCustom: Per-interface metrics
node_network_receive_drop_all_totalRolled-up sum of cumulative input queue drops on all interfaces.CounterN/ACustom: Detailed metrics
node_network_receive_drop_totalCumulative input queue drops on device.CounterdeviceCustom: Detailed metrics and Per-interface metrics
node_network_transmit_colls_all_totalRolled-up sum of cumulative output collisions on all interfaces.CounterN/ACustom: Detailed metrics
node_network_transmit_colls_totalCumulative output collisions on device.CounterdeviceCustom: Detailed metrics and Per-interface metrics
node_network_noproto_all_totalRolled-up sum of cumulative packets received for an unsupported/unknown protocol on all interfaces.CounterN/ACustom: Detailed metrics
node_network_noproto_totalCumulative noproto count on device.CounterdeviceCustom: 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:

NameDescriptionTypeDimensionsMode
node_disk_reads_completed_all_totalTotal number of reads completed successfully.CounterN/ABasic
node_disk_read_bytes_all_totalTotal number of bytes read successfully.CounterN/ABasic
node_disk_writes_completed_all_totalTotal number of writes completed successfully.CounterN/ABasic
node_disk_written_bytes_all_totalTotal number of bytes written successfully.CounterN/ABasic
node_filesystem_size_bytes_allFilesystem size in bytes.GaugeN/ABasic
node_filesystem_used_percent_allPercent filesystem used space.GaugeN/ABasic
node_filesystem_avail_bytes_allFilesystem space available to non-root users in bytes.GaugeN/ACustom: Detailed metrics
node_filesystem_used_bytes_allFilesystem used space in bytes.GaugeN/ACustom: Detailed metrics
node_filesystem_files_allTotal file nodes on all tracked filesystems.GaugeN/ACustom: Inode metrics
node_filesystem_files_free_allFree file nodes on all tracked filesystems.GaugeN/ACustom: Inode metrics
node_filesystem_files_used_allUsed file nodes on all tracked filesystems.GaugeN/ACustom: Inode metrics
node_filesystem_files_used_percent_allPercent of file nodes in use across all tracked filesystems.GaugeN/ACustom: Detailed metrics and Inode metrics
node_filesystem_used_bytesFilesystem used space in bytes per disk.Gaugedevice, fstype, mountpointCustom: Per-device metrics and Detailed metrics
node_filesystem_used_percentPercent filesystem used per disk.Gaugedevice, fstype, mountpointCustom: Per-device metrics
node_disk_reads_completed_totalTotal number of reads completed successfully per disk.CounterdeviceCustom: Per-device metrics
node_disk_read_bytes_totalTotal number of bytes read successfully per disk.CounterdeviceCustom: Per-device metrics
node_disk_writes_completed_totalTotal number of writes completed successfully per disk.CounterdeviceCustom: Per-device metrics
node_disk_written_bytes_totalTotal number of bytes written successfully per disk.CounterdeviceCustom: Per-device metrics
node_disk_read_time_seconds_all_totalTotal time spent on reads.CounterN/ACustom: Detailed metrics
node_disk_write_time_seconds_all_totalTotal time spent on writes.CounterN/ACustom: Detailed metrics
node_disk_read_time_seconds_totalTime spent on reads per disk.CounterdeviceCustom: Per-device metrics and Detailed metrics
node_disk_write_time_seconds_totalTime spent on writes per disk.CounterdeviceCustom: Per-device metrics and Detailed metrics
node_filesystem_size_bytesFilesystem size in bytes per disk.Gaugedevice, fstype, mountpointCustom: Per-device metrics and Detailed metrics
node_filesystem_avail_bytesFilesystem space available to non-root users in bytes per disk.Gaugedevice, fstype, mountpointCustom: Per-device metrics and Detailed metrics
node_filesystem_filesTotal file nodes per disk.Gaugedevice, fstype, mountpointCustom: Per-device metrics, Detailed metrics and Inode metrics
node_filesystem_files_freeFree file nodes per disk.Gaugedevice, fstype, mountpointCustom: Per-device metrics, Detailed metrics and Inode metrics
node_filesystem_files_usedUsed file nodes per disk.Gaugedevice, fstype, mountpointCustom: Per-device metrics, Detailed metrics and Inode metrics
node_filesystem_files_used_percentPercent of file nodes in use per disk.Gaugedevice, fstype, mountpointCustom: Per-device metrics, Detailed metrics and Inode metrics