/minq-ananicy

Minq Ananicy - is Another auto nice daemon, with community rules support (Use pull request please)

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Ananicy

Installation

  • logo Arch: AUR/minq-ananicy-git. paru -S minq-ananicy-git or yay -S minq-ananicy-git should do the trick. Don't forget to start and enable the service by running sudo systemctl start ananicy.service and sudo systemctl enable ananicy.service.

For more information click here

What's new?

More, updated and better organised rules.

Support for cmdline in rules added. This is particularly useful for applications that share the same name (looking at you Java). See the freenet rule as an example:

{ "name": "java", "cmdlines": ["freenet.node.NodeStarter"], "type": "service" }

Which this translates to is: apply the rule to any process named java, that received freenet.node.NodeStarter as a command line argument. You can add more than one "cmdlines" in case you want to fine tune your rules.

What's bad?

Creating multiple processes with the same name causes only 1 of them to be active.

Ananicy's default rules and settings are bad and are causing my PC to lag (lol that's the opposite of what ananicy is supposed to do). I am actively trying to fix the settings.

Old description

Description

Ananicy (ANother Auto NICe daemon) — is a shell daemon created to manage processes' IO and CPU priorities, with community-driven set of rules for popular applications (anyone may add their own rule via github's pull request mechanism). It's mainly for desktop usage.

I just wanted a tool for auto set programs nice in my system, i.e.:

  • Why do I get lag, while compiling kernel and playing games?
  • Why does dropbox client eat all my IO?
  • Why does torrent/dc client make my laptop run slower?
  • ...

Use ananicy to fix these problems!

Versions

X.Y.Z where
X - Major version,
Y - Script version - reset on each major update
Z - Rules version - reset on each script update

Read more about semantic versioning here

Installation

To use ananicy you must have systemd installed.

You can install ananicy manually by:

$ git clone https://github.com/Nefelim4ag/Ananicy.git /tmp/ananicy
$ cd /tmp/ananicy
$ sudo make install

$ git clone https://github.com/Nefelim4ag/Ananicy.git
$ ./Ananicy/package.sh debian
$ sudo dpkg -i ./Ananicy/ananicy-*.deb

Enable

$ sudo systemctl enable ananicy
$ sudo systemctl start ananicy

Configuration

Rules files should be placed under /etc/ananicy.d/ directory and have *.rules extension. Inside .rules file every process is described on a separate line. General syntax is described below:

{ "name": "gcc", "type": "Heavy_CPU", "nice": 19, "ioclass": "best-effort", "ionice": 7, "cgroup": "cpu90" }

All fields except name are optional.

name used for match processes by exec bin name

~ basename $(sudo realpath /proc/1/exe)
systemd

Currently matching by other things is not supported.

You can check what Ananicy sees, by:

ananicy dump proc

Ananicy loads all rules in ram while starting, so to apply rules, you must restart the service.

Available ionice values:

$ man ionice

Simple rules for writing rules

CFQ IO Scheduller also uses nice for internal scheduling, so it's mean processes with same IO class and IO priority, but with different nicceness will take advantages of nice also for IO.

  1. Avoid changing nice of system wide process like initrd.
  2. Please try to use full process name (or name with ^$ symbols like NAME=^full_name$)
  3. When writing rule - try to only use nice, it must be enough in most cases.
  4. Don't try set to high priority! Niceness can fix some performance problems, but can't give you more. Example: pulseaudio uses nice -11 by default, if you set other cpu hungry task, with nice {-20..-12} you can catch a sound glitches.
  5. For CPU hungry backround task like compiling, just use NICE=19.

About IO priority:

  1. It's useful to use {"ioclass": "idle"} for IO hungry background tasks like: file indexers, Cloud Clients, Backups and etc.
  2. It's not cool to set realtime to all tasks. The RT scheduling class is given first access to the disk, regardless of what else is going on in the system. Thus the RT class needs to be used with some care, as it can starve other processes. So try to use ioclass first.

Debugging

Get ananicy output with journalctl:

$ journalctl -efu ananicy.service

Missing schedtool

If you see this error in the output

Jan 24 09:44:18 tony-dev ananicy[13783]: ERRO: Missing schedtool! Abort!

Fix it in Ubuntu with

sudo apt install schedtool

Submitting new rules

Please use pull request, thanks