Scroll to navigation

PCP-ATOPRC(5) File Formats Manual PCP-ATOPRC(5)

NAME

pcp-atoprc - pcp-atop and pcp-atopsar resource file

DESCRIPTION

This manual page documents the resource file of thepcp-atopandpcp-atopsarcommands.These commands can be used to monitor the system and process load on asystem.

The pcp-atoprc file contains the default settings. These settings are readduring startup, first from the system-wide rcfile/etc/atoprcand after that from the user-specific rcfile~/.atoprc(so system-wide settings can be overruled by an individual user).The options in both rcfiles are identical.

OPTIONS

The rcfile contains keyword-value pairs, one on every line (blank linesand lines starting with a #-sign are ignored).
The following keywords can be specified:

A list of default flags forpcp-atopcan be defined here. The flags which are allowedare 'B', 'H', 'g', 'm', 'd', 'n', 'u', 'p', 's', 'c', 'v','C', 'M', 'D', 'N', 'A','a', 'y', 'f', 'F', 'G', 'R', '1', 'e', 'E' and 'x'.
The default interval value in seconds.
The length of a screen line when sending output to a file or pipe (default 80).
The default regular expression for the users for which activeprocesses will be shown.
The default regular expression for the process names to be shown.
The maximum number of active CPUs that will be shown.
The maximum number of active GPUs that will be shown.
The maximum number of active logical volumes that will be shown.
The maximum number of active multiple devices that will be shown.
The maximum number of active disks that will be shown.
The maximum number of NFS mounts that will be shown on an NFS client.
The maximum number of active network interfaces that will be shown.
The maximum number of active containers that will be shown.
The busy percentage considered critical for a processor(see section COLORS in the man-page of thepcp-atopcommand).This percentage is used to determinea weighted percentage for line coloring and sorting of active processesin text mode.When this value is zero, no line coloring or automatic sorting is performedfor this resource.
The busy percentage considered critical for a disk(see section COLORS in the man-page of thepcp-atopcommand).This percentage is used to determinea weighted percentage for line coloring and sorting of active processesin text mode.When this value is zero, no line coloring or automatic sorting is performedfor this resource.
The busy percentage considered critical for a network interface(see section COLORS in the man-page of thepcp-atopcommand).This percentage is used to determinea weighted percentage for line coloring and sorting of active processesin text mode.When this value is zero, no line coloring or automatic sorting is performedfor this resource.
The percentage considered critical for memory utilization(see section COLORS in the man-page of thepcp-atopcommand).This percentage is used to determinea weighted percentage for line coloring and sorting of active processesin text mode.When this value is zero, no line coloring or automatic sorting is performedfor this resource.
The occupation percentage considered critical for swap space(see section COLORS in the man-page of thepcp-atopcommand).This percentage is used to determinea weighted percentage for line coloring and sorting of active processes.When this value is zero, no line coloring or automatic sorting is performedfor this resource.
The number of pages swapped out per second considered critical forfor memory utilization(see section COLORS in the man-page of thepcp-atopcommand).This threshold is used in combination with 'memcritperc' to determine aweighted percentage for line coloring and sorting of active processes.When this value is zero, no line coloring or automatic sorting is performedfor this resource.
A percentage of the critical percentage to determine if the resourceis almost critical(see section COLORS in the man-page of thepcp-atopcommand).When this value is zero, no line coloring for `almost critical' isperformed.
Number of columns used per bar in the processor bar graph.The default value is 0 which means that the bar width willbe scaled automatically (the wider the terminal, the morecolumns per bar up to a maximum of three).With the value 1, 2 or 3 the number of bars can be staticallypinned to that number of columns, with one column of whitespace in between the bars.
Definition of color name for information messages (default: green)in text mode.
Allowed colors are: red green yellow blue magenta cyan black white.
Definition of color name for thread-specific lines when usingthe 'y' option (default: yellow).
Allowed colors are: red green yellow blue magenta cyan black white.
Definition of color name for almost critical resources (default: cyan)in text mode.
Allowed colors are: red green yellow blue magenta cyan black white.
Definition of color name for critical resources (default: red)in text mode.
Allowed colors are: red green yellow blue magenta cyan black white.
A list of default flags forpcp-atopsarcan be defined here. The flags that are allowedare 'S', 'x', 'C', 'M', 'H', 'a', 'A' and the flags to selectone or more specific reports.

An example of the/etc/atoprcor~/.atoprcfile:

 

flags         Aaf
interval      5
username
procname
maxlinecpu    4
maxlinedisk   10
maxlineintf   5
cpucritperc   80
almostcrit    90
pcp-atopsarflags  CMH
ownprocline   PID:50 VGROW:40 RGROW:45 COMMAND-LINE:50
ownpagline    PAGSCAN:3 BLANKBOX:0 PAGSWIN:3 PAGSWOUT:7

The keywords 'ownprocline' and 'ownpagline' are explained in thesubsequent section.

OWNDEFINITIONOFOUTPUTLINE

Via the rcfile it is possible to define the layout of the output linesyourself, i.e. you can define the layout of one line with process informationwith the keyword 'ownprocline' (to be selected with the key 'o'or the flag -o) and you can redefine all lines with system information.

The layout of an output-line can be defined as follows(notice that this should be specified as one line in the rcfile):

   keyword   <columnid>:<prio> [<columnid>:<prio> ...]

Thecolumnidis the symbolic name of a column that should shown at this positionin the output line.
Thepriois a positive integer value that determines which columns have precedencewhenever not all specified columns fit into the current screen-width.The higher value, the higher priority.
The column-specifications should be separated by a space. The orderin which columns have been specified is the order in which they will beshown, with respect to their priority (columns that do not fit, will bedropped dynamically).

A special columnid for system lines is 'BLANKBOX'. This indicatesthat an empty column is required at this position. Also thisspecial columnid is followed by a priority (usually low).

The following definition can be specified for process information:

The columnids are the names of the columns that are shown in thenormal output of the process-related lines that are shown bypcp-atopsuch as 'PID', 'CMD', 'S', ....The only exception is the special columnid 'SORTITEM' that is used toshow one of the columns CPU%/DSK%/MEM%/NET%, depending on the chosensort-criterion.
An example of a user-defined process line:
 
ownprocline   PID:20 PPID:10 SYSCPU:15 USRCPU:15VGROW:14 VSIZE:12 RGROW:14 RSIZE:12 ST:8 EXC:7 S:11 SORTITEM:18 CMD:20

The following definitions are used internally bypcp-atopas the default system lines (you can redefine each of them in thercfile as one line):

Redefinition of line labeled with 'PRC':
 
ownsysprcline   PRCSYS:8 PRCUSER:8 BLANKBOX:0 PRCNPROC:7 PRCNZOMBIE:5 PRCCLONES:4 BLANKBOX:0 PRCNNEXIT:6
Redefinition of line labeled with 'CPU' for total CPU-utilization:
 
ownallcpuline   CPUSYS:8 CPUUSER:7 CPUIRQ:4 BLANKBOX:0 CPUIDLE:5 CPUWAIT:6 BLANKBOX:0 CPUSTEAL:1 CPUGUEST:3
Redefinition of line labeled with 'CPU' for utilization of one CPU:
 
ownonecpuline   CPUISYS:8 CPUIUSER:7 CPUIIRQ:4 BLANKBOX:0 CPUIIDLE:5 CPUIWAIT:6 BLANKBOX:0 CPUISTEAL:1 CPUIGUEST:3
Redefinition of line labeled with 'CPL':
 
owncplline   CPLAVG1:4 CPLAVG5:3 CPLAVG15:2 BLANKBOX:0 CPLCSW:6 CPLINTR:5 BLANKBOX:0 CPLNUMCPU:1
Redefinition of line labeled with 'MEM':
 
ownmemline   MEMTOT:2 MEMFREE:5 MEMCACHE:3 MEMDIRTY:1 MEMBUFFER:3 MEMSLAB:3 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0
Redefinition of line labeled with 'SWP':
 
ownswpline   SWPTOT:3 SWPFREE:4 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 SWPCOMMITTED:5 SWPCOMMITLIM:6
Redefinition of line labeled with 'PAG':
 
ownpagline   PAGSCAN:3 PAGSTALL:1 BLANKBOX:0 PAGSWIN:4 PAGSWOUT:3
Redefinition of lines labeled with 'LVM', 'MDD' and 'DSK':
 
owndskline   DSKNAME:8 DSKBUSY:7 DSKNREAD:6 DSKNWRITE:6 DSKKBPERRD:4 DSKKBPERWR:4 DSKMBPERSECRD:5 DSKMBPERSECWR:5 DSKAVQUEUE:1 DSKAVIO:5
Redefinition of line labeled with 'NET' for transport:
 
ownnettrline   NETTRANSPORT:9 NETTCPI:8 NETTCPO:8 NETUDPI:8 NETUDPO:8 NETTCPACTOPEN:6 NETTCPPASVOPEN:5 NETTCPRETRANS:4 NETTCPINERR:3 NETTCPORESET:20 NETUDPNOPORT:1 NETUDPINERR:3
Redefinition of line labeled with 'NET' for network:
 
ownnetnetline   NETNETWORK:5 NETIPI:4 NETIPO:4 NETIPFRW:4 NETIPDELIV:4 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 NETICMPIN:1 NETICMPOUT:1
Redefinition of line labeled with 'NET' for interfaces:
 
ownnetifline   NETNAME:8 NETPCKI:7 NETPCKO:7 NETSPEEDIN:6 NETSPEEDOUT:6 NETCOLLIS:3 NETMULTICASTIN:2 NETRCVERR:5 NETSNDERR:5 NETRCVDROP:4 NETSNDDROP:4

The lines above are shown in the order as shown bypcp-atopin combination with the-fflag (in a very wide window you should be able to see all of the columns).

SEEALSO

pcp(1),pcp-atop(1),pcp-atopsar(1)andPCPIntro(1).

PCP Performance Co-Pilot