man/systemd-cgtop.1

   1 '\" t
   2 .TH "SYSTEMD\-CGTOP" "1" "" "systemd 218" "systemd-cgtop"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 systemd-cgtop \- Show top control groups by their resource usage
  24 .SH "SYNOPSIS"
  25 .HP \w'\fBsystemd\-cgtop\fR\ 'u
  26 \fBsystemd\-cgtop\fR [OPTIONS...]
  27 .SH "DESCRIPTION"
  28 .PP
  29 \fBsystemd\-cgtop\fR
  30 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
  31 \fBtop\fR(1)\&. If
  32 \fBsystemd\-cgtop\fR
  33 is not connected to a tty, only one iteration is performed and no columns headers are printed\&. This mode is suitable for scripting\&.
  34 .PP
  35 Resource usage is only accounted for control groups in the relevant hierarchy, i\&.e\&. CPU usage is only accounted for control groups in the
  36 "cpuacct"
  37 hierarchy, memory usage only for those in
  38 "memory"
  39 and disk I/O usage for those in
  40 "blkio"\&. If resource monitoring for these resources is required, it is recommended to add the
  41 \fICPUAccounting=1\fR,
  42 \fIMemoryAccounting=1\fR
  43 and
  44 \fIBlockIOAccounting=1\fR
  45 settings in the unit files in question\&. See
  46 \fBsystemd.resource-control\fR(5)
  47 for details\&.
  48 .PP
  49 To emphasize this: unless
  50 "CPUAccounting=1",
  51 "MemoryAccounting=1"
  52 and
  53 "BlockIOAccounting=1"
  54 are enabled for the services in question, no resource accounting will be available for system services and the data shown by
  55 \fBsystemd\-cgtop\fR
  56 will be incomplete\&.
  57 .SH "OPTIONS"
  58 .PP
  59 The following options are understood:
  60 .PP
  61 \fB\-p\fR
  62 .RS 4
  63 Order by control group path name\&.
  64 .RE
  65 .PP
  66 \fB\-t\fR
  67 .RS 4
  68 Order by number of tasks in control group (i\&.e\&. threads and processes)\&.
  69 .RE
  70 .PP
  71 \fB\-c\fR
  72 .RS 4
  73 Order by CPU load\&.
  74 .RE
  75 .PP
  76 \fB\-m\fR
  77 .RS 4
  78 Order by memory usage\&.
  79 .RE
  80 .PP
  81 \fB\-i\fR
  82 .RS 4
  83 Order by disk I/O load\&.
  84 .RE
  85 .PP
  86 \fB\-b\fR, \fB\-\-batch\fR
  87 .RS 4
  88 Run in "batch" mode: do not accept input and run until the iteration limit set with
  89 \fB\-\-iterations\fR
  90 is exhausted or until killed\&. This mode could be useful for sending output from
  91 \fBsystemd\-cgtop\fR
  92 to other programs or to a file\&.
  93 .RE
  94 .PP
  95 \fB\-n\fR, \fB\-\-iterations=\fR
  96 .RS 4
  97 Perform only this many iterations\&.
  98 .RE
  99 .PP
 100 \fB\-d\fR, \fB\-\-delay=\fR
 101 .RS 4
 102 Specify refresh delay in seconds (or if one of
 103 "ms",
 104 "us",
 105 "min"
 106 is specified as unit in this time unit)\&.
 107 .RE
 108 .PP
 109 \fB\-\-depth=\fR
 110 .RS 4
 111 Maximum control group tree traversal depth\&. Specifies how deep
 112 \fBsystemd\-cgtop\fR
 113 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\&.
 114 .RE
 115 .PP
 116 \fB\-h\fR, \fB\-\-help\fR
 117 .RS 4
 118 Print a short help text and exit\&.
 119 .RE
 120 .PP
 121 \fB\-\-version\fR
 122 .RS 4
 123 Print a short version string and exit\&.
 124 .RE
 125 .SH "KEYS"
 126 .PP
 127 \fBsystemd\-cgtop\fR
 128 is an interactive tool and may be controlled via user input using the following keys:
 129 .PP
 130 h
 131 .RS 4
 132 Shows a short help text\&.
 133 .RE
 134 .PP
 135 SPACE
 136 .RS 4
 137 Immediately refresh output\&.
 138 .RE
 139 .PP
 140 q
 141 .RS 4
 142 Terminate the program\&.
 143 .RE
 144 .PP
 145 p, t, c, m, i
 146 .RS 4
 147 Sort the control groups by path, number of tasks, CPU load, memory usage, or IO load, respectively\&.
 148 .RE
 149 .PP
 150 %
 151 .RS 4
 152 Toggle between showing CPU time as time or percentage\&.
 153 .RE
 154 .PP
 155 +, \-
 156 .RS 4
 157 Increase or decrease refresh delay, respectively\&.
 158 .RE
 159 .SH "EXIT STATUS"
 160 .PP
 161 On success, 0 is returned, a non\-zero failure code otherwise\&.
 162 .SH "SEE ALSO"
 163 .PP
 164 \fBsystemd\fR(1),
 165 \fBsystemctl\fR(1),
 166 \fBsystemd-cgls\fR(1),
 167 \fBsystemd.resource-control\fR(5),
 168 \fBtop\fR(1)