X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-cgtop.xml;h=f1ff218c39185aaf2f75d4904e2e28efbc3cd24e;hp=112e5fff874b2a98d2fef4df28ebfc3994572a81;hb=1140e154100f7224fb8bab55ba7fc087409f9d76;hpb=871b876ecc6921a70b5f5e15cb9f85e0b6f2d1a5 diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index 112e5fff8..f1ff218c3 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -1,6 +1,6 @@ + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - - - - 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. - - - - - - Prints a version string 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. - - - - - - - Run in "batch" mode: - do not accept input and run until the - iteration limit set with - is - exhausted or until killed. This mode - could be useful for sending output - from systemd-cgtop - to other programs or to a - file. - - - - - - - Perform only this many - iterations. - - - - - - - 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 - 3. - - - - - - - - - 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 - - + + + + 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, or disk I/O load. The display is refreshed in + regular intervals (by default every 1s), similar in style to + top1. + If systemd-cgtop is not connected to a tty, + only one iteration is performed and no columns headers are + printed. This mode is suitable for scripting. + + 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. If resource monitoring for + these resources is required, it is recommended to add the + CPUAccounting=1, + MemoryAccounting=1 and + BlockIOAccounting=1 settings in the unit files + in question. See + systemd.resource-control5 + for details. + + To emphasize this: unless + CPUAccounting=1, + MemoryAccounting=1 and + BlockIOAccounting=1 are enabled for the + services in question, 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: + + + + + + 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. + + + + + + + Run in "batch" mode: do not accept input and + run until the iteration limit set with + is exhausted or until killed. + This mode could be useful for sending output from + systemd-cgtop to other programs or to a + file. + + + + + + + Perform only this many iterations. + + + + + + + + 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 + 3. + + + + + + + + + + + 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 + + Sort the control groups by path, number of + tasks, CPU load, memory usage, or IO load, respectively. + + + + + % + + Toggle between showing CPU time as time or + percentage. + + + + + + - + + Increase or decrease refresh delay, + respectively. + + + + + + + Exit status + + On success, 0 is returned, a non-zero failure code + otherwise. + + + + See Also + + systemd1, + systemctl1, + systemd-cgls1, + systemd.resource-control5, + top1 + +