Warn state for CPU, Memory, Filesystem and Battery modules #2199

quandangv · 2020-10-09T09:02:44Z

This is an item in the todo list from the Module State Machines project, and was requested in #570 and #956. The idea is that the modules that monitor system resources will display different labels and animations when that resource requires attention (battery low, high temperature, high cpu/memory usage).

The warn state would work like that of the temperature module. The condition to activate the warn states are as follow:

Memory module: percentage of memory used >= warn-percentage
CPU module: total percentage of all cores >= warn-percentage
Filesystem module: the filesystem is mounted and percentage of used space >= warn-percentage
Battery module: the charge percentage >= low-at

Release Notes:

This adds format-warn and label-warn to the memory, cpu and fs module and format-low and label-low to the battery module.

It also slightly changes how the ramps in those modules behave. The ramps are bounded by these warn thresholds and, the same as the temperature module, the first and last ramp elements are responsible for everything <= the lower bound or >= the upper bound. Before, the ramp generally went from 0 to 100 and the first and last ramp elements covered the same share inside the range as all other ramp elements as well as everything outside the range.

These two changes in behavior partially cancel each other out, so the change in behavior in existing configs will be barely noticeable.

It also adds the following:

battery: animation-low, low-at = 10
cpu: warn-percentage = 80
fs: warn-percentage = 90
memory: warn-percentage = 90

/Release Notes

Example configuration:

[module/cpu]
type = internal/cpu

interval = 1
warn-percentage = 80

format = <label>
format-prefix = CPU
format-background = #000
format-foreground = #fff
format-padding = 1
label = " %percentage%%"

format-warn = <label-warn>
format-warn-prefix = CPU
format-warn-background = #fff
format-warn-foreground = #000
format-warn-padding = 2
label-warn = " %percentage%%"

Closes #570
Closes #956

…n temps

…n on other modules

codecov · 2020-10-09T09:07:49Z

Codecov Report

Merging #2199 (006041a) into master (50d8a1b) will increase coverage by 0.18%.
The diff coverage is 7.69%.

@@            Coverage Diff            @@
##           master   #2199      +/-   ##
=========================================
+ Coverage    7.25%   7.44%   +0.18%     
=========================================
  Files         155     156       +1     
  Lines       10594   10678      +84     
=========================================
+ Hits          769     795      +26     
- Misses       9825    9883      +58

