table of contents
PCP-COLLECTL(1) | General Commands Manual | PCP-COLLECTL(1) |
NAME¶
pmcollectl, pcp-collectl - collect data that describes the current system status
SYNOPSIS¶
pcp collectl [-f file | -p file ...] [options ...]
DESCRIPTION¶
Note: this command is deprecated, and will be removed in the next major PCP release. The pmrep(1) command provides equivalent functionality via its collectl configuration files.
pcp-collectl is a system-level performance monitoring utility that records or displays specific operating system data for one or more sets of subsystems. Any of the subsystems (such as CPU, Disks, Memory or Sockets) can be included or excluded from data collection. Data can either be displayed immediately to a terminal, or stored in files for retrospective analysis.
pcp-collectl is a python(1) script providing much of the functionality available from the collectl(1) Linux utility (which happens to be written in perl(1)).
It makes use of the Performance Co-Pilot (PCP) toolkit to simplify its implementation, as well as provide more of the collectl functionality on platforms other than Linux.
pcp-collectl has two primary modes of operation:
- 1.
- Record Mode (-f or --filename option) which reads data from a live system and writes output to a file or displays it on a terminal.
- 2.
- Playback Mode (-p or -a option) which reads data from one or more PCP archive files and displays output on a terminal. Note that these files are not raw collectl format data, rather they are archives created by the pmlogger(1) utility (possibly indirectly, through use of the -f option to pcp-collectl).
RECORD MODE OPTIONS¶
In this mode data is taken from a live system and either displayed on the terminal or written to a PCP archive.
-h host
-c, --count samples
-f, --filename filename
-i, --interval interval
PLAYBACK MODE OPTIONS¶
In this mode, data is read from one or more PCP data files that were generated with the recording option, or indirectly via the pmlogger utility.
-f, --filename filename
-p, --playback filename
-a, --archive filename
COMMON OPTIONS¶
The following options are supported in both record and playback modes.
--help
-s, --subsys subsystem
The default is "cdn", which stands for CPU, Disk and Network summary data.
c - CPU
d - Disk
f - NFS V3 Data
j - Interrupts
m - Memory
n - Networks
This is the set of detail data from which in most cases the corresponding summary data is derived. So, if one has 3 disks and chooses -sd, one will only see a single total taken across all 3 disks. If one chooses -sD, individual disk totals will be reported but no totals.
C - CPU
D - Disk
F - NFS Data
J - Interrupts
M - Memory node data, which is also known as NUMA data
N - Networks
--verbose
SEE ALSO¶
PCPIntro(1), collectl(1), collectl2pcp(1), perl(1), python(1), pmlogger(1), pmcd(1), pmafm(1), pmprobe(1), pmrep(1), PMAPI(3), and pcp.conf(5).
PCP | Performance Co-Pilot |