Add CPU usage color thresholds

CPU usage had previously not supported the color option.  Add support
for a "degraded" state above which the degraded color is used, and a
higher "bad" state above which the "bad" color is used.  One possible
use for these might be indicating whether one or all cores are
saturated.

Unlike the color settings for other, these are set high enough to be
disabled by default.  This is done because i3status determines CPU
usage over only the last display interval, which means that, a user
with a low refresh rate might see frequent, potentially-annoying color
changes.

diff --git a/i3status.c b/i3status.c
index 19ad5a3ab948078ddcba5981451903e657e82874..54d850f35902aa5a351dda651569a028f1878cf1 100644 (file)
--- a/i3status.c
+++ b/i3status.c
@@ -413,7 +413,10 @@ int main(int argc, char *argv[]) {
 
     cfg_opt_t usage_opts[] = {
         CFG_STR("format", "%usage", CFGF_NONE),
+        CFG_FLOAT("max_threshold", 200, CFGF_NONE),
+        CFG_FLOAT("degraded_threshold", 200, CFGF_NONE),
         CFG_CUSTOM_ALIGN_OPT,
+        CFG_CUSTOM_COLOR_OPTS,
         CFG_CUSTOM_MIN_WIDTH_OPT,
         CFG_CUSTOM_SEPARATOR_OPT,
         CFG_CUSTOM_SEP_BLOCK_WIDTH_OPT,
@@ -726,7 +729,7 @@ int main(int argc, char *argv[]) {
 
             CASE_SEC("cpu_usage") {
                 SEC_OPEN_MAP("cpu_usage");
-                print_cpu_usage(json_gen, buffer, cfg_getstr(sec, "format"));
+                print_cpu_usage(json_gen, buffer, cfg_getstr(sec, "format"), cfg_getfloat(sec, "max_threshold"), cfg_getfloat(sec, "degraded_threshold"));
                 SEC_CLOSE_MAP;
             }
         }

diff --git a/include/i3status.h b/include/i3status.h
index 7e756e227075bcd227813cce59a246f7f7e4487d..b4cf83f8354b0fdfcebd769f6482177e77523c7f 100644 (file)
--- a/include/i3status.h
+++ b/include/i3status.h
@@ -216,7 +216,7 @@ void print_wireless_info(yajl_gen json_gen, char *buffer, const char *interface,
 void print_run_watch(yajl_gen json_gen, char *buffer, const char *title, const char *pidfile, const char *format, const char *format_down);
 void print_path_exists(yajl_gen json_gen, char *buffer, const char *title, const char *path, const char *format, const char *format_down);
 void print_cpu_temperature_info(yajl_gen json_gen, char *buffer, int zone, const char *path, const char *format, int);
-void print_cpu_usage(yajl_gen json_gen, char *buffer, const char *format);
+void print_cpu_usage(yajl_gen json_gen, char *buffer, const char *format, const float max_threshold, const float degraded_threshold);
 void print_eth_info(yajl_gen json_gen, char *buffer, const char *interface, const char *format_up, const char *format_down);
 void print_load(yajl_gen json_gen, char *buffer, const char *format, const float max_threshold);
 void print_volume(yajl_gen json_gen, char *buffer, const char *fmt, const char *fmt_muted, const char *device, const char *mixer, int mixer_idx);

diff --git a/man/i3status.man b/man/i3status.man
index 850848828b0a329f2dffedb755c17094543c91c8..f5baa2feb4cf0c19795be91983740c2805acda4d 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -381,12 +381,25 @@ specified thermal zone is getting too hot. Defaults to 75 degrees C.
 
 === CPU Usage
 
-Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+ (FreeBSD/OpenBSD).
+Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+
+(FreeBSD/OpenBSD).
+
+It is possible to define a max_threshold that will color the load
+value red in case the CPU average over the last interval is getting
+higher than the configured threshold. Defaults to 200 (i.e. off).
+
+It is possible to define a degraded_threshold that will color the load
+value yellow in case the CPU average over the last interval is getting
+higher than the configured threshold.  Defaults to 150 (i.e. off).
 
 *Example order*: +cpu_usage+
 
 *Example format*: +%usage+
 
+*Example max_threshold*: +"200,0"+
+
+*Example degraded_threshold*: +"150,0"+
+
 === Load
 
 Gets the system load (number of processes waiting for CPU time in the last

diff --git a/src/print_cpu_usage.c b/src/print_cpu_usage.c
index adf2d046f2179c74b021f05f7aa8310084316aa4..1753cf53044ea8cd307f00124507211ec695023b 100644 (file)
--- a/src/print_cpu_usage.c
+++ b/src/print_cpu_usage.c
@@ -41,11 +41,12 @@ static int prev_idle = 0;
  * percentage.
  *
  */
-void print_cpu_usage(yajl_gen json_gen, char *buffer, const char *format) {
+void print_cpu_usage(yajl_gen json_gen, char *buffer, const char *format, const float max_threshold, const float degraded_threshold) {
     const char *walk;
     char *outwalk = buffer;
     int curr_user = 0, curr_nice = 0, curr_system = 0, curr_idle = 0, curr_total;
     int diff_idle, diff_total, diff_usage;
+    bool colorful_output = false;
 
 #if defined(LINUX)
     static char statpath[512];
@@ -101,10 +102,21 @@ void print_cpu_usage(yajl_gen json_gen, char *buffer, const char *format) {
             continue;
         }
 
+        if (diff_usage >= max_threshold) {
+            START_COLOR("color_bad");
+            colorful_output = true;
+        } else if (diff_usage >= degraded_threshold) {
+            START_COLOR("color_degraded");
+            colorful_output = true;
+        }
+
         if (BEGINS_WITH(walk + 1, "usage")) {
             outwalk += sprintf(outwalk, "%02d%s", diff_usage, pct_mark);
             walk += strlen("usage");
         }
+
+        if (colorful_output)
+            END_COLOR;
     }
 
     OUTPUT_FULL_TEXT(buffer);