systemstatsmonitor

README

System Stats Monitor

System Stats Monitor is a problem daemon in node problem detector. It collects pre-defined health-related metrics from different system components. Each component may allow further detailed configurations.

Currently supported components are:

• cpu
• disk
• host
• memory

See example config file here.

By setting the metricsConfigs field and displayName field (example), you can specify the list of metrics to be collected, and their display names on the Prometheus scaping endpoint.

Detailed Configuration Options

Global Configurations

Data collection period can be specified globally in the config file, see invokeInterval at the example.

CPU

Below metrics are collected from cpu component:

• cpu_runnable_task_count: The average number of runnable tasks in the run-queue during the last minute. Collected from /proc/loadavg.
• cpu_usage_time: CPU usage, in seconds. The CPU state for the corresponding usage is reported under the state metric label (e.g. user, nice, system...).
• cpu_load_1m: CPU load average over the last 1 minute. Collected from /proc/loadavg.
• cpu_load_5m: CPU load average over the last 5 minutes. Collected from /proc/loadavg.
• cpu_load_15m: CPU load average over the last 15 minutes. Collected from /proc/loadavg.
• system/processes_total: Number of forks since boot.
• system/procs_running: Number of processes currently running.
• system/procs_blocked: Number of processes currently blocked.
• system/interrupts_total: Total number of interrupts serviced (cumulative).
• system/cpu_stats: Cumulative time each cpu spent in various stages. Collected from /proc/stats. Has a label for cpu and stage.

Disk

Below metrics are collected from disk component:

• disk_io_time: # of milliseconds spent doing I/Os on this device
• disk_weighted_io: # of milliseconds spent doing I/Os on this device
• disk_avg_queue_len: average # of requests that was waiting in queue or being serviced during the last invokeInterval
• disk_operation_count: # of reads/writes completed
• disk_merged_operation_count: # of reads/writes merged
• disk_operation_bytes_count: # of Bytes used for reads/writes on this device
• disk_operation_time: # of milliseconds spent reading/writing
• disk_bytes_used: Disk usage in Bytes. The usage state is reported under the state metric label (e.g. used, free). Summing values of all states yields the disk size. FSType and MountOptions are also reported as additional information.

The name of the disk block device is reported in the device_name metric label (e.g. sda).

For the metrics that separates read/write operations, the IO direction is reported in the direction metric label (e.g. read, write).

And a few other options:

• includeRootBlk: When set to true, add all block devices that's not a slave or holder device to the list of disks that System Stats Monitor collects metrics from. When set to false, do not modify the list of disks that System Stats Monitor collects metrics from.
• includeAllAttachedBlk: When set to true, add all currently attached block devices to the list of disks that System Stats Monitor collects metrics from. When set to false, do not modify the list of disks that System Stats Monitor collects metrics from.
• lsblkTimeout: System Stats Monitor uses lsblk to retrieve block devices information. This option sets the timeout for calling lsblk commands.

Host

Below metrics are collected from host component:

• host_uptime: The uptime of the operating system, in seconds. OS version and kernel versions are reported under the os_version and kernel_version metric label (e.g. cos 73-11647.217.0, 4.14.127+).

Memory

Below metrics are collected from memory component:

• memory_bytes_used: Memory usage by each memory state, in Bytes. The memory state is reported under the state metric label (e.g. free, used, buffered...). Summing values of all states yields the total memory of the node.
• memory_anonymous_used: Anonymous memory usage, in Bytes. Memory usage state is reported under the state metric label (e.g. active, inactive). active means the memory has been used more recently and usually not swapped until needed. Summing values of all states yields the total anonymous memory used.
• memory_page_cache_used: Page cache memory usage, in Bytes. Memory usage state is reported under the state metric label (e.g. active, inactive). active means the memory has been used more recently and usually not reclaimed until needed. Summing values of all states yields the total page cache memory used.
• memory_unevictable_used: Unevictable memory usage, in Bytes.
• memory_dirty_used: Dirty pages usage, in Bytes. Memory usage state is reported under the state metric label (e.g. dirty, writeback). dirty means the memory is waiting to be written back to disk, and writeback means the memory is actively being written back to disk.

OS features

The guest OS features such as KTD kernel, GPU support are collected. Below are the OS features collected:

