Skip to content

Modules

A module is a check type (cpu, http, disk, …). A check is one configured instance of a module - a checks: entry with a module, a name, and module-specific conf: fields:

checks:
  - module: cpu
    name: cpu_local
    conf:
      threshold: 90

Every check also supports the fields listed in Configuration (enable, severity_max, alert_delay, frequency, reverse_severity, root_required, tags) regardless of module - not repeated on each page below. cmt listmodules lists every registered module; cmt doc <module> prints the same reference as its page here, straight from the running binary.

Module Use case
cpu host-wide CPU usage
memory host RAM usage
disk filesystem capacity for one path
mount is a filesystem mounted at path
swap host swap usage
load load average vs. CPU count
boottime time since last reboot
process is a named process running
folder file/dir counts, size, age, per-file targets
socket generic TCP reachability
ping ICMP echo reachability/RTT
http HTTP(S) endpoint check
cert TLS certificate expiry/subject
mysql MySQL/MariaDB replication health and load
send inject a piped value as a check result