add more specificity to describe color_degraded and color_bad

This commit is contained in:
Mohammed Ismail Ansari 2020-03-29 18:03:51 -05:00 committed by GitHub
parent 3374e1605d
commit 87d3981dd4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -363,7 +363,7 @@ your system. The first occurrence of %d gets replaced with the battery number,
but you can just hard-code a path as well. but you can just hard-code a path as well.
It is possible to define a low_threshold that causes the battery text to be It is possible to define a low_threshold that causes the battery text to be
colored red. The low_threshold type can be of threshold_type "time" or colored color_bad. The low_threshold type can be of threshold_type "time" or
"percentage". So, if you configure low_threshold to 10 and threshold_type to "percentage". So, if you configure low_threshold to 10 and threshold_type to
"time", and your battery lasts another 9 minutes, it will be colored red. "time", and your battery lasts another 9 minutes, it will be colored red.
@ -428,14 +428,14 @@ Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+
(FreeBSD/OpenBSD). (FreeBSD/OpenBSD).
It is possible to define a max_threshold that will color the load 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 value with color_bad in case the CPU average over the last interval is getting
higher than the configured threshold. Defaults to 95. The output higher than the configured threshold. Defaults to 95. The output
format when above max_threshold can be customized with format when above max_threshold can be customized with
format_above_threshold. format_above_threshold.
It is possible to define a degraded_threshold that will color the load 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 value with color_degraded in case the CPU average over the last interval is
higher than the configured threshold. Defaults to 90. The output format getting higher than the configured threshold. Defaults to 90. The output format
when above degraded threshold can be customized with when above degraded threshold can be customized with
format_above_degraded_threshold. format_above_degraded_threshold.
@ -464,11 +464,11 @@ available. These will print human readable values. It's also possible to prefix
the placeholders with +percentage_+ to get a value in percent. the placeholders with +percentage_+ to get a value in percent.
It's possible to define a +threshold_degraded+ and a +threshold_critical+ to It's possible to define a +threshold_degraded+ and a +threshold_critical+ to
color the status bar output in yellow or red, if the available memory falls color the status bar output in color_degraded or color_bad, if the available
below the given threshold. Possible values of the threshold can be any integer, memory falls below the given threshold. Possible values of the threshold can be
suffixed with an iec symbol (+T+, +G+, +M+, +K+). Alternatively, the integer any integer, suffixed with an iec symbol (+T+, +G+, +M+, +K+). Alternatively,
can be suffixed by a percent sign, which then rets evaluated relatively to the integer can be suffixed by a percent sign, which then rets evaluated
total memory. relatively to total memory.
If the +format_degraded+ parameter is given and either the critical or the If the +format_degraded+ parameter is given and either the critical or the
degraded threshold applies, +format_degraded+ will get used as format string. degraded threshold applies, +format_degraded+ will get used as format string.
@ -510,7 +510,7 @@ methods to distinguish the actually used memory.
Gets the system load (number of processes waiting for CPU time in the last Gets the system load (number of processes waiting for CPU time in the last
1, 5 and 15 minutes). It is possible to define a max_threshold that will 1, 5 and 15 minutes). It is possible to define a max_threshold that will
color the load value red in case the load average of the last minute is color the load value color_bad in case the load average of the last minute is
getting higher than the configured threshold. Defaults to 5. The output getting higher than the configured threshold. Defaults to 5. The output
format when above max_threshold can be customized with format when above max_threshold can be customized with
format_above_threshold. format_above_threshold.