PCP2PDF(1)

📦 version 0.3, in fedora 43, fedora 44

💖 PCP2PDF 💖

okay bestie, welcome to pcp2pdf — it's a PCP manual page, and honestly? she's that girl. sit down, grab a strawberry 🍓, let's get into it.

✨ NAME ✨

pcp2pdf — literally just the pcp2pdf docs, but make it cute. no cap, this is the whole vibe: it makes PDFs out of PCP archives. 🦋

🌸 SYNOPSIS 🌸

pcp2pdf [options] -a <pcparchive>

💅 DESCRIPTION 💅

okay so here's the tea: pcp2pdf generates a pdf report from a PCP archive. iconic behaviour, honestly. 💖

per default, the report contains a graph plotting each metric and its corresponding frequency histogram. and by default, all the metrics contained in the archive will be plotted — she does not do half measures, she is main character energy 👑.

in order to limit or augment the plotted metrics in the report, use the --include, --exclude or --custom options. that's the trio, the holy trinity, the girl group. 🎀

⚠️ important bestie: pcp2pdf only operates on PCP archive files and cannot use live data. so don't come for her with live data, she will not answer. 💀

also: pcp2pdf needs a locally running pmcd in order to fetch the help text of each metric. without it running, the report won't have metrics help text. so no pmcd, no help text — it's giving "you get what you get". 🙈

✨ OPTIONS ✨

she's got range, let's go one by one 🫶

  • -a <archivefile> — sets the PCP archive name to be parsed. that's the whole thing, that's the input, the moment.
  • -i <metrics>, --include <metrics> — includes metrics which match the specified regular expression. for example:
--include 'network.*'

will include only metrics starting with 'network.'. the option can be specified multiple times. if only --include is specified, only the matching metrics will be included in the output. if both --include and --exclude are specified, first all excluded metrics are evaluated, and then the ones explicitly included. order matters bestie, do not skip that part. 🔥

  • -e <metrics>, --exclude <metrics> — excludes metrics which match the specified regular expression. for example:
--exclude 'proc.*'

will exclude all metrics starting with 'proc.'. the option can be specified multiple times. if only --exclude is specified, all metrics are shown except the specified ones. so she's inclusive until you tell her not to be 💜

  • -c <graphs>, --custom <graphs> — adds custom graphs with multiple metrics. this is where it gets fun. for example:
--custom 'traffic:network.tcp.outrsts:.*,network.tcp.ofoqueue.*,network.interfaces.out.*:eth[0-9]'

will create a 'traffic' page with each matched metric and the corresponding matched indom single graph. the general syntax is the following:

--custom '<label>:<metric1_regex>:<indom1_regex>,...<metricN_regex>:<indomN_regex>'

the option can be specified multiple times. this makes it easy to try and correlate metrics that normally would not appear on the same graph. the different metrics' values need to be in similar scales or the graph will be not too useful. so like... vibe check your units first, bestie 😭

  • -o <filename>, --output <filename> — output file name. default is output.pdf. yes, the default really is just output.pdf, she's not doing a whole naming ceremony. 🎀
  • -r, --raw — disable rate conversion. disables the rateconversion for all the metrics that have the PM_SEM_COUNTER semantic associated with them. by default those are converted via the following formula:
(value(T) - value(T-1)) / (T - T-1)

by setting this option the aforementioned conversion will not take place. raw data, no filter, no editing 💅

  • -l <labels>, --label <labels> — adds one or more labels to a graph at specified time. for example:
--label 'foo:2014-01-01 13:45:03' --label 'bar:2014-01-02 13:15:15'

will add two extra labels on every graph at those times. this is usually useful for correlation analysis. the time format is specified in the PCPIntro(1) man page. go read that one too, she said so 🫶

  • -S <time>, --start <time> — sets the start of the time for the analysis. see PCPIntro(1) for the accepted time formats. for example:
--start "Fri Oct 10 22:10:12.362 2014"
  • -T <time>, --finish <time> — sets the end of the time window. see PCPIntro(1) for the accepted time formats. for example:
--finish "Sat Oct 11 01:00:00.00 2014"
  • -t <interval>, --interval <interval> — sets the sampling interval. see PCPIntro(1) for the accepted interval formats. for example:
--interval "14 minute"
  • -n, --nohistogram — disable the frequency histogram graphs (they're enabled by default, so this is the "no thanks, I'm good" button). 🌈
  • -V, --version — display version number and exit. quick lil flex, then she's out. ✨
  • --help — show the usage message and exit. when in doubt, ask her nicely. 💖

👀 SEE ALSO 👀

🌐 HOMEPAGE 🌐

homepage: http://github.com/performancecopilot/pcp2pdf

reporting issues: http://github.com/performancecopilot/pcp2pdf/issues

go tell her your problems, she reads them, she's listening bestie 🫶

👑 AUTHOR 👑

Michele Baldessari — the icon, the legend, the moment. 💜

2014, Michele Baldessari

and that's the whole page, bestie!! you ate that. 🍓✨

this was pcp2pdf version 0.3, dated June 01, 2015 — yeah she's vintage, she's an archive herself, and she's still serving. no cap. 💅🎀🦋

📦 where this page comes from