• KTD: Enabled, if KTD feature is enabled on OS
• UnifiedCgroupHierarchy: Enabled, if Unified hierarchy is enabled on OS.
• KernelModuleIntegrity: Enabled, if load pin security is enabled and modules are signed.
• GPUSupport: Enabled, if OS has GPU drivers installed like nvidia.
• UnknownModules: Enabled, if the OS has third party kernel modules installed. UnknownModules are derived from the /proc/modules compared with the known-modules.json.

And an option: knownModulesConfigPath: The path to the file that contains the known modules(default modules) can be set. By default, the path is set to guestosconfig/known-modules.json (relative to the system-stats-monitor config path).

IP Stats (Net Dev)

Below metrics are collected from net component:

• net/rx_bytes: Cumulative count of bytes received.
• net/rx_packets: Cumulative count of packets received.
• net/rx_errors: Cumulative count of receive errors encountered.
• net/rx_dropped: Cumulative count of packets dropped while receiving.
• net/rx_fifo: Cumulative count of FIFO buffer errors.
• net/rx_frame: Cumulative count of packet framing errors.
• net/rx_compressed: Cumulative count of compressed packets received by the device driver.
• net/rx_multicast: Cumulative count of multicast frames received by the device driver.
• net/tx_bytes: Cumulative count of bytes transmitted.
• net/tx_packets: Cumulative count of packets transmitted.
• net/tx_errors: Cumulative count of transmit errors encountered.
• net/tx_dropped: Cumulative count of packets dropped while transmitting.
• net/tx_fifo: Cumulative count of FIFO buffer errors.
• net/tx_collisions: Cumulative count of collisions detected on the interface.
• net/tx_carrier: Cumulative count of carrier losses detected by the device driver.
• net/tx_compressed: Cumulative count of compressed packets transmitted by the device driver.

All of the above have interface_name label for the net interface.

Windows Support

NPD has preliminary support for system stats monitor. The following modules are supported:

• CPU - Idle, System, and User metrics.
• Memory - Used and available.
• Disk - Space used and free.
• Uptime - within kernel version and product name.

All the data is currently retried from the github.com/shirou/gopsutil library. Any data parsed directly from /proc from Linux is not supported on Windows. There will be later integration to use WMI (Windows Management Instrumentation) to gather node metrics.

Documentation

Index

• Constants
• func NewCPUCollectorOrDie(cpuConfig *ssmtypes.CPUStatsConfig) *cpuCollector
• func NewDiskCollectorOrDie(diskConfig *ssmtypes.DiskStatsConfig) *diskCollector
• func NewHostCollectorOrDie(hostConfig *ssmtypes.HostStatsConfig) *hostCollector
• func NewMemoryCollectorOrDie(memoryConfig *ssmtypes.MemoryStatsConfig) *memoryCollector
• func NewNetCollectorOrDie(netConfig *ssmtypes.NetStatsConfig) *netCollector
• func NewOsFeatureCollectorOrDie(osFeatureConfig *ssmtypes.OSFeatureStatsConfig) *osFeatureCollector
• func NewSystemStatsMonitorOrDie(configPath string) types.Monitor

Constants

const SystemStatsMonitorName = "system-stats-monitor"

Functions

func NewCPUCollectorOrDie

func NewCPUCollectorOrDie(cpuConfig *ssmtypes.CPUStatsConfig) *cpuCollector

func NewDiskCollectorOrDie

func NewDiskCollectorOrDie(diskConfig *ssmtypes.DiskStatsConfig) *diskCollector

func NewHostCollectorOrDie

func NewHostCollectorOrDie(hostConfig *ssmtypes.HostStatsConfig) *hostCollector

func NewMemoryCollectorOrDie

func NewMemoryCollectorOrDie(memoryConfig *ssmtypes.MemoryStatsConfig) *memoryCollector

func NewNetCollectorOrDie

func NewNetCollectorOrDie(netConfig *ssmtypes.NetStatsConfig) *netCollector

func NewOsFeatureCollectorOrDie

func NewOsFeatureCollectorOrDie(osFeatureConfig *ssmtypes.OSFeatureStatsConfig) *osFeatureCollector

func NewSystemStatsMonitorOrDie

func NewSystemStatsMonitorOrDie(configPath string) types.Monitor

NewSystemStatsMonitorOrDie creates a system stats monitor.