From 27ab9146615dfaccf914a795422e673b5179609f Mon Sep 17 00:00:00 2001 From: Alexey Avramov Date: Sun, 28 Jun 2020 04:12:15 +0900 Subject: [PATCH] update readme --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index defa7e1..b45e6fe 100644 --- a/README.md +++ b/README.md @@ -368,7 +368,7 @@ You can also enable `separate_log` in the config to logging in `/var/log/nohang/ ## oom-sort -`oom-sort` is an additional diagnostic tool that will be installed with `nohang` package. It sorts the processes in descending order of their `oom_score` and also displays `oom_score_adj`, `Uid`, `Pid`, `Name`, `VmRSS`, `VmSwap` and optionally `cmdline`. Run `oom-sort --help` for more info. +`oom-sort` is an additional diagnostic tool that will be installed with `nohang` package. It sorts the processes in descending order of their `oom_score` and also displays `oom_score_adj`, `Uid`, `Pid`, `Name`, `VmRSS`, `VmSwap` and optionally `cmdline`. Run `oom-sort --help` for more info. Man page: [oom-sort.manpage.md](docs/oom-sort.manpage.md). Usage: @@ -378,7 +378,6 @@ $ oom-sort
Output example - ``` oom_score oom_score_adj UID PID Name VmRSS VmSwap cmdline --------- ------------- ---- ----- --------------- ------- -------- ------- @@ -471,11 +470,10 @@ Kthreads, zombies and Pid 1 will not be displayed. ## psi-top -It needs `Linux` (>= 4.20) with `CONFIG_PSI=y`. +psi-top is script that prints the PSI metrics values for every cgroup. It requires `Linux` >= 4.20 with `CONFIG_PSI=y`. Man page: [psi-top.manpage.md](docs/psi-top.manpage.md).
Output example - ``` $ $ psi-top cgroup2 mountpoint: /sys/fs/cgroup @@ -529,11 +527,10 @@ some 0.00 0.18 0.30 | full 0.00 0.18 0.30 /system.slice/systemd-log ## psi2log -It needs `Linux` >= 4.20 with `CONFIG_PSI=y`. +psi2log is a CLI tool that can check and log PSI metrics from specified target. It requires `Linux` >= 4.20 with `CONFIG_PSI=y`. Man page: [psi2log.manpage.md](docs/psi2log.manpage.md).
Output example - ``` $ psi2log Starting psi2log @@ -598,6 +595,7 @@ full io 0.54 7.52 6.80 - [nohang.manpage.md](docs/nohang.manpage.md) - [oom-sort.manpage.md](docs/oom-sort.manpage.md) - [psi2log.manpage.md](docs/psi2log.manpage.md) +- [psi-top.manpage.md](docs/psi-top.manpage.md) - [FAQ.ru.md](docs/FAQ.ru.md) - [CHANGELOG.md](CHANGELOG.md)