PMAFM(1)

πŸ“¦
version 7.2.2 Β· 3 versions
, in arch rolling, centos-stream 10, centos-stream 9, debian trixie, fedora 43, fedora 44, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’… NAME πŸ’…

pmafm β€” the Performance Co-Pilot archive folio manager, bestie. This is a page from the General Commands Manual, and it's giving PMAFM(1) energy πŸŽ€


✨ SYNOPSIS ✨

pmafm folioname [command [arg ...]]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so picture this: you take one or more Performance Co-Pilot (PCP) archives, you combine them with a control file, and boom β€” you've got yourself a PCP archive folio. Iconic. Folios get created either with mkaf(1) or through the interactive ``record mode'' services of PCP clients like pmchart(1) πŸ’–

pmafm is the bestie that handles all the folio services. Like, it provides support for running PCP tools using one or more of the component archives inside an archive folio. That's the whole vibe.

Your target folio is identified by the folio control file folioname. The syntax for that control file is described over in mkaf(1) β€” go check it out, no cap.

If there's a command and arguments hanging out after folioname, they get interpreted and executed as a single command. If not? Then commands get read from standard input. Periodt.

The following commands are supported, and yes, we're going through all of them ✨

  • archives β€” subsequent commands apply to all archives in the folio.
  • archives N[,...] β€” archives within a folio are numbered 1, 2, etc. Subsequent commands are restricted to apply only to the designated archives.
  • archives name[,...] β€” archives within a folio have unique names. Subsequent commands are restricted to apply only to the designated archives.
  • check β€” validate the presence and format of each file in the folio and the component archives. Like a vibe check but for files 🫢
  • help β€” a brief reminder of the command syntax. And ? is a synonym for help, iykyk.
  • hosts β€” subsequent commands apply to all archives in the folio.
  • hosts hostname[,...] β€” subsequent commands are restricted to apply only to those archives that match the designated hostnames.
  • list [verbose] β€” display the contents of the folio. By default: the control header, plus the ordinal number, hostname and archive base name for each archive in the folio. The verbose option causes pmafm to dump the label record from each archive using pmlogdump -l.
    • The first named archive in the folio is assumed to be associated with the default host for any tool that tries to replay multiple archives from the folio. Noted πŸ“
  • quit β€” exit pmafm. bye bestie πŸ‘‹
  • remove β€” echo on standard output the sh(1) commands required to remove all of the physical files associated with this archive folio.
  • repeat tool [arg ...] β€” execute the known PCP tool once per selected archive. For example, the command
repeat pmval -t60 kernel.all.load

would run pmval(1) once per archive, with an appropriate -a argument.

  • replay β€” some archive folios are created by tools (e.g. pmchart(1)) that provide sufficient information to allow all of the information in all of the archives of a folio to be replayed.
  • [run] tool [arg ...] β€” execute the known PCP tool on the selected archives. Some PCP tools are able to process multiple concurrent archives, and in this case the tool is run once with the list of all selected archives passed via a -a argument. Otherwise, this command is synonymous with repeat.
  • selections β€” display those archives that would be selected for processing with a repeat, replay or run command.

The restrictions via any hosts and archives commands are conjuncted. These restrictions serve to limit the specific archives processed in the subsequent repeat, replay, run and selections commands. By default, all archives are selected πŸ’«

Keywords in commands may be abbreviated provided no ambiguity is introduced, e.g. help, hel and he are synonymous, but h is ambiguous. So close but so far 😭


πŸ“ FILES πŸ“

  • $PCP_VAR_DIR/config/pmafm/* β€” control files that define the behavior of each PCP tool known to pmafm. This information may be customized or extended, see $PCP_VAR_DIR/config/pmafm/pcp for documentation of the syntax and semantics of these files.
  • $HOME/.pcp/pmafm/* β€” user customization of the control files. All files in this directory are treated in the same manner as control files in the $PCP_VAR_DIR/config/pmafm directory.

🌈 PCP ENVIRONMENT 🌈

Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP. On each installation, the file /etc/pcp.conf contains the local values for these variables. The $PCP_CONF variable may be used to specify an alternative configuration file, as described in pcp.conf(5). Slay 🧚


πŸ‘‘ SEE ALSO πŸ‘‘

mkaf(1), pcp-atop(1), pmchart(1), pmlogdump(1), PMAPI(3), pmRecordSetup(3), pcp.conf(5) and pcp.env(5).


okay that's the whole page bestie, you ate πŸ’…βœ¨

and that's a wrap on this Performance Co-Pilot (PCP) PMAFM(1) page, from the General Commands Manual β€” go forth and manage those folios, main character πŸŽ€πŸ’–πŸ¦‹

πŸ“¦ where this page comes from