Sensor modules

Module cpuid: processor type and cache information for ix86

This module provides CPU type and cache information for ix86-compatible processors. Support for the cpuid instruction is required. Per-processor information on SMP systems requires the Linux cpuid kernel driver.

List of supported metrics: host.cpu.l1dcache, host.cpu.l1icache, host.cpu.l2cache, host.cpu.l3cache, host.cpu.type

Module darwin: host sensor for Darwin

This module provides information about machines using the Darwin (OS-X) operating system.

The following information are provided:

  • CPU number and type

  • Memory and swap size

  • Network interface statistics

  • Boot time

List of supported metrics: host.cpu.number, host.cpu.frequency, host.cpu.l1dcache, host.cpu.l1icache, host.cpu.l2cache, host.cpu.l3cache, host.cpu.type, host.mem.size, host.net.recv.byte, host.net.recv.packet, host.net.recv.error, host.net.recv.drop, host.net.send.byte, host.net.send.packet, host.net.send.error, host.net.collision, host.net.total.byte, host.net.total.packet, host.net.total.error, host.os.boottime, host.swap.size

Module gtop: retrieve information through the libgtop2 library

This module makes information provided by the libgtop2 monitoring library available in Mercury.

The following information are provided (if the host operating system supports it):

  • Load average

  • CPU number, status and usage

  • Memory size and usage

  • Swap size and usage

  • Network interface statistics

List of supported metrics (not everything is available on every operating system): host.loadavg, host.cpu.number, host.cpu.online, host.cpu.clocktick, host.cpu.usage, host.cpu.user, host.cpu.nice, host.cpu.system, host.cpu.idle, host.mem.size, host.mem.free, host.swap.size, host.swap.free, host.swap.in, host.swap.out, host.net.recv.byte, host.net.recv.packet, host.net.recv.error, host.net.send.byte, host.net.send.packet, host.net.send.error, host.net.collision, host.net.total.byte, host.net.total.packet, host.net.total.error

Module irix: host sensor for IRIX

This module provides information about machines running IRIX 6.5.

The following information are provided:

  • Load average

  • CPU number, status and usage

  • List of mounted filesystems

  • Network interface statistics

  • Operating system name and version

  • Swap size and usage

List of supported metrics: host.loadavg, host.cpu.number, host.cpu.online, host.cpu.available, host.cpu.indexes, host.cpu.state, host.cpu.frequency, host.cpu.usage, host.cpu.user, host.cpu.nice, host.cpu.system, host.cpu.iowait, host.cpu.idle, host.cpu.irq, host.fs.mounted, host.mem.size, host.mem.free, host.mem.shared, host.mem.buffers, host.mem.cached, host.net.recv.byte, host.net.recv.packet, host.net.recv.error, host.net.recv.drop, host.net.send.byte, host.net.send.packet, host.net.send.error, host.net.collision, host.net.total.byte, host.net.total.packet, host.net.total.error, host.os.name, host.os.release, host.os.version, host.os.machine, host.swap.size, host.swap.free, host.swap.in, host.swap.out

Module linux: host sensor for Linux

This module provides host information for Linux. The module takes most information from the /proc file system.

The following information are provided:

  • Load average

  • Number of existing and running processes

  • CPU usage information (combined and per-cpu counters)

  • Known disks, partitions, and I/O utilization

  • List of mounted file systems

  • Memory and swap usage

  • Network statistics

The module supports the following configuration parameters:

  • MinUpdateInterval (double).  Minimum time between two updates of network statistics. When a query for a network metric arrives, all interface statistics are cached. If a new query arrives before the specified time elapses the cached information will be returned.

  • NetScanInterval (double).  Interval between two automatic scans of network interface statistics. If a counter overflows more than once during this period due to high resource usage, the reported metrics become inaccurate.

  • NetDataSource (string).  Source of network statistics. The possible values are procfs to scan the /proc filesystem, or netlink to use the netlink protocol. The preferred source is netlink because it provides instant notification about changes but it may not be available on older kernels. If NetDataSource is set to auto (the default), the module will try to use netlink first, and fall back to /proc if netlink is not available.

  • IgnoreFS (string).  File systems having this type will be ignored when reporting mounted file systems and file system statistics. This option may be specified multiple times.

