update readme

README.md

@@ -2,65 +2,15 @@
 The No Hang Daemon
 ==================
 
-`Nohang` - аналог [earlyoom](https://github.com/rfjakob/earlyoom) с поддержкой `zram` и `SIGTERM`. При дефиците доступной памяти `nohang` корректно завершает наиболее прожорливые процессы сигналом `SIGTERM` или `SIGKILL`, тем самым препятствуя [зависанию](https://en.wikipedia.org/wiki/Hang_(computing)), а также избыточному убийству процессов ядерным `OOM killer`'ом.
+`Nohang` is a highly flexible full-featured daemon for Linux that correctly prevents out of memory.
 
-### Зачем это нужно?
+### Features
 
-Затем, что этот демон реализует востребованный функционал. Судите сами:
-
-"А можете рассказать, как сделать OOM Killer более агрессивным? Например, в ситуации, когда приложение открыло/создало множество мелких файлов и держит их в памяти, при внезапной нехватке памяти ядро пытается высвободить эти файловые страницы, что вешает систему намертво со 100%-м дисковым I/O на несколько (десятков) минут. А ведь зачастую гораздо проще просто грохнуть само приложение с дальнешим его перезапуском."
-https://habr.com/company/flant/blog/348324/#comment_10659202
-
-"Это хорошо, если приходит OOM-killer. Плохо, когда есть огромный iowait, а киллера так никто и не видел, спит. Надежда на то, что без свопа протекающий фаерфокс будет пристрелен, очень быстро растворились в хрусте винта."
-https://habr.com/company/flant/blog/348324/#comment_10660004
-
-"А можете рассказать, как сделать OOM Killer более агрессивным? Например, в ситуации, когда приложение открыло/создало множество мелких файлов и держит их в памяти, при внезапной нехватке памяти ядро пытается высвободить эти файловые страницы, что вешает систему намертво со 100%-м дисковым I/O на несколько (десятков) минут. А ведь зачастую гораздо проще просто грохнуть само приложение с дальнешим его перезапуском."
-https://habr.com/company/flant/blog/348324/#comment_10659202
-
-"Говно какое-то этот оом-киллер, нихрена не работает.
-Но чтобы это нормально работало, я думаю, нужен какой-то демон, который постоянно мониторит потребление памяти и прибивает тот процесс, который резко начинает набирать обороты. В общем сам этот демон будет проц грузить, хотя можно ограничить процессы, которые он будет проверять только пользовательскими процессами, добавить black-white list ну и настраиваемый интервал проверки.
-Короче если кто-то напишет будет круто."
-https://www.linux.org.ru/forum/general/13074074#comment-13074864
-
-"Сегодня скормил пикарду 100-дисковое издание Бетховена и тот сожрал 16 гб памяти вместе с 8 гб zram (коэффициент сжатия был 3.5). Со swappiness 100 zram начал наполняться на 80% памяти, а когда сам достиг 80%, то сжатие продолжилось с новой силой и полной загрузкой ядра. По окончанию банкета система встала колом, потому что киллер опять сцуко не пришел (ждал 10 минут)."
-https://www.linux.org.ru/forum/general/13074074/page1?lastmod=1481740875388#comment-13077387
-
-"Система таки становится неюзабельной если продолжать стараться забивать ее вплоть до исчерпания RAM+ZRAM. Ничего неудивительного, памяти то нет. Но в случае с дисковым свопом ты начинаешь заранее замечать что дело плохо. По ощущениям ZRAM не тормозит вообще, потому ты ничего не подозреваешь до часа икс и система становится колом."
-https://www.linux.org.ru/forum/talks/12684213?lastmod=1466676523241#comment-12684906
-
-"И IRL ты никогда не знаешь, в какой момент момент твои данные перестанут умещаться в оперативку. Потому zram -- удел embedded систем, где это может быть детерминировано."
-https://archive.li/idixk
-
-"OOM killer, зараза такая, не срабатывает или срабатывает через 3 часа."
-https://www.linux.org.ru/forum/desktop/11255705
-
-"Я сначала тоже не прикололся работой OOM, но, черт побери попробуйте предложить более хорошую обработку ситуации"
-https://opennet.ru/opennews/art.shtml?num=21580
-
-"Но у меня оом-киллер не запускался сам, раз я фризы ловил. Подумал, вдруг у меня его вообще нет. В гугле описываются разные параметры, которые позволяют на него повлиять. Но это для тех, кто знает, с чем дело имеет - я не понял например сразу, как и куда их применять."
-https://www.linux.org.ru/forum/desktop/11511840?cid=11513170
-
-"я могу указать, чтобы когда например 50Мб оперативной памяти остаётся - оом-киллер запускался?"
-https://www.linux.org.ru/forum/desktop/11511840?cid=11513174
-
-"There is also the problem that the user does never get any kind of low memory warning beforehand."
-https://www.reddit.com/r/linux/comments/5rixe9/this_is_why_i_love_linux_hundreds_tabs_opens_tons/
-
-`Nohang` позволяет избавиться от перечисленных выше проблем, корректно завершая наиболее прожорливые процессы (с наибольшим oom_score) сигналом `SIGTERM` (или `SIGKILL`) не дожидаясь когда система "встанет колом". `Nohang` позволяет не бояться зависаний при использовании `zram`.
-
-### Зачем нужен nohang, если уже есть earlyoom?
-
-- `Earlyoom` завершает (точнее убивает) процессы исключительно с помощью сигнала `SIGKILL`, в то время как `nohang` дает возможность сначала отправлять `SIGTERM`, и только если процесс не реагирует на `SIGTERM` - отправляется сигнал `SIGKILL`.
-- `Earlyoom` не поддерживает работу со `zram` и не реагирует на общую долю `zram` в памяти (`mem_used_total`). Это может привести к тому, что система все также встанет колом, как если бы `earlyoom` и не было (если `disksize` большой, а энтропия сжимаемых данных велика). `Nohang` позволяет избавиться от этой проблемы. По умолчанию если доля `zram` достигнет 60% памяти - будет отправлен сигнал `SIGTERM` процессу с наибольшим `oom_score`.
-
-### Некоторые особенности
+- Переиодическая проверка доступной памяти
 - задача - препятствовать зависанию системы при нехватке доступной памяти, а также корректное завершение процессов с целью увеличения объема доступной памяти
-- демон на Python 3, VmRSS от 9.5 до 12.9 MiB в зависимости от настроек
-- требуется ядро `Linux 3.14` или новее
 - периодически проверяет объем доступной памяти, при дефиците памяти отправляет `SIGKILL` или `SIGTERM` процессу с наибольшим `oom_score`
 - поддержка работы со `zram`, возможность реакции на `mem_used_total`
 - удобный конфиг с возможностью тонкой настройки
-- аргументы командной строки -h/--help и -c/--config
 - возможность раздельного задания уровней `MemAvailable`, `SwapFree`, `mem_used_total` для отпраки `SIGTERM` и `SIGKILL`, возможность задания в процентах и мебибайтах.
 - возможность снижения `oom_score_adj` процессов, чьи `oom_score_adj` завышены (актуально для `chromium`)
 - лучший алгоритм выбора периодов между проверками доступной памяти: при больших объемах доступной памяти нет смысла проверять ее состояние часто, поэтому период проверки уменьшается по мере уменьшения размера доступной памяти
@@ -69,13 +19,10 @@ https://www.reddit.com/r/linux/comments/5rixe9/this_is_why_i_love_linux_hundreds
 - по умолчанию высокий приоритет процесса `nice -15`, может регулироваться через конфиг
 - предотвращение самоубийства с помощью `self_oom_score_adj = -1000`
 - возможность задания `oom_score_min` для предотвращения убийства невиновных
-- verbosity: опциональность печати параметров конфига при старте программы, опциональность печати результатов проверки памяти и времени между проверками памяти
 - возможность предотвращения избыточного убийства процессов с помощью задания миниального `oom_score` для убиваемых процессов и установка минимальной задержки просле отправки сигналов (параметры конфига `min_delay_after_sigkill` и `min_delay_after_sigterm`)
 - возможность показа десктопных уведомлений c помощью `notify-send`, с показом сигнала (`SIGTERM` или `SIGKILL`), который отправлен процессу, а также `Pid`, `oom_score`, `VmRSS`, `VmSwap`, которыми обладал процесс перед получением сигнала.
 - поддержка white, black, prefer и avoid списков с использованием Perl-compatible regular expressions
-- наличие `man` страницы
 - возможность выполнения определенных команд как альтернатива отправке SIGTERM для избранных процессов (можно использовать для перезапуска демонов вместо завершения)
-- поддержка журналирования в отдельный файл
 - поддержка десктопных уведомлений о низком уровне доступной памяти
 - наличие установщика для пользователей `systemd`
 - протестировано на `Debian 9 x86_64`, `Debian 8 i386`, `Fedora 28 x86_64`
@@ -89,7 +36,17 @@ https://www.reddit.com/r/linux/comments/5rixe9/this_is_why_i_love_linux_hundreds
   Success
 ```
 
-### Установка и удаление для пользователей systemd
+### Requirements
+
+- Linux 3.14+
+- Python 3.4+
+
+### Memory and CPU usage
+
+- VmRSS 9.5 - 12.9 MiB
+- Нагркзка на CPU зависит от объема доступной памяти и растет по мере уменьшения объема доступной памяти
+
+### Download, install, purge
 ```bash
 git clone https://github.com/hakavlad/nohang.git
 cd nohang
@@ -107,7 +64,7 @@ sudo ./purge.sh
 sudo ./uninstall.sh
 ```
 
-### Настройка
+### Settings
 `Nohang` настраивается с помощью [конфига](https://github.com/hakavlad/nohang/blob/master/nohang.conf), расположенного после установки 
 по адресу
 ```
@@ -115,17 +72,16 @@ sudo ./uninstall.sh
 ```
 К опциям прилагается описание. Отредактируйте значения параметров в соответствии с вашими предпочтениями и перезапустите сервис командой `sudo systemctl restart nohang`.
 
-
 ### Почему Python, а не C?
 
 - Скорость разработки на Python значительно выше. Больше фич за приемлемое время.
 - Практически единственный минус Python - большее потребление памяти процессом.
 - На самом деле я просто не знаю C и немножко изучал Python, поэтому пишу на последнем.
 
-### Подсказка
+### Hint
 
 Можно использовать `nohang` для мониторинга размера используемой `zram` памяти (традиционные утилиты для проверки объема доступной памяти, такие как `free`, `top`, `htop`, `gnome-system-monitor` не предоставляют информации об объеме памяти, занимаемом устройствами `zram`)
 
-### Известные баги
+### Known bugs
 В рабочем алгоритме известных нет, если найдете - пишите в [Issues](https://github.com/hakavlad/nohang/issues).