1PCP2PDF(1)                          pcp2pdf                         PCP2PDF(1)
2
3
4

NAME

6       pcp2pdf - pcp2pdf Documentation
7

SYNOPSIS

9       pcp2pdf [options] -a <pcparchive>
10

DESCRIPTION

12       pcp2pdf  generates  a  pdf  report from a PCP archive. Per default, the
13       report contains a graph plotting each metric and its corresponding fre‐
14       quency  histogram.  By default all the metrics contained in the archive
15       will be plotted.  In order to limit or augment the plotted  metrics  in
16       the report, use the --include, --exclude or --custom options.
17
18       pcp2pdf only operates on PCP archive files and cannot use live data.
19
20       pcp2pdf needs a locally running pmcd in order to fetch the help text of
21       each metric. Without it running the  report  won't  have  metrics  help
22       text.
23

OPTIONS

25       -a <archivefile>
26              Sets the PCP archive name to be parsed
27
28       -i <metrics>, --include <metrics>
29              Includes  metrics  which match the specified regular expression.
30              For example:
31
32                 --include 'network.*'
33
34              will include only metrics starting with 'network.'.  The  option
35              can be specified multiple times. If only --include is specified,
36              only the matching metrics will be included  in  the  output.  If
37              both  --include  and --exclude are specified, first all excluded
38              metrics are evaluted, and then the ones explicitely included.
39
40       -e <metrics>, --exclude <metrics>
41              Excludes metrics which match the specified  regular  expression.
42              For example:
43
44                 --exclude 'proc.*'
45
46              will  exclude  all metrics starting with 'proc.'. The option can
47              be specified multiple times. If only --exclude is specified, all
48              metrics are shown except the specified ones.
49
50       -c <graphs>, --custom <graphs>
51              Add custom graphs with multiple metrics.  For example:
52
53                 --custom 'traffic:network.tcp.outrsts:.*,network.tcp.ofoqueue.*,network.interfaces.out.*:eth[0-9]'
54
55              will  create  a  'traffic' page with the each matched metric and
56              the corresponding matched indom single graph. The general syntax
57              is the following:
58
59                 --custom '<label>:<metric1_regex>:<indom1_regex>,...<metricN_regex>:<indomN_regex>'
60
61              The  option  can be specified multiple times. This makes it easy
62              to try and correlate metrics that normally would not  appear  on
63              the same graph. The different metrics' values need to be in sim‐
64              ilar scales or the graph will be not too useful.
65
66       -o <filename>, --output <filename>
67              Output file name (default: output.pdf)
68
69       -r, --raw
70              Disable rate conversion Disables the rateconversion for all  the
71              metrics  that  have  the PM_SEM_COUNTER semantic associated with
72              them. By default those are converted via the following formula
73
74                 (value(T) - value(T-1)) / (T - T-1)
75
76              By setting this option the aforementioned  conversion  will  not
77              take place.
78
79       -l <labels>, --label <labels>
80              Adds  one  or more labels to a graph at specified time For exam‐
81              ple:
82
83                 --label 'foo:2014-01-01 13:45:03' --label 'bar:2014-01-02 13:15:15'
84
85              will add two extra labels on every graph at those  times.   This
86              is  usually  useful for correlation analysis. The time format is
87              specified in the PCPIntro(1) man page.
88
89       -S <time>, --start <time>
90              Sets the start of the time for the analysis See PCPIntro(1)  for
91              the accepted time formats. For example:
92
93                 --start "Fri Oct 10 22:10:12.362 2014"
94
95       -T <time>, --finish <time>
96              Sets the end of the time window See PCPIntro(1) for the accepted
97              time formats. For example:
98
99                 --finish "Sat Oct 11 01:00:00.00 2014"
100
101       -t <interval>, --interval <interval>
102              Sets the sampling interval  See  PCPIntro(1)  for  the  accepted
103              interval formats. For example:
104
105                 --interval "14 minute"
106
107       -n, --nohistogram
108              Disable the frequency histogram graphs (enabled by default)
109
110       -V, --version
111              Display version number and exit
112
113       --help Show the usage message and exit
114

SEE ALSO

116       PCPIntro(1) pmcd(1)
117

HOMEPAGE

119       Homepage <http://github.com/performancecopilot/pcp2pdf Reporting issues
120       <http://github.com/performancecopilot/pcp2pdf/issues>
121

AUTHOR

123       Michele Baldessari
124

126       2014, Michele Baldessari
127
128
129
130
1310.3                              June 01, 2015                      PCP2PDF(1)
Impressum