List of supported metrics: host.loadavg, host.processes.all, host.processes.running, host.os.boottime, host.cpu.number, host.cpu.online, host.cpu.indexes, host.cpu.type, host.cpu.state, host.cpu.frequency, host.cpu.usage, host.cpu.user, host.cpu.nice, host.cpu.system, host.cpu.iowait, host.cpu.idle, host.cpu.irq, host.cpu.softirq, host.disk.disks, host.disk.partitions, host.disk.iostat, host.fs.mounted, host.mem.size, host.mem.free, host.mem.buffers, host.mem.cached, host.swap.size, host.swap.free, host.swap.in, host.swap.out, host.vm.page.in, host.vm.page.out, host.vm.page.fault, host.vm.page.majorfault, host.net.recv.byte, host.net.recv.packet, host.net.recv.error, host.net.recv.drop, host.net.send.byte, host.net.send.packet, host.net.send.error, host.net.send.drop, host.net.collision, host.net.send.carrier, host.net.total.byte, host.net.total.packet, host.net.total.error

Module mach: host sensor for operating systems based on the Mach microcernel

This module provides information for Mach-based operating systems. The module has so far been tested on Tru64, HI-UX and the GNU Hurd.

The following information are provided (if the host operating system supports it):

  • CPU utilization

  • File system usage

  • Memory usage

  • Virtual memory statistics

Access of some or all information may require root privileges.

List of supported metrics (not everything is available on every operating system): host.cpu.number, host.cpu.online, host.cpu.indexes, host.cpu.state, host.cpu.type, host.cpu.usage, host.cpu.user, host.cpu.nice, host.cpu.system, host.cpu.idle, host.cpu.iowait, host.mem.size, host.mem.free, host.vm.page.in, host.vm.page.out, host.vm.page.fault

Module osf: host sensor for OSF/1-based systems

This module provides information for machines running OSF/1-based operating systems (tested on Tru64 and HI-UX).

The following information are provided (if the host operating system supports it):

  • Load average

  • Clock resolution

  • CPU usage

  • Disk utilization

  • Memory and swap size and usage

  • Virtual memory statistics

List of supported metrics (not everything is available on every operating system): host.loadavg, host.cpu.clocktick, host.cpu.idle, host.cpu.iowait, host.cpu.nice, host.cpu.system, host.cpu.usage, host.cpu.user, host.disk.disks, host.disk.iostat, host.mem.size, host.mem.free, host.os.boottime, host.swap.size, host.swap.free, host.vm.page.in, host.vm.page.out, host.vm.page.fault

Module solaris: host sensor for Solaris

This module provides information about machines running Solaris.

The following information are provided (if the host operating system supports it):

  • Load average

  • CPU number, type, state and usage

  • Available disks and their utilization (requires root privileges)

  • List of mounted file systems

  • Memory and swap size and usage

  • Virtual memory statistics

  • Network interface information (IP addresses, hardware type, status etc.)

The module supports the following configuration parameters:

  • MinUpdateInterval (double).  Minimum time between two updates of network statistics. When a query for a network metric arrives, all interface statistics are cached. If a new query arrives before the specified time elapses the cached information will be returned.

List of supported metrics: host.os.boottime, host.loadavg, host.cpu.number, host.cpu.available, host.cpu.online, host.cpu.frequency, host.cpu.indexes, host.cpu.type, host.cpu.state, host.cpu.state_begin, host.cpu.user, host.cpu.nice, host.cpu.system, host.cpu.iowait, host.cpu.idle, host.cpu.usage, host.disk.disks, host.disk.partitions, host.disk.iostat, host.fs.mounted, host.swap.size, host.swap.free, host.swap.in, host.swap.out, host.vm.page.in, host.vm.page.out, host.vm.page.majorfault, host.mem.size, host.mem.free, host.net.recv.byte, host.net.recv.packet, host.net.recv.error, host.net.send.byte, host.net.send.packet, host.net.send.error, host.net.send.carrier, host.net.collision, host.net.total.byte, host.net.total.packet, host.net.total.error

Module tru64: host sensor for Tru64 UNIX

This module provides information for machines running Tru64 UNIX.

The following information are provided (if the host operating system supports it):

  • CPU number, type, state and usage

  • Memory size

  • Network interface statistics

