1PCP-ATOPRC(5) File Formats Manual PCP-ATOPRC(5)
2
6 pcp-atoprc - pcp-atop and pcp-atopsar resource file
7
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 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 rc‐
17 files are identical.
18
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 flags
25 A list of default flags for pcp-atop can be defined here. The flags
26 which are allowed are 'B', 'H', 'g', 'm', 'd', 'n', 'u', 'p', 's',
27 'c', 'v', 'C', 'M', 'D', 'N', 'A', 'a', 'y', 'f', 'F', 'G', 'R',
28 '1', 'e', 'E' and 'x'.
29 interval
31 The default interval value in seconds.
32 linelen
34 The length of a screen line when sending output to a file or pipe
35 (default 80).
36 username
38 The default regular expression for the users for which active pro‐
39 cesses will be shown.
40 procname
42 The default regular expression for the process names to be shown.
43 maxlinecpu
45 The maximum number of active CPUs that will be shown.
46 maxlinegpu
48 The maximum number of active GPUs that will be shown.
49 maxlinelvm
51 The maximum number of active logical volumes that will be shown.
52 maxlinemdd
54 The maximum number of active multiple devices that will be shown.
55 maxlinedisk
57 The maximum number of active disks that will be shown.
58 maxlinenfsm
60 The maximum number of NFS mounts that will be shown on an NFS
61 client.
62 maxlineintf
64 The maximum number of active network interfaces that will be shown.
65 maxlinecont
67 The maximum number of active containers that will be shown.
68 cpucritperc
70 The busy percentage considered critical for a processor (see sec‐
71 tion COLORS in the man-page of the pcp-atop command). This per‐
72 centage is used to determine a weighted percentage for line color‐
73 ing and sorting of active processes in text mode. When this value
74 is zero, no line coloring or automatic sorting is performed for
75 this resource.
76 dskcritperc
78 The busy percentage considered critical for a disk (see section
79 COLORS in the man-page of the pcp-atop command). This percentage
80 is used to determine a weighted percentage for line coloring and
81 sorting of active processes in text mode. When this value is zero,
82 no line coloring or automatic sorting is performed for this re‐
83 source.
84 netcritperc
86 The busy percentage considered critical for a network interface
87 (see section COLORS in the man-page of the pcp-atop command). This
88 percentage is used to determine a weighted percentage for line col‐
89 oring and sorting of active processes in text mode. When this
90 value is zero, no line coloring or automatic sorting is performed
91 for this resource.
92 memcritperc
94 The percentage considered critical for memory utilization (see sec‐
95 tion 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 in text mode. When this value
98 is zero, no line coloring or automatic sorting is performed for
99 this resource.
100 swpcritperc
102 The occupation percentage considered critical for swap space (see
103 section COLORS in the man-page of the pcp-atop command). This per‐
104 centage is used to determine a weighted percentage for line color‐
105 ing and sorting of active processes. When this value is zero, no
106 line coloring or automatic sorting is performed for this resource.
107 swoutcritsec
109 The number of pages swapped out per second considered critical for
110 for memory utilization (see section COLORS in the man-page of the
111 pcp-atop command). This threshold is used in combination with
112 'memcritperc' to determine a weighted percentage for line coloring
113 and sorting of active processes. When this value is zero, no line
114 coloring or automatic sorting is performed for this resource.
115 almostcrit
117 A percentage of the critical percentage to determine if the re‐
118 source is almost critical (see section COLORS in the man-page of
119 the pcp-atop command). When this value is zero, no line coloring
120 for `almost critical' is performed.
121 cpubarwidth
123 Number of columns used per bar in the processor bar graph. The de‐
124 fault value is 0 which means that the bar width will be scaled au‐
125 tomatically (the wider the terminal, the more columns per bar upto
126 a maximum of three). With the value 1, 2 or 3 the number of bars
127 can be statically pinned to that number of columns, with one column
128 of white space in between the bars.
129 colorinfo
131 Definition of color name for information messages (default: green)
132 in text mode.
133 Allowed colors are: red green yellow blue magenta cyan black white.
134 colorthread
136 Definition of color name for thread-specific lines when using the
137 'y' option (default: yellow).
138 Allowed colors are: red green yellow blue magenta cyan black white.
139 coloralmost
141 Definition of color name for almost critical resources (default:
142 cyan) in text mode.
143 Allowed colors are: red green yellow blue magenta cyan black white.
144 colorcritical
146 Definition of color name for critical resources (default: red) in
147 text mode.
148 Allowed colors are: red green yellow blue magenta cyan black white.
149 pcp-atopsarflags
151 A list of default flags for pcp-atopsar can be defined here. The
152 flags that are allowed are 'S', 'x', 'C', 'M', 'H', 'a', 'A' and
153 the flags to select one or more specific reports.
154 An example of the /etc/atoprc or ~/.atoprc file:
156 flags Aaf
159 interval 5
160 username
161 procname
162 maxlinecpu 4
163 maxlinedisk 10
164 maxlineintf 5
165 cpucritperc 80
166 almostcrit 90
167 pcp-atopsarflags CMH
168 ownprocline PID:50 VGROW:40 RGROW:45 COMMAND-LINE:50
169 ownpagline PAGSCAN:3 BLANKBOX:0 PAGSWIN:3 PAGSWOUT:7
170 The keywords 'ownprocline' and 'ownpagline' are explained in the subse‐
172 quent section.
173
175 Via the rcfile it is possible to define the layout of the output lines
176 yourself, i.e. you can define the layout of one line with process in‐
177 formation with the keyword 'ownprocline' (to be selected with the key
178 'o' or the flag -o) and you can redefine all lines with system informa‐
179 tion.
180 The layout of an output-line can be defined as follows (notice that
182 this should be specified as one line in the rcfile):
183 keyword <columnid>:<prio> [<columnid>:<prio> ...]
185 The columnid is the symbolic name of a column that should shown at this
187 position in the output line.
188 The prio is a positive integer value that determines which columns have
189 precedence whenever not all specified columns fit into the current
190 screen-width. The higher value, the higher priority.
191 The column-specifications should be separated by a space. The order in
192 which columns have been specified is the order in which they will be
193 shown, with respect to their priority (columns that do not fit, will be
194 dropped dynamically).
195 A special columnid for system lines is 'BLANKBOX'. This indicates that
197 an empty column is required at this position. Also this special colum‐
198 nid is followed by a priority (usually low).
199 The following definition can be specified for process information:
201 ownprocline
203 The columnids are the names of the columns that are shown in the
204 normal output of the process-related lines that are shown by pcp-
205 atop such as 'PID', 'CMD', 'S', .... The only exception is the
206 special columnid 'SORTITEM' that is used to show one of the columns
207 CPU%/DSK%/MEM%/NET%, depending on the chosen sort-criterium.
208 An example of a user-defined process line:
209 ownprocline PID:20 PPID:10 SYSCPU:15 USRCPU:15 VGROW:14
211 VSIZE:12 RGROW:14 RSIZE:12 ST:8 EXC:7 S:11 SORTITEM:18 CMD:20
212 The following definitions are used internally by pcp-atop as the de‐
214 fault system lines (you can redefine each of them in the rcfile as one
215 line):
216 ownsysprcline
218 Redefinition of line labeled with 'PRC':
219 ownsysprcline PRCSYS:8 PRCUSER:8 BLANKBOX:0 PRCNPROC:7 PRCN‐
221 ZOMBIE:5 PRCCLONES:4 BLANKBOX:0 PRCNNEXIT:6
222 ownallcpuline
224 Redefinition of line labeled with 'CPU' for total CPU-utilization:
225 ownallcpuline CPUSYS:8 CPUUSER:7 CPUIRQ:4 BLANKBOX:0 CPUI‐
227 DLE:5 CPUWAIT:6 BLANKBOX:0 CPUSTEAL:1 CPUGUEST:3
228 ownonecpuline
230 Redefinition of line labeled with 'CPU' for utilization of one CPU:
231 ownonecpuline CPUISYS:8 CPUIUSER:7 CPUIIRQ:4 BLANKBOX:0 CPUI‐
233 IDLE:5 CPUIWAIT:6 BLANKBOX:0 CPUISTEAL:1 CPUIGUEST:3
234 owncplline
236 Redefinition of line labeled with 'CPL':
237 owncplline CPLAVG1:4 CPLAVG5:3 CPLAVG15:2 BLANKBOX:0 CPLCSW:6
239 CPLINTR:5 BLANKBOX:0 CPLNUMCPU:1
240 ownmemline
242 Redefinition of line labeled with 'MEM':
243 ownmemline MEMTOT:2 MEMFREE:5 MEMCACHE:3 MEMDIRTY:1 MEM‐
245 BUFFER:3 MEMSLAB:3 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0
246 ownswpline
248 Redefinition of line labeled with 'SWP':
249 ownswpline SWPTOT:3 SWPFREE:4 BLANKBOX:0 BLANKBOX:0
251 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 SWPCOMMITTED:5 SWP‐
252 COMMITLIM:6
253 ownpagline
255 Redefinition of line labeled with 'PAG':
256 ownpagline PAGSCAN:3 PAGSTALL:1 BLANKBOX:0 PAGSWIN:4
258 PAGSWOUT:3
259 owndskline
261 Redefinition of lines labeled with 'LVM', 'MDD' and 'DSK':
262 owndskline DSKNAME:8 DSKBUSY:7 DSKNREAD:6 DSKNWRITE:6
264 DSKKBPERRD:4 DSKKBPERWR:4 DSKMBPERSECRD:5 DSKMBPERSECWR:5
265 DSKAVQUEUE:1 DSKAVIO:5
266 ownnettrline
268 Redefinition of line labeled with 'NET' for transport:
269 ownnettrline NETTRANSPORT:9 NETTCPI:8 NETTCPO:8 NETUDPI:8 NE‐
271 TUDPO:8 NETTCPACTOPEN:6 NETTCPPASVOPEN:5 NETTCPRETRANS:4
272 NETTCPINERR:3 NETTCPORESET:20 NETUDPNOPORT:1 NETUDPINERR:3
273 ownnetnetline
275 Redefinition of line labeled with 'NET' for network:
276 ownnetnetline NETNETWORK:5 NETIPI:4 NETIPO:4 NETIPFRW:4
278 NETIPDELIV:4 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 NETICMPIN:1 NET‐
279 ICMPOUT:1
280 ownnetifline
282 Redefinition of line labeled with 'NET' for interfaces:
283 ownnetifline NETNAME:8 NETPCKI:7 NETPCKO:7 NETSPEEDIN:6 NET‐
285 SPEEDOUT:6 NETCOLLIS:3 NETMULTICASTIN:2 NETRCVERR:5 NETSNDERR:5
286 NETRCVDROP:4 NETSNDDROP:4
287 The lines above are shown in the order as shown by pcp-atop in combina‐
289 tion with the -f flag (in a very wide window you should be able to see
290 all of the columns).
291
293 pcp(1), pcp-atop(1), pcp-atopsar(1) and PCPIntro(1).
294Performance Co-Pilot PCP PCP-ATOPRC(5)