README.md



    1 # README
    2 
    3 Cmon is a simple system resource monitoring program intended to assist in
    4 analyzing the gap between used system resources and available system resources.
    5 
    6 The `cmon` program is a one-shot program (it runs, measures, and exits) at this
    7 time. To gather metrics over time, schedule it via cron, systemd timers, or a
    8 script that runs is frequently. It stores relevant metrics in a colon delimited
    9 file at `/tmp/cmon.status`.
   10 
   11 **NOTE**: For highly ephemeral systems, be sure to ship the status file off of
   12 the system frequently to ensure when the system is deleted the metrics are
   13 persisted externally.