Package pcp-doc

Documentation and tutorial for the Performance Co-Pilot

Documentation and tutorial for the Performance Co-Pilot
Performance Co-Pilot (PCP) provides a framework and services to support
system-level performance monitoring and performance management.

The pcp-doc package provides useful information on using and
configuring the Performance Co-Pilot (PCP) toolkit for system
level performance management. It includes tutorials, HOWTOs,
and other detailed documentation about the internals of core
PCP utilities and daemons, and the PCP graphical tools.

General Commands
Command Description
chkhelp check performance metrics help text files
collectl2pcp import collectl data to a PCP archive
dbpmda debugger for Performance Co-Pilot PMDAs
dbprobe database response time and availability information
ganglia2pcp import ganglia data and create a PCP archive
genpmda Performance Co-Pilot PMDA Generator
iostat2pcp import iostat data and create a PCP archive
mkaf create a Performance Co-Pilot archive folio
mrtg2pcp import MRTG data and create a PCP archive
newhelp generate a performance metrics help database
pcp2elasticsearch pcp-to-elasticsearch metrics exporter
pcp2graphite pcp-to-graphite metrics exporter
pcp2influxdb pcp-to-influxdb metrics exporter
pcp2json pcp-to-json metrics exporter
pcp2spark pcp-to-spark metrics exporter
pcp2xlsx pcp-to-xlsx metrics exporter
pcp2xml pcp-to-xml metrics exporter
pcp2zabbix pcp-to-zabbix metrics exporter
pcp-atop Advanced System and Process Monitor
pcp-atopsar Advanced System Activity Report (pcp-atop related)
pcp-collectl collect data that describes the current system status
pcp-dmcache report on logical storage device caches
pcp-dstat versatile tool for generating system resource statistics
pcp-free report on free and used memory in the system
PCPIntro introduction to the Performance Co-Pilot (PCP)
pcp-iostat performance metrics i/o statistics tool
pcp-ipcs provide information on IPC facilities
pcp-kube-pods list Kubernetes pods to scan for running PCP services
pcp-mpstat Report CPU and Interrupt related statistics.
pcp-numastat report on NUMA memory allocation
pcp-pidstat Report statistics for Linux tasks.
pcp-python run a python script using a preferred python variant
pcp-shping report on shell service availability and response
pcp-tapestat performance metrics i/o tape statistics tool
pcp-uptime tell how long the system has been running
pcp-verify verify aspects of a PCP installation
pcp-vmstat high-level system performance overview
perfalloc notify pmdaperfevent(1) to disable hardware counter allocation.
pmafm Performance Co-Pilot archive folio manager
pmcd performance metrics collector daemon
pmcd_wait wait for PMCD to accept client connections
pmchart strip chart tool for Performance Co-Pilot
pmclient a simple performance metrics client
pmconfig Performance Co-Pilot configuration parameters
pmconfirm general purpose dialog box
pmcpp simple preprocessor for the Performance Co-Pilot
pmdaactivemq ActiveMQ performance metrics domain agent (PMDA)
pmdaaix operating system kernel performance metrics domain agents
pmdaapache Apache2 web server performance metrics domain agent (PMDA)
pmdabash Bourne-Again SHell trace performance metrics domain agent
pmdabcc BCC PMDA
pmdabind2 BIND performance metrics domain agent (PMDA)
pmdabonding Linux bonded interface performance metrics domain agent (PMDA)
pmdacifs Common Internet Filesystem (CIFS) PMDA
pmdacisco Cisco router performance metrics domain agent (PMDA)
pmdadbping database response time and availability PMDA
pmdadm Device Mapper PMDA
pmdadocker docker performance metrics domain agent (PMDA)
pmdads389 389 Directory Server PMDA
pmdads389log 389 Directory Server Log PMDA
pmdaelasticsearch elasticsearch performance metrics domain agent (PMDA)
pmdagfs2 Global Filesystem v2 (GFS2) PMDA
pmdagluster Gluster Filesystem PMDA
pmdagpfs gpfs filesystem statistics performance metrics domain agent (PMDA)
pmdagpsd gpsd performance metrics domain agent (PMDA)
pmdahaproxy HAProxy PMDA
pmdaib Infiniband performance metrics domain agent (PMDA)
pmdajbd2 journal block device (JBD) performance metrics domain agent (PMDA)
pmdajson JSON PMDA
pmdalibvirt libvirt PMDA
pmdalio Linux LIO subsystem PMDA
pmdalmsensors Linux hardware monitoring performance metrics domain agent (PMDA)
pmdalogger log file performance metrics domain agent (PMDA)
pmdalustre lustre filesystem statistics performance metrics domain agent (PMDA)
pmdalustrecomm Lustre filesystem comms performance metrics domain agent (PMDA)
pmdamailq mail queue performance metrics domain agent (PMDA)
pmdamemcache memcached performance metrics domain agent (PMDA)
pmdamic MIC card PMDA
pmdammv memory mapped values performance metrics domain agent (PMDA)
pmdamounts filesystem mounts performance metrics domain agent (PMDA)
pmdamysql MySQL and MariaDB database PMDA
pmdanamed BIND (named) PMDA
pmdanetfilter Linux netfilter IP connection tracking performance metrics domain agent (PMDA)
pmdanews sample Usenet news performance metrics domain agent (PMDA)
pmdanfsclient NFS client statistics performance metrics domain agent (PMDA)
pmdanginx nginx performance metrics domain agent (PMDA)
pmdanutcracker NutCracker performance metrics domain agent (PMDA)
pmdanvidia nvidia gpu metrics domain agent (PMDA)
pmdaoracle Oracle database PMDA
pmdapapi papi performance metrics domain agent (PMDA)
pmdapdns PowerDNS performance metrics domain agent (PMDA)
pmdaperfevent hardware performance counter performance metrics domain agent (PMDA)
pmdapipe command output capture performance metrics domain agent (PMDA)
pmdapodman podman container performance metrics domain agent (PMDA)
pmdapostfix Postfix performance metrics domain agent (PMDA)
pmdapostgresql PostgreSQL database PMDA
pmdaproc process performance metrics domain agent (PMDA)
pmdaprometheus Prometheus PMDA
pmdaredis Redis performance metrics domain agent (PMDA)
pmdaroomtemp room temperature performance metrics domain agent (PMDA)
pmdaroot a privileged PMCD helper performance metrics domain agent
pmdarsyslog rsyslog (reliable and extended syslog) PMDA
pmdasamba Samba performance metrics domain agent (PMDA)
pmdasample sample performance metrics domain agent (PMDA)
pmdasendmail sendmail performance metrics domain agent (PMDA)
pmdashping "shell-ping" performance metrics domain agent
pmdasimple simple performance metrics domain agent (PMDA)
pmdaslurm SLURM statistics performance metrics domain agent (PMDA)
pmdasmart S.M.A.R.T Data PMDA
pmdasnmp Gateway from SNMP to PCP (PMDA)
pmdasummary summary performance metrics domain agent (PMDA)
pmdasystemd systemd performance metrics domain agent (PMDA)
pmdate display an offset date
pmdatrace application-level transaction performance metrics domain agent
pmdatrivial trivial performance metrics domain agent (PMDA)
pmdatxmon txmon performance metrics domain agent (PMDA)
pmdaunbound Unbound resolver PMDA
pmdavmware VMware performance metrics domain agent (PMDA)
pmdaweblog performance metrics domain agent (PMDA) for Web server logs
pmdaxfs XFS filesystem performance metrics domain agent (PMDA)
pmdazimbra Zimbra Collaboration Suite (ZCS) PMDA
pmdazswap zswap (compressed swap) PMDA
pmdbg report Performance Co-Pilot debug options
pmdiff compares archives and report significant differences
pmdumplog dump internal details of a performance metrics archive log
pmdumptext dump performance metrics to an ASCII table
pmerr translate Performance Co-Pilot error codes into error messages
pmevent arbitrary performance metrics value dumper
pmfind find PCP services on the network
pmgenmap generate C code to simplify handling of performance metrics
pmgetopt Performance Co-Pilot shell script option parser
pmhostname report hostname
pmie inference engine for performance metrics
pmie2col convert pmie output to multi-column format
pmie_check administration of the Performance Co-Pilot inference engine
pmieconf display and set configurable pmie rule variables
pmiestatus display information from pmie stats file
pminfo display information about performance metrics
pmjson Performance Co-Pilot JSON dumping utility
pmlc configure active Performance Co-Pilot pmlogger(s) interactively
pmlock simple file-based mutex
pmlogcheck checks for invalid data in a PCP archive
pmlogconf create/edit a pmlogger configuration file
pmlogextract reduce, extract, concatenate and merge Performance Co-Pilot archives
pmlogger create archive log for performance metrics
pmlogger_check administration of Performance Co-Pilot archive log files
pmlogger_daily_report write Performance Co-Pilot daily summary reports
pmlogger_merge helper script to merge Performance Co-Pilot archives
pmlogger_rewrite helper script to rewrite Performance Co-Pilot archives
pmloglabel check and repair a performance metrics archive label
pmlogmv move (rename) Performance Co-Pilot archive files
pmlogreduce temporal reduction of Performance Co-Pilot archives
pmlogrewrite rewrite Performance Co-Pilot archives
pmlogsize report sizes for parts of PCP archive(s)
pmlogsummary calculate averages of metrics stored in a set of PCP archives
pmmgr pcp daemon manager
pmnewlog stop and restart archive logging for PCP performance metrics
pmnsadd add new names to the Performance Co-Pilot PMNS
pmnsdel delete a subtree of names from the Performance Co-Pilot PMNS
pmnsmerge merge multiple versions of a Performance Co-Pilot PMNS
pmpause portable subsecond-capable sleep
pmpost append messages to the Performance Co-Pilot notice board
pmprobe lightweight probe for performance metrics
pmproxy proxy for performance metrics collector daemon
pmpython run a python script using a preferred python variant
pmrep performance metrics reporter
pmseries display information about performance metric timeseries
pmsignal send a signal to one or more processes
pmsnap generate performance summary snapshot images
pmsocks shell wrapper for performance monitoring across firewalls
pmstore modify performance metric values
pmtime time control server for Performance Co-Pilot
pmtrace command line performance instrumentation
pmwebd web access to PCP
sar2pcp import sar data and create a PCP archive
telnet-probe lightweight telnet-like port probe
Library Functions
Library Function Description
LOGIMPORT introduction to the library for importing data and creating a PCP archive
mmv_inc_value update a value in a Memory Mapped Value file
mmv_lookup_value_desc find a value in the Memory Mapped Value file
mmv_stats2_init create and initialize Memory Mapped Value file
mmv_stats_registry Initialize the Memory Mapped Value file
PCPIntro introduction to the Performance Co-Pilot (PCP) libraries
__pmAddIPC IPC version infrastructure support
pmAddProfile add instance(s) to the current PMAPI instance profile
__pmAFblock event queue services for periodic asynchronous callbacks
PMAPI introduction to the Performance Metrics Application Programming Interface
PMAPI_INTERNAL internal details for the Performance Metrics Application Programming Interface
pmAtomStr convert a performance metric value into a string
pmClearDebug manipulate PCP debugging control options
pmClearFetchGroup simplified performance metrics value fetch and conversion
__pmConnectLogger connect to a performance metrics logger control port
__pmControlLog enable, disable or enquire about logging of performance metrics
__pmConvertTime convert tm structure to timeval structure
pmConvScale rescale a performance metric value
pmCtime format the date and time for a reporting timezone
PMDA introduction to the Performance Metrics Domain Agent support library
pmdaAttribute informs a PMDA about client connection attributes
pmdaCacheLookup manage a cache of instance domain information for a PMDA
pmdaChildren translate a PMID to a set of dynamic performance metric names
pmdaCloseHelp help text support for a PMDA
pmdaConnect establish a connection between a daemon PMDA and PMCD
pmdaDaemon initialize the PMDA to run as a daemon
pmdaDesc get the description of a metric from a PMDA
pmdaDSO initialize the PMDA to run as a DSO
pmdaEventAddHighResMissedRecord utilities for PMDAs to build packed arrays of event records
pmdaEventClients client context tracking interfaces for event queues
pmdaEventNewActiveQueue utilities for PMDAs managing event queues
pmdaExtSetFlags initialize a PMDA
pmdaFetch fill a pmResult structure with the requested metric values
pmdaGetContext generic PDU processing for a PMDA
pmdaGetOpt get options from arguments, parsing generic PMDA options
pmdaInstance return instance descriptions for a PMDA
pmdaInterfaceMoved reset internal state of a pmdaInterface structure
pmdaLabel fill pmdaLabelSet structures with metric labels
pmdaName translate a PMID to a set of dynamic performance metric names
pmdaOpenLog redirect stderr to a logfile
pmdaPMID translate a dynamic performance metric name into a PMID
pmdaProfile update instance profile for PMDA in preparation for the next fetch from PMCD
pmdaRootConnect privileged PCP collector services
pmdaSendError pmdaSendError
pmdaStore store a value into a metric for a PMDA
pmdaText extract metric help text for a PMDA
pmdatrace application-level performance instrumentation services
pmDelProfile delete instance(s) from the current PMAPI instance profile
pmDerivedErrStr return error message from failure to parse derived metric definition
pmDestroyContext destroy a PMAPI context
pmDiscoverServices discover PCP services on the network
pmDupContext duplicate a PMAPI context
pmErrStr convert a PMAPI error code into a string
pmEventFlagsStr convert an event record flags value into a string
pmExtractValue extract a performance metric value from a pmResult structure
pmFetch get performance metric values
pmFetchArchive get performance metrics directly from a set if archive logs
pmflush print formatted output in a window or to standard error
__pmFreeAttrsSpec host and attributes specification parser
pmFreeEventResult release storage allocated for unpacked event records
__pmFreeHostSpec uniform host specification parser
pmFreeLabelSets release storage allocated for performance metric labels
pmFreeMetricSpec uniform metric specification parser
pmFreeOptions command line handling for PMAPI tools
__pmFreeProfile free a PMAPI instance profile
pmFreeResult release storage allocated for performance metrics values
pmGetAPIConfig return values for Performance Co-Pilot configuration variables
pmGetArchiveEnd locate logical end of file for a set of archive logs
pmGetArchiveLabel fetch the label record from a set of performance metrics archive logs
pmGetChildren return the descendent nodes of a PMNS node
pmGetChildrenStatus return the descendent nodes of a PMNS node and their respective status
pmGetClusterLabels retrieve labels associated with performance metric values
pmGetContextHostName return the hostname associated with a Performance Co-Pilot context
pmGetInDom get instance identifiers for a performance metrics instance domain
pmGetInDomArchive get instance identifiers for a performance metrics instance domain
pmGetPMNSLocation determine the location of the currently used PMNS
pmGetProgname application name services
pmGetUsername fetch special PCP username
pmGetVersion fetch installed PCP version number
pmhttpClientFetch simple HTTP client interfaces
pmiAddInstance add an element to an instance domain in a LOGIMPORT context
pmiAddMetric add a new metric definition to a LOGIMPORT context
pmID_build helper methods for manipulating PMIDs
pmIDStr convert a performance metric identifier into a string
pmiEnd finish up a LOGIMPORT archive
pmiErrStr convert a LOGIMPORT error code into a string
pmiGetHandle define a handle for a metric-instance pair
pmiID construct core metric data structures
pmInDom_build helper methods for manipulating instance domain identifiers
pmInDomStr convert a performance metric instance domain identifier into a string
pmiPutLabel add labels to the output archive
pmiPutMark write a <mark> record to a PCP archive
pmiPutResult add a data record to a LOGIMPORT archive
pmiPutText add help text for an metric or instance domain
pmiPutValue add a value for a metric-instance pair
pmiPutValueHandle add a value for a metric-instance pair via a handle
pmiSetHostname set the source host name for a LOGIMPORT archive
pmiSetTimezone set the source timezone for a LOGIMPORT archive
pmiStart establish a new LOGIMPORT context
pmiUseContext change LOGIMPORT context
pmiWrite flush data to a LOGIMPORT archive
pmjsonGet JSON string helpers and metrics extraction
pmLoadASCIINameSpace establish a local PMNS for an application
pmLoadDerivedConfig load derived metric definitions from files
pmLoadNameSpace load a local PMNS for an application
__pmLocalPMDA change the table of DSO PMDAs for PM_CONTEXT_LOCAL contexts
pmLocaltime convert the date and time for a reporting timezone
pmLookupDesc obtain a description for a performance metric
pmLookupInDom translate an instance name into an instance identifier
pmLookupInDomArchive translate an instance name into an instance identifier
pmLookupInDomText return text describing a performance metrics instance domain
pmLookupName translate performance metric names into PMIDs
pmLookupText return text describing a performance metric
pmMergeLabelSets merge sets of performance metric labels
__pmMktime convert a tm structure to a calendar time
pmNameAll translate a PMID to a set of performance metric names
pmNameID translate a PMID to a performance metric name
pmNameInDom translate an instance identifier into an instance name
pmNameInDomArchive translate an instance identifier into an instance name
pmNewContext establish a new PMAPI context
pmNewContextZone establish a reporting timezone based on a PMAPI context
pmNewZone establish a reporting timezone
pmNoMem report out of memory conditions
pmNotifyErr standard handling of error messages
pmNumberStr fixed width output format for numbers
pmOpenLog create a log file for diagnostics and debug output
__pmParseCtime convert ctime(3) string to tm structure
__pmParseDebug manipulate old-style PCP debugging control bit-fields
pmParseInterval convert interval string to timeval structure
__pmParseTime parse time point specification
pmParseTimeWindow parse time window command line arguments
pmParseUnitsStr parse units specification
pmPathSeparator return the filesystem path separator character
pmPrintDesc print a metric descriptor
pmPrintHighResStamp helper routines for time stored as a struct timeval
pmPrintLabelSets print an array of label sets
pmPrintValue print a performance metric value
__pmProcessAddArg process execution support
__pmProcessClosePipe support for process execution at the end of a pipe
pmReconnectContext reconnect to a PMAPI context
pmRecordAddHost record mode support for PMAPI clients
pmRegisterDerived register a derived metric name and definition
pmSemStr convert a performance metric semantic into a string
pmSetMode set collection time parameters for the current PMAPI context
pmSetProcessIdentity set process user and group id
pmSortInstances sort performance metric values on instance identifier
pmSpecLocalPMDA process command-line argument for the table of DSO PMDAs
pmsprintf formatted string conversion
pmStore modify values of performance metrics
pmTimeConnect time control functions for synchronizing the archive position and update...
pmTraversePMNS traverse the performance metrics name space
pmTrimNameSpace prune a performance metrics name space
pmTypeStr convert a performance metric type into a string
pmUnitsStr convert a performance metric's units into a string
pmUnloadNameSpace unload a local performance metrics name space for an application
pmUnpackEventRecords unpack event records
pmUseContext change current PMAPI context
pmUseZone re-establish a reporting timezone
PMWEBAPI introduction to the Performance Metrics Web Application Programming Interface
pmWhichContext identify the current PMAPI context
pmWhichZone return current reporting timezone
QMC library for managing groups of Performance Co-Pilot metrics
QmcContext container for a PMAPI context and its metrics
QmcDesc container for a metric description
QmcGroup container representing a single fetch group of metrics from multiple sources
QmcIndom container for a instance domain description
QmcMetric container for a metric and all its values
QmcSource manages contexts created by all groups
zbxpcp Zabbix Agent Loadable PCP Module
File Formats
File Description
LOGARCHIVE performance metrics archive format
mmv Memory Mapped Values for Performance Co-Pilot
pcp-atoprc pcp-atop/pcp-atopsar related resource file
pcp.conf the Performance Co-Pilot configuration and environment file
pcp-dstat pcp-dstat configuration file
pcp.env script to set Performance Co-Pilot run-time environment variables
perfevent.conf the Performance Co-Pilot perfevent PMDA configuration file
pmieconf generalized pmie rules and customizations
pmns the performance metrics name space
pmrep.conf pmrep configuration file