List of supported metrics: host.cpu.available, host.cpu.frequency, host.cpu.indexes, host.cpu.l2cache, host.cpu.number, host.cpu.online, host.cpu.state, host.cpu.type, host.cpu.idle, host.cpu.iowait, host.cpu.nice, host.cpu.system, host.cpu.usage, host.cpu.user, host.mem.size, host.net.recv.byte, host.net.recv.packet, host.net.recv.error, host.net.send.byte, host.net.send.packet, host.net.send.error, host.net.send.carrier, host.net.collision, host.net.total.byte, host.net.total.packet, host.net.total.error

Module unix: host sensor for various UNIX-like systems

This module provides information that is more or less common to several different UNIX-like systems.

The following information are provided (if the host operating system supports it):

  • Clock resolution

  • File system usage

  • Load average

  • Network interface information (IP addresses, hardware type, status etc.)

  • Operating system name and version

List of supported metrics (not everything is available on every operating system): host.cpu.clocktick, host.fs.space, host.fs.inodes, host.fs.mounted, host.loadavg, host.net.interfaces, host.net.mtu, host.net.ifflags, host.net.ifindex, host.net.addr.ipv4, host.net.addr.ipv6, host.net.addr.hwaddr, host.net.hwtype, host.os.boottime, host.os.machine, host.os.name, host.os.release, host.os.version, host.users

Metric comparison table

The following table contains all the metrics supported by the different host sensors.

Note

A metric being marked as supported by a sensor in this table does not neccessarily mean that the metric is really available as it may need certain support from the OS that may or may not be present. This is especially true for the generic sensors like "gtop" or "unix".

Table 1. Metrics supported by the host sensors

 linuxdarwinirixosfsolaristru64machunixcpuidgtop
host.cpu.available  + ++    
host.cpu.clocktick   +   + +
host.cpu.frequency+++ ++    
host.cpu.idle+ +++++  +
host.cpu.indexes+ + +++   
host.cpu.iowait+ +++++   
host.cpu.irq+ +       
host.cpu.l1dcache +      + 
host.cpu.l1icache +      + 
host.cpu.l2cache +   +  + 
host.cpu.l3cache +      + 
host.cpu.nice+ +++++  +
host.cpu.number+++ +++  +
host.cpu.online+ + +++  +
host.cpu.softirq+         
host.cpu.state+ + +++   
host.cpu.state_begin    +     
host.cpu.system+ +++++  +
host.cpu.type++  +++ + 
host.cpu.usage+ +++++  +
host.cpu.user+ +++++  +
host.disk.disks+  ++     
host.disk.iostat+  ++     
host.disk.partitions+   +     
host.fs.inodes       +  
host.fs.mounted+ + +  +  
host.fs.space       +  
host.loadavg+ +++  + +
host.mem.buffers+ +       
host.mem.cached+ +       
host.mem.free+ +++ +  +
host.mem.shared  +       
host.mem.size+++++++  +
host.net.addr.hwaddr       +  
host.net.addr.ipv4       +  
host.net.addr.ipv6       +  
host.net.collision+++ ++   +
host.net.hwtype       +  
host.net.ifflags       +  
host.net.ifindex       +  
host.net.interfaces       +  
host.net.mtu       +  
host.net.recv.byte+++ ++   +
host.net.recv.drop+++       
host.net.recv.error+++ ++   +
host.net.recv.packet+++ ++   +
host.net.send.byte+++ ++   +
host.net.send.carrier+   ++    
host.net.send.drop+         
host.net.send.error+++ ++   +
host.net.send.packet+++ ++   +
host.net.total.byte+++ ++   +
host.net.total.error+++ ++   +
host.net.total.packet+++ ++   +
host.os.boottime++ ++  +  
host.os.machine  +    +  
host.os.name  +    +  
host.os.release  +    +  
host.os.version  +    +  
host.processes.all+         
host.processes.running+         
host.swap.free+ +++    +
host.swap.in+ + +    +
host.swap.out+ + +    +
host.swap.size+++++    +
host.users       +  
host.vm.page.fault+  +  +   
host.vm.page.in+  ++ +   
host.vm.page.majorfault+   +     
host.vm.page.out+  ++ +