1PCP-ATOPRC(5)                 File Formats Manual                PCP-ATOPRC(5)
2
3
4

NAME

6       atoprc - pcp-atop/pcp-atopsar related resource file
7

DESCRIPTION

9       This  manual  page documents the resource file of the pcp-atop and pcp-
10       atopsar commands.  These commands can be used to monitor the system and
11       process load on a system.
12
13       The  pcp-atoprc  file contains the default settings. These settings are
14       read during startup, first from the system-wide rcfile /etc/atoprc  and
15       after that from the user-specific rcfile ~/.atoprc (so system-wide set‐
16       tings can be overruled by an individual user).   The  options  in  both
17       rcfiles are identical.
18

OPTIONS

20       The rcfile contains keyword-value pairs, one on every line (blank lines
21       and lines starting with a #-sign are ignored).
22       The following keywords can be specified:
23
24       flags
25           A list of default flags for pcp-atop can be defined here. The flags
26           which  are allowed are 'g', 'm', 'd', 'n', 'u', 'p', 's', 'c', 'v',
27           'C', 'M', 'D', 'N', 'A', 'a', 'y', 'f', 'F', 'G', 'R', '1' and 'x'.
28
29       interval
30           The default interval value in seconds.
31
32       linelen
33           The length of a screen line when sending output to a file  or  pipe
34           (default 80).
35
36       username
37           The  default regular expression for the users for which active pro‐
38           cesses will be shown.
39
40       procname
41           The default regular expression for the process names to be shown.
42
43       maxlinecpu
44           The maximum number of active CPU's that will be shown.
45
46       maxlinelvm
47           The maximum number of active logical volumes that will be shown.
48
49       maxlinemdd
50           The maximum number of active multiple devices that will be shown.
51
52       maxlinedisk
53           The maximum number of active disks that will be shown.
54
55       maxlinenfsm
56           The maximum number of NFS mounts that  will  be  shown  on  an  NFS
57           client.
58
59       maxlineintf
60           The maximum number of active network interfaces that will be shown.
61
62       maxlinecont
63           The maximum number of active containers that will be shown.
64
65       cpucritperc
66           The  busy  percentage considered critical for a processor (see sec‐
67           tion COLORS in the man-page of the pcp-atop  command).   This  per‐
68           centage  is used to determine a weighted percentage for line color‐
69           ing and sorting of active processes.  When this value is  zero,  no
70           line coloring or automatic sorting is performed for this resource.
71
72       dskcritperc
73           The  busy  percentage  considered  critical for a disk (see section
74           COLORS in the man-page of the pcp-atop command).   This  percentage
75           is  used  to  determine a weighted percentage for line coloring and
76           sorting of active processes.  When this value is zero, no line col‐
77           oring or automatic sorting is performed for this resource.
78
79       netcritperc
80           The  busy  percentage  considered  critical for a network interface
81           (see section COLORS in the man-page of the pcp-atop command).  This
82           percentage is used to determine a weighted percentage for line col‐
83           oring and sorting of active processes.  When this value is zero, no
84           line coloring or automatic sorting is performed for this resource.
85
86       memcritperc
87           The percentage considered critical for memory utilization (see sec‐
88           tion COLORS in the man-page of the pcp-atop  command).   This  per‐
89           centage  is used to determine a weighted percentage for line color‐
90           ing and sorting of active processes.  When this value is  zero,  no
91           line coloring or automatic sorting is performed for this resource.
92
93       swpcritperc
94           The  occupation  percentage considered critical for swap space (see
95           section COLORS in the man-page of the pcp-atop command).  This per‐
96           centage  is used to determine a weighted percentage for line color‐
97           ing and sorting of active processes.  When this value is  zero,  no
98           line coloring or automatic sorting is performed for this resource.
99
100       swoutcritsec
101           The  number of pages swapped out per second considered critical for
102           for memory utilization (see section COLORS in the man-page  of  the
103           pcp-atop  command).   This  threshold  is  used in combination with
104           'memcritperc' to determine a weighted percentage for line  coloring
105           and  sorting of active processes.  When this value is zero, no line
106           coloring or automatic sorting is performed for this resource.
107
108       almostcrit
109           A percentage  of  the  critical  percentage  to  determine  if  the
110           resource  is almost critical (see section COLORS in the man-page of
111           the pcp-atop command).  When this value is zero, no  line  coloring
112           for `almost critical' is performed.
113
114       colorinfo
115           Definition of color name for information messages (default: green).
116           Allowed colors are: red green yellow blue magenta cyan black white.
117
118       colorthread
119           Definition  of  color name for thread-specific lines when using the
120           'y' option (default: yellow).
121           Allowed colors are: red green yellow blue magenta cyan black white.
122
123       coloralmost
124           Definition of color name for almost  critical  resources  (default:
125           cyan).
126           Allowed colors are: red green yellow blue magenta cyan black white.
127
128       colorcritical
129           Definition of color name for critical resources (default: red).
130           Allowed colors are: red green yellow blue magenta cyan black white.
131
132       pcp-atopsarflags
133           A  list  of  default flags for pcp-atopsar can be defined here. The
134           flags that are allowed are 'S', 'x', 'C', 'M', 'H',  'a',  'A'  and
135           the flags to select one or more specific reports.
136
137       An example of the /etc/atoprc or ~/.atoprc file:
138
139
140               flags         Aaf
141               interval      5
142               username
143               procname
144               maxlinecpu    4
145               maxlinedisk   10
146               maxlineintf   5
147               cpucritperc   80
148               almostcrit    90
149               pcp-atopsarflags  CMH
150               ownprocline   PID:50 VGROW:40 RGROW:45 COMMAND-LINE:50
151               ownpagline    PAGSCAN:3 BLANKBOX:0 PAGSWIN:3 PAGSWOUT:7
152
153       The keywords 'ownprocline' and 'ownpagline' are explained in the subse‐
154       quent section.
155

OWN DEFINITION OF OUTPUT LINE

157       Via the rcfile it is possible to define the layout of the output  lines
158       yourself,  i.e.  you  can  define  the  layout of one line with process
159       information with the keyword 'ownprocline' (to be selected with the key
160       'o' or the flag -o) and you can redefine all lines with system informa‐
161       tion.
162
163       The layout of an output-line can be defined  as  follows  (notice  that
164       this should be specified as one line in the rcfile):
165
166          keyword   <columnid>:<prio> [<columnid>:<prio> ...]
167
168       The columnid is the symbolic name of a column that should shown at this
169       position in the output line.
170       The prio is a positive integer value that determines which columns have
171       precedence  whenever  not  all  specified  columns fit into the current
172       screen-width.  The higher value, the higher priority.
173       The column-specifications should be separated by a space. The order  in
174       which  columns  have  been specified is the order in which they will be
175       shown, with respect to their priority (columns that do not fit, will be
176       dropped dynamically).
177
178       A  special columnid for system lines is 'BLANKBOX'. This indicates that
179       an empty column is required at this position. Also this special  colum‐
180       nid is followed by a priority (usually low).
181
182       The following definition can be specified for process information:
183
184       ownprocline
185           The  columnid's  are the names of the columns that are shown in the
186           normal output of the process-related lines that are shown  by  pcp-
187           atop  such  as  'PID',  'CMD', 'S', ....  The only exception is the
188           special columnid 'SORTITEM' that is used to show one of the columns
189           CPU%/DSK%/MEM%/NET%, depending on the chosen sort-criterium.
190           An example of a user-defined process line:
191
192               ownprocline   PID:20   PPID:10   SYSCPU:15  USRCPU:15  VGROW:14
193               VSIZE:12 RGROW:14 RSIZE:12 ST:8 EXC:7 S:11 SORTITEM:18 CMD:20
194
195       The following definitions  are  used  internally  by  pcp-atop  as  the
196       default  system  lines  (you can redefine each of them in the rcfile as
197       one line):
198
199       ownsysprcline
200           Redefinition of line labeled with 'PRC':
201
202               ownsysprcline   PRCSYS:8 PRCUSER:8 BLANKBOX:0 PRCNPROC:7  PRCN‐
203               ZOMBIE:5 PRCCLONES:4 BLANKBOX:0 PRCNNEXIT:6
204
205       ownallcpuline
206           Redefinition of line labeled with 'CPU' for total CPU-utilization:
207
208               ownallcpuline   CPUSYS:8  CPUUSER:7  CPUIRQ:4  BLANKBOX:0 CPUI‐
209               DLE:5 CPUWAIT:6 BLANKBOX:0 CPUSTEAL:1 CPUGUEST:3
210
211       ownonecpuline
212           Redefinition of line labeled with 'CPU' for utilization of one CPU:
213
214               ownonecpuline   CPUISYS:8 CPUIUSER:7 CPUIIRQ:4 BLANKBOX:0 CPUI‐
215               IDLE:5 CPUIWAIT:6 BLANKBOX:0 CPUISTEAL:1 CPUIGUEST:3
216
217       owncplline
218           Redefinition of line labeled with 'CPL':
219
220               owncplline   CPLAVG1:4 CPLAVG5:3 CPLAVG15:2 BLANKBOX:0 CPLCSW:6
221               CPLINTR:5 BLANKBOX:0 CPLNUMCPU:1
222
223       ownmemline
224           Redefinition of line labeled with 'MEM':
225
226               ownmemline   MEMTOT:2  MEMFREE:5  MEMCACHE:3  MEMDIRTY:1   MEM‐
227               BUFFER:3 MEMSLAB:3 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0
228
229       ownswpline
230           Redefinition of line labeled with 'SWP':
231
232               ownswpline   SWPTOT:3     SWPFREE:4    BLANKBOX:0    BLANKBOX:0
233               BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 SWPCOMMITTED:5 SWP‐
234               COMMITLIM:6
235
236       ownpagline
237           Redefinition of line labeled with 'PAG':
238
239               ownpagline   PAGSCAN:3    PAGSTALL:1    BLANKBOX:0    PAGSWIN:4
240               PAGSWOUT:3
241
242       owndskline
243           Redefinition of lines labeled with 'LVM', 'MDD' and 'DSK':
244
245               owndskline   DSKNAME:8   DSKBUSY:7    DSKNREAD:6    DSKNWRITE:6
246               DSKKBPERRD:4   DSKKBPERWR:4   DSKMBPERSECRD:5   DSKMBPERSECWR:5
247               DSKAVQUEUE:1 DSKAVIO:5
248
249       ownnettrline
250           Redefinition of line labeled with 'NET' for transport:
251
252               ownnettrline   NETTRANSPORT:9  NETTCPI:8  NETTCPO:8   NETUDPI:8
253               NETUDPO:8   NETTCPACTOPEN:6   NETTCPPASVOPEN:5  NETTCPRETRANS:4
254               NETTCPINERR:3 NETTCPORESET:20 NETUDPNOPORT:1 NETUDPINERR:3
255
256       ownnetnetline
257           Redefinition of line labeled with 'NET' for network:
258
259               ownnetnetline   NETNETWORK:5   NETIPI:4   NETIPO:4   NETIPFRW:4
260               NETIPDELIV:4  BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 NETICMPIN:1 NET‐
261               ICMPOUT:1
262
263       ownnetifline
264           Redefinition of line labeled with 'NET' for interfaces:
265
266               ownnetifline   NETNAME:8 NETPCKI:7 NETPCKO:7 NETSPEEDIN:6  NET‐
267               SPEEDOUT:6 NETCOLLIS:3 NETMULTICASTIN:2 NETRCVERR:5 NETSNDERR:5
268               NETRCVDROP:4 NETSNDDROP:4
269
270       The lines above are shown in the order as shown by pcp-atop in combina‐
271       tion  with the -f flag (in a very wide window you should be able to see
272       all of the columns).
273

SEE ALSO

275       pcp(1), pcp-atop(1), pcp-atopsar(1) and PCPIntro(1).
276
277
278
279Performance Co-Pilot                  PCP                        PCP-ATOPRC(5)
Impressum