Flag	Coverage Δ
unittests	`7.44% <7.69%> (+0.18%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
include/drawtypes/ramp.hpp	`50.00% <ø> (+50.00%)`	⬆️
include/modules/battery.hpp	`0.00% <ø> (ø)`
include/modules/fs.hpp	`0.00% <ø> (ø)`
include/modules/meta/base.hpp	`0.00% <ø> (ø)`
src/modules/battery.cpp	`0.00% <0.00%> (ø)`
src/modules/cpu.cpp	`0.00% <0.00%> (ø)`
src/modules/fs.cpp	`0.00% <0.00%> (ø)`
src/modules/memory.cpp	`0.00% <0.00%> (ø)`
src/modules/meta/base.cpp	`0.00% <0.00%> (ø)`
src/modules/temperature.cpp	`0.00% <0.00%> (ø)`
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 50d8a1b...006041a. Read the comment docs.

quandangv · 2020-10-18T14:12:30Z

This would also provide the feature requested by #1871.

patrick96

Code looks good. Thanks!

I do have some concerns about how this changes existing behavior. Because the thresholds for the new warn states would change how existing configs would display once we are in the warn state.

For example right now, if your CPU is over 80%, it would display whatever is in format and the labels and ramps used there. If we used the same config in this PR, it would now display just the total load percentage.

We generally want people to be able to update without it changing how their bar looks like (at least not in a substantial way). So we can't really have these warning states enabled by default, or we must make sure that they behave exactly the same as the non-warn states by default.

I can think of two solutions to this:

Set the threshold to something that can never be reached. In the battery module, we would set it to anything smaller than 0. For memory, cpu, and fs, we would have to set it to something larger than 100. It has to be strictly smaller than 0 or larger than 100 because both 0% battery and 100% cpu, ram, or storage can be reached and the warn states are activated at those values.
Have an extra boolean flag in each module that is set to true only if the new warn formats were defined in the module config. Only use the warn states if the flag is true.

None of these solutions are pretty unfortunately. Can you think of another way of ensuring that the module doesn't suddenly display something completely different in the warn states?

And just to note, because it also changes module behavior: This PR adds the same changes to the behavior of the first and last ramp elements for the battery, fs, cpu, and memory module as #2197 added for the temperature module.

While this can be considered a breaking change, it just changes the ranges that ramp elements are responsible for a bit. So, the same as for the temperature module, this is probably fine, we just need to make sure to mention it in the changelogs.

src/drawtypes/ramp.cpp

src/modules/cpu.cpp

src/modules/fs.cpp

tests/unit_tests/drawtypes/ramp.cpp

quandangv · 2020-11-30T05:40:11Z

We can create a new fallback tag. The default value for FORMAT_WARN will be this tag, and when module::get_format() is called, we check if FORMAT_WARN have this tag to return DEFAULT_FORMAT instead.

Hide the effect of warn states when unused

quandangv · 2020-11-30T05:57:50Z

Another idea on my mind is that I can write module_formatter::try_get() which will add a format only if it is defined. If we load the warn format using try_get, I can then write module_formatter::has_format() to check if the warn format exist and use the default format when it isn't.

patrick96 · 2020-11-30T11:54:49Z

Another idea on my mind is that I can write module_formatter::try_get() which will add a format only if it is defined. If we load the warn format using try_get, I can then write module_formatter::has_format() to check if the warn format exist and use the default format when it isn't.

I think that is a good idea. 👍

quandangv · 2020-11-30T16:52:32Z

I applied it on all relevant modules.

patrick96

Looks good. Just some minor style changes.

Please also rebase and resolve the merge conflicts.

src/modules/battery.cpp

src/modules/fs.cpp

src/modules/meta/base.cpp

quandangv · 2020-12-01T17:18:55Z

Ok, is it good?

patrick96

Functionality wise, everything works now. There was a small bug in the fs module, but I added a comment for that.

The build currently breaks, I have added comments for all the places that need to be fixed.

There are also some places where you use tabs instead of spaces, I have also added comments for that.

After these changes, I think we can merge this.

src/modules/fs.cpp

src/modules/memory.cpp

src/modules/fs.cpp

src/modules/meta/base.cpp

src/modules/fs.cpp

quandangv · 2020-12-02T04:44:06Z

I think I finally got the indents right.

patrick96

Everything looks good now 🎉

Thanks a lot for all your efforts! 😃

This was a backwards-incompatible change introduced in polybar#2199, however it was caused because `module_formatter.has` throws an exception when the format doesn't exist instead of just returning false. Fixes polybar#2262 Ref polybar#2199

This was a backwards-incompatible change introduced in #2199, however it was caused because `module_formatter.has` throws an exception when the format doesn't exist instead of just returning false. Fixes #2262 Ref #2199

quandangv added 13 commits October 8, 2020 01:56

[Temperature, Ramp] fix wrong icon for temperatures near base and war…

c889ba1

…n temps

[Temperature, Ramp] fix wrong icon for temperatures near base and war…

d51dec0

…n temps

Merge branch 'master' of https://github.com/DRKblade/polybar into master

d6cfc06

Fix minor error

928b798

Added WARN state for cpu module

1546735

Implement WARN state for CPU, Memory modules, working on fs module

46f7b02

Implement WARN state for fs module

1389122

Simplify WARN state implementation for cpu and memory

4c75340

explicitly check percentage in get_by_percentage_with_borders

2603c8c

Merge branch 'master' into warn-state

638da31

Fixed silly error

c229ab4

Merge branch 'master' into warn-state

cc7ab8a

implement warn state on battery module, standardize the implementatio…

b5fd19c

…n on other modules

quandangv marked this pull request as ready for review October 9, 2020 09:52

quandangv added 3 commits October 9, 2020 19:05

minor fixes

7a48de0

Merge branch 'master' into warn-state

8ceb303

fix annoying error

00c5f47

quandangv mentioned this pull request Oct 19, 2020

[Feature Request] Add different formats for memory module depend on used percentage #2141

Closed

quandangv added 2 commits October 21, 2020 01:30

use more intuitive param name

4949e0c

Fix percentage with borders bug

8789882

patrick96 mentioned this pull request Oct 22, 2020

Add support for tokens inside ramp and animation #2225

Closed

patrick96 requested changes Nov 29, 2020

View reviewed changes

src/drawtypes/ramp.cpp Outdated Show resolved Hide resolved

src/modules/cpu.cpp Outdated Show resolved Hide resolved

src/modules/fs.cpp Outdated Show resolved Hide resolved

tests/unit_tests/drawtypes/ramp.cpp Show resolved Hide resolved

Make requested changes

25e3ad7

Hide the effect of warn states when unused

Backward Compat: use no format instead of fallback label

e4e2f2e

patrick96 requested changes Nov 30, 2020

View reviewed changes

src/modules/battery.cpp Outdated Show resolved Hide resolved

src/modules/fs.cpp Show resolved Hide resolved

src/modules/meta/base.cpp Outdated Show resolved Hide resolved

src/modules/meta/base.cpp Outdated Show resolved Hide resolved

quandangv added 3 commits December 1, 2020 16:26

Reformat

fa8c954

Merge remote-tracking branch 'upstream/master' into warn-state

4e22c23

Refactor

816e528

patrick96 self-requested a review December 1, 2020 19:28

patrick96 requested changes Dec 1, 2020

View reviewed changes

quandangv added 3 commits December 2, 2020 11:22

Reformat

3027d24

Reformat: convert tabs to spaces

b84e630

Reformat

006041a

patrick96 approved these changes Dec 2, 2020

View reviewed changes

patrick96 merged commit 39c73a8 into polybar:master Dec 2, 2020

This was referenced Dec 2, 2020

label-warn for other modules #570

Closed

Conditional Display of Battery #956

Closed

This was referenced Dec 3, 2020

fix(battery): Crash when format-low not defined #2263

Merged

Regression on module battery #2262

Closed

This was referenced Dec 11, 2020

filesystem reports wrong partition information #2283

Closed

filesystem: warn mode below threshold #1871

Closed

wz1000 mentioned this pull request Dec 19, 2020

Add low and critical battery states #2074

Closed

patrick96 mentioned this pull request Feb 15, 2021

battery: If charge drops to low-at and format-low is not used, label-discharging tokens are not replaced. #2379

Closed

4 tasks

patrick96 mentioned this pull request Jan 18, 2022

feat(memory): Add different formats for different memory usage #2142

Closed

Uh oh!

Warn state for CPU, Memory, Filesystem and Battery modules #2199

Warn state for CPU, Memory, Filesystem and Battery modules #2199

Uh oh!

Conversation

quandangv commented Oct 9, 2020 • edited by patrick96 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Oct 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

quandangv commented Oct 18, 2020

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

quandangv commented Nov 30, 2020

Uh oh!

quandangv commented Nov 30, 2020

Uh oh!

patrick96 commented Nov 30, 2020

Uh oh!

quandangv commented Nov 30, 2020

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

quandangv commented Dec 1, 2020

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

quandangv commented Dec 2, 2020

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

quandangv commented Oct 9, 2020 •

edited by patrick96

Loading

codecov bot commented Oct 9, 2020 •

edited

Loading