From caa94887002de8596c69f578dbdb684dfb368240 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 25 Jan 2012 00:12:47 +0100 Subject: [PATCH] man: document systemd-cgtop tool --- Makefile.am | 1 + man/systemd-cgls.xml | 7 +- man/systemd-cgtop.xml | 246 ++++++++++++++++++++++++++++++++++++++++++ src/cgtop.c | 2 +- 4 files changed, 253 insertions(+), 3 deletions(-) create mode 100644 man/systemd-cgtop.xml diff --git a/Makefile.am b/Makefile.am index d6fcd2382..8fc209951 100644 --- a/Makefile.am +++ b/Makefile.am @@ -653,6 +653,7 @@ MANPAGES = \ man/systemctl.1 \ man/systemadm.1 \ man/systemd-cgls.1 \ + man/systemd-cgtop.1 \ man/systemd-nspawn.1 \ man/systemd-tmpfiles.8 \ man/systemd-notify.1 \ diff --git a/man/systemd-cgls.xml b/man/systemd-cgls.xml index 569764a6c..1e53147e1 100644 --- a/man/systemd-cgls.xml +++ b/man/systemd-cgls.xml @@ -78,6 +78,7 @@ + Prints a short help @@ -94,7 +95,7 @@ - Includes kernel + Include kernel threads in output. @@ -113,7 +114,9 @@ See Also systemd1, - systemctl1 + systemctl1, + systemd-cgtop1, + ps1 diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml new file mode 100644 index 000000000..2d67ae5ef --- /dev/null +++ b/man/systemd-cgtop.xml @@ -0,0 +1,246 @@ + + + + + + + + + systemd-cgtop + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-cgtop + 1 + + + + systemd-cgtop + Show top control groups by their resource usage + + + + + systemd-cgtop OPTIONS + + + + + Description + + systemd-cgtop shows the top + control groups of the local Linux control group + hierarchy, ordered by their CPU, memory and disk I/O load. The + display is refreshed in regular intervals (by default + every 1s), similar in style to + top1. + + Resource usage is only accounted for control + groups in the relevant hierarchy, i.e. CPU usage is + only accounted for control groups in the + cpuacct hierarchy, memory usage + only for those in memory and disk + I/O usage for those in + blkio. systemd1 + by default places all services in their own control + group in the cpuacct hierarchy, but + not in memory nor + blkio. If resource monitoring for + these resources is required it is recommended to add + blkio and memory + to the DefaultControllers= setting + in /etc/systemd/system.conf (see + systemd.conf5 + for details). Alternatively, it is possible to enable + resource accounting individually for services, by + making use of the ControlGroup= + option in the unit files (See + systemd.exec5 + for details). + + To emphasize this: unless + blkio and memory + are enabled for the services in question with either + of the options suggested above no resource accounting + will be available for system services and the data shown + by systemd-cgtop will be + incomplete. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Order by control group + path name. + + + + + + Order by number of + tasks in control + group (i.e. threads and processes). + + + + + + Order by CPU load. + + + + + + Order by memory usage. + + + + + + Order by disk I/O load. + + + + + + + Specify refresh delay + in seconds (or if one of + ms, + us, + min is specified as + unit in this time + unit). + + + + + + Maximum control group + tree traversal depth. Specifies how + deep systemd-cgtop + shall traverse the control group + hierarchies. If 0 is specified only + the root group is monitored, for 1 + only the first level of control groups + is monitored, and so on. Defaults to + 2. + + + + + + + + + Keys + + systemd-cgtop is an + interactive tool and may be controlled via user input + using the following keys: + + + + h + + Shows a short help text. + + + + SPACE + + Immediately refresh output. + + + + q + + Terminate the program. + + + + + p + t + c + m + i + + Change ordering of control groups + by path, number of tasks, CPU load, + memory usage resp. IO + load. + + + + + + - + + Increase, + resp. decrease refresh + delay. + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + See Also + + systemd1, + systemctl1, + systemd-cgls1, + top1 + + + + diff --git a/src/cgtop.c b/src/cgtop.c index 4624bc4af..8b8617dc1 100644 --- a/src/cgtop.c +++ b/src/cgtop.c @@ -499,7 +499,7 @@ static void help(void) { " -m Order by memory load\n" " -i Order by IO load\n" " -d --delay=DELAY Specify delay\n" - " --depth=DEPTH Maximum traversal depth\n", + " --depth=DEPTH Maximum traversal depth (default: 2)\n", program_invocation_short_name); } -- 2.30.2