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
17 rcfiles 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 'g', 'm', 'd', 'n', 'u', 'p', 's', 'c', 'v',
27 'C', 'M', 'D', 'N', 'A', 'a', 'y', 'f', 'F', 'G', 'R', '1', 'e',
28 '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. When this value is zero, no
74 line coloring or automatic sorting is performed for this resource.
75 dskcritperc
77 The busy percentage considered critical for a disk (see section
78 COLORS in the man-page of the pcp-atop command). This percentage
79 is used to determine a weighted percentage for line coloring and
80 sorting of active processes. When this value is zero, no line col‐
81 oring or automatic sorting is performed for this resource.
82 netcritperc
84 The busy percentage considered critical for a network interface
85 (see section COLORS in the man-page of the pcp-atop command). This
86 percentage is used to determine a weighted percentage for line col‐
87 oring and sorting of active processes. When this value is zero, no
88 line coloring or automatic sorting is performed for this resource.
89 memcritperc
91 The percentage considered critical for memory utilization (see sec‐
92 tion COLORS in the man-page of the pcp-atop command). This per‐
93 centage is used to determine a weighted percentage for line color‐
94 ing and sorting of active processes. When this value is zero, no
95 line coloring or automatic sorting is performed for this resource.
96 swpcritperc
98 The occupation percentage considered critical for swap space (see
99 section COLORS in the man-page of the pcp-atop command). This per‐
100 centage is used to determine a weighted percentage for line color‐
101 ing and sorting of active processes. When this value is zero, no
102 line coloring or automatic sorting is performed for this resource.
103 swoutcritsec
105 The number of pages swapped out per second considered critical for
106 for memory utilization (see section COLORS in the man-page of the
107 pcp-atop command). This threshold is used in combination with
108 'memcritperc' to determine a weighted percentage for line coloring
109 and sorting of active processes. When this value is zero, no line
110 coloring or automatic sorting is performed for this resource.
111 almostcrit
113 A percentage of the critical percentage to determine if the
114 resource is almost critical (see section COLORS in the man-page of
115 the pcp-atop command). When this value is zero, no line coloring
116 for `almost critical' is performed.
117 colorinfo
119 Definition of color name for information messages (default: green).
120 Allowed colors are: red green yellow blue magenta cyan black white.
121 colorthread
123 Definition of color name for thread-specific lines when using the
124 'y' option (default: yellow).
125 Allowed colors are: red green yellow blue magenta cyan black white.
126 coloralmost
128 Definition of color name for almost critical resources (default:
129 cyan).
130 Allowed colors are: red green yellow blue magenta cyan black white.
131 colorcritical
133 Definition of color name for critical resources (default: red).
134 Allowed colors are: red green yellow blue magenta cyan black white.
135 pcp-atopsarflags
137 A list of default flags for pcp-atopsar can be defined here. The
138 flags that are allowed are 'S', 'x', 'C', 'M', 'H', 'a', 'A' and
139 the flags to select one or more specific reports.
140 An example of the /etc/atoprc or ~/.atoprc file:
142 flags Aaf
145 interval 5
146 username
147 procname
148 maxlinecpu 4
149 maxlinedisk 10
150 maxlineintf 5
151 cpucritperc 80
152 almostcrit 90
153 pcp-atopsarflags CMH
154 ownprocline PID:50 VGROW:40 RGROW:45 COMMAND-LINE:50
155 ownpagline PAGSCAN:3 BLANKBOX:0 PAGSWIN:3 PAGSWOUT:7
156 The keywords 'ownprocline' and 'ownpagline' are explained in the subse‐
158 quent section.
159
161 Via the rcfile it is possible to define the layout of the output lines
162 yourself, i.e. you can define the layout of one line with process
163 information with the keyword 'ownprocline' (to be selected with the key
164 'o' or the flag -o) and you can redefine all lines with system informa‐
165 tion.
166 The layout of an output-line can be defined as follows (notice that
168 this should be specified as one line in the rcfile):
169 keyword <columnid>:<prio> [<columnid>:<prio> ...]
171 The columnid is the symbolic name of a column that should shown at this
173 position in the output line.
174 The prio is a positive integer value that determines which columns have
175 precedence whenever not all specified columns fit into the current
176 screen-width. The higher value, the higher priority.
177 The column-specifications should be separated by a space. The order in
178 which columns have been specified is the order in which they will be
179 shown, with respect to their priority (columns that do not fit, will be
180 dropped dynamically).
181 A special columnid for system lines is 'BLANKBOX'. This indicates that
183 an empty column is required at this position. Also this special colum‐
184 nid is followed by a priority (usually low).
185 The following definition can be specified for process information:
187 ownprocline
189 The columnids are the names of the columns that are shown in the
190 normal output of the process-related lines that are shown by pcp-
191 atop such as 'PID', 'CMD', 'S', .... The only exception is the
192 special columnid 'SORTITEM' that is used to show one of the columns
193 CPU%/DSK%/MEM%/NET%, depending on the chosen sort-criterium.
194 An example of a user-defined process line:
195 ownprocline PID:20 PPID:10 SYSCPU:15 USRCPU:15 VGROW:14
197 VSIZE:12 RGROW:14 RSIZE:12 ST:8 EXC:7 S:11 SORTITEM:18 CMD:20
198 The following definitions are used internally by pcp-atop as the
200 default system lines (you can redefine each of them in the rcfile as
201 one line):
202 ownsysprcline
204 Redefinition of line labeled with 'PRC':
205 ownsysprcline PRCSYS:8 PRCUSER:8 BLANKBOX:0 PRCNPROC:7 PRCN‐
207 ZOMBIE:5 PRCCLONES:4 BLANKBOX:0 PRCNNEXIT:6
208 ownallcpuline
210 Redefinition of line labeled with 'CPU' for total CPU-utilization:
211 ownallcpuline CPUSYS:8 CPUUSER:7 CPUIRQ:4 BLANKBOX:0 CPUI‐
213 DLE:5 CPUWAIT:6 BLANKBOX:0 CPUSTEAL:1 CPUGUEST:3
214 ownonecpuline
216 Redefinition of line labeled with 'CPU' for utilization of one CPU:
217 ownonecpuline CPUISYS:8 CPUIUSER:7 CPUIIRQ:4 BLANKBOX:0 CPUI‐
219 IDLE:5 CPUIWAIT:6 BLANKBOX:0 CPUISTEAL:1 CPUIGUEST:3
220 owncplline
222 Redefinition of line labeled with 'CPL':
223 owncplline CPLAVG1:4 CPLAVG5:3 CPLAVG15:2 BLANKBOX:0 CPLCSW:6
225 CPLINTR:5 BLANKBOX:0 CPLNUMCPU:1
226 ownmemline
228 Redefinition of line labeled with 'MEM':
229 ownmemline MEMTOT:2 MEMFREE:5 MEMCACHE:3 MEMDIRTY:1 MEM‐
231 BUFFER:3 MEMSLAB:3 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0
232 ownswpline
234 Redefinition of line labeled with 'SWP':
235 ownswpline SWPTOT:3 SWPFREE:4 BLANKBOX:0 BLANKBOX:0
237 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 SWPCOMMITTED:5 SWP‐
238 COMMITLIM:6
239 ownpagline
241 Redefinition of line labeled with 'PAG':
242 ownpagline PAGSCAN:3 PAGSTALL:1 BLANKBOX:0 PAGSWIN:4
244 PAGSWOUT:3
245 owndskline
247 Redefinition of lines labeled with 'LVM', 'MDD' and 'DSK':
248 owndskline DSKNAME:8 DSKBUSY:7 DSKNREAD:6 DSKNWRITE:6
250 DSKKBPERRD:4 DSKKBPERWR:4 DSKMBPERSECRD:5 DSKMBPERSECWR:5
251 DSKAVQUEUE:1 DSKAVIO:5
252 ownnettrline
254 Redefinition of line labeled with 'NET' for transport:
255 ownnettrline NETTRANSPORT:9 NETTCPI:8 NETTCPO:8 NETUDPI:8
257 NETUDPO:8 NETTCPACTOPEN:6 NETTCPPASVOPEN:5 NETTCPRETRANS:4
258 NETTCPINERR:3 NETTCPORESET:20 NETUDPNOPORT:1 NETUDPINERR:3
259 ownnetnetline
261 Redefinition of line labeled with 'NET' for network:
262 ownnetnetline NETNETWORK:5 NETIPI:4 NETIPO:4 NETIPFRW:4
264 NETIPDELIV:4 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 NETICMPIN:1 NET‐
265 ICMPOUT:1
266 ownnetifline
268 Redefinition of line labeled with 'NET' for interfaces:
269 ownnetifline NETNAME:8 NETPCKI:7 NETPCKO:7 NETSPEEDIN:6 NET‐
271 SPEEDOUT:6 NETCOLLIS:3 NETMULTICASTIN:2 NETRCVERR:5 NETSNDERR:5
272 NETRCVDROP:4 NETSNDDROP:4
273 The lines above are shown in the order as shown by pcp-atop in combina‐
275 tion with the -f flag (in a very wide window you should be able to see
276 all of the columns).
277
279 pcp(1), pcp-atop(1), pcp-atopsar(1) and PCPIntro(1).
280Performance Co-Pilot PCP PCP-ATOPRC(5)