1PMDUMPLOG(1)                General Commands Manual               PMDUMPLOG(1)
2
3
4

NAME

6       pmdumplog - dump internal details of a performance metrics archive log
7

SYNOPSIS

9       pmdumplog  [-adehilLmMrstxzV?]   [-n  pmnsfile] [-S starttime] [-T end‐
10       time] [-Z timezone] archive [metricname ...]
11       pmdumplog [-v file]
12

DESCRIPTION

14       pmdumplog dumps assorted control, metadata, index and state information
15       from  the  files  of a Performance Co-Pilot (PCP) archive log.  The ar‐
16       chive log has the base name archive and must have been previously  cre‐
17       ated using pmlogger(1).
18
19       Normally pmdumplog operates on the distributed Performance Metrics Name
20       Space (PMNS), however if the -n  option  is  specified  an  alternative
21       local PMNS is loaded from the file pmnsfile.
22
23       If  any  metricname  arguments appear, the report will be restricted to
24       information relevant to the named performance metrics.   If  metricname
25       is  a non-leaf node in the namespace (see PMNS(5)), then pmdumplog will
26       recursively descend the archive's namespace  and  report  on  all  leaf
27       nodes.
28
29       Command line options control the specific information to be reported.
30

OPTIONS

32       The available command line options are:
33
34       -a, --all
35            Report  almost  everything,  i.e. the flags -d, -i, -L, -m, -s and
36            -t.  The optional help text (-h) and label metadata  strings  (-e)
37            are not reported by default.
38
39       -d, --descs
40            Display  the  metadata and descriptions for those performance met‐
41            rics that appear at least once in the archive: see pmLookupDesc(3)
42            for more details on the metadata describing metrics.
43
44       -e, --labelsets
45            Display  the  label metadata if it is present in the archive.  See
46            pmLookupLabels(3) for more details on the label metadata hierarchy
47            associated with metrics.
48
49       -h, --helptext
50            Display metric and instance domain help text if present in the ar‐
51            chive.  See pmLookupText(3) for more  details  on  the  help  text
52            associated with metrics.
53
54       -i, --insts
55            Display the instance domains, and any variations in their instance
56            members over the duration of the archive:  see  pmGetInDom(3)  for
57            more details on instance domains.
58
59       -l, --label
60            Dump  the  archive label, showing the log format version, the time
61            and date for the start and (current) end of the archive,  and  the
62            host from which the performance metrics values were collected.
63
64       -L   Like -l, just a little more verbose.
65
66       -m, --metrics
67            Print  the  values  for  the performance metrics from the archive.
68            This is the default display option.
69
70            Metrics without an instance domain are reported as:
71              [timestamp] metric-id (metric-name): value1 value2
72
73            Metrics with an instance domain are reported as:
74              [timestamp] metric-id (metric-name):
75                  inst [internal-id or "external-id"] value1 value2
76
77            The timestamp is only reported for the first metric in a group  of
78            metrics sharing the same timestamp.
79
80       -M, --markrecs
81            If  no  metricname  is  specified then <mark> records are reported
82            when they are found in the archive.  If metricname  arguments  are
83            specified,  then  <mark> records are not reported by default.  The
84            -M option forces <mark> records to be reported, even when  metric‐
85            name arguments are specified.
86
87            <mark> records are inserted into a PCP archive log by pmlogger(1),
88            pmlogextract(1), and similar tools to indicate a temporal  discon‐
89            tinuity in the time-series of metric values.
90
91       -r, --reverse
92            Process  the  archive in reverse order, from most recent to oldest
93            recorded metric values.
94
95       -s, --sizes
96            Report the size in bytes of each physical record in the archive.
97
98       -S starttime, --start=starttime
99            When using the -m option, the report will be restricted  to  those
100            records  logged at or after starttime.  Refer to PCPIntro(1) for a
101            complete description of the syntax for starttime.
102
103       -t   Dump the temporal index that is used to provide accelerated access
104            to large archive files.
105
106            The  integrity of the index will also be checked.  If the index is
107            found to be corrupted, the ``*.index''  file  can  be  renamed  or
108            removed   and  the  archive  will  still  be  accessible,  however
109            retrievals may take longer without the index.  Note however that a
110            corrupted temporal index is usually indicative of a deeper malaise
111            that may infect all files in a PCP archive.
112
113       -T endtime, --finish=endtime
114            When using the -m option, the report will be restricted  to  those
115            records  logged  before or at endtime.  Refer to PCPIntro(1) for a
116            complete description of the syntax for endtime.
117
118       -v file
119            Verbose mode.  Dump the records from a physical  archive  file  in
120            hexadecimal  format.   In  this  case file is the name of a single
121            file, usually a basename (as would otherwise appear as the archive
122            command line argument), concatenated with ``.'' followed by one of
123            meta (the metadata), index (the temporal index), or a  digit  (one
124            of the volumes of metric values).
125
126            Use of -v precludes the use of all other options and arguments.
127
128       -V, --version
129            Display version number and exit.
130
131       -x   Extended  timestamp  reporting format that includes the day of the
132            week, day of  the  month,  month  and  year  in  addition  to  the
133            (default) hours, minutes and seconds time.  This is useful for ar‐
134            chives that span multiple days.
135
136            A second -x option will also report the  timestamp  as  an  offset
137            from the start of the archive in units of seconds.  This is useful
138            in conjunction with debug diagnostics from  the  archive  handling
139            routines in libpcp.
140
141       -z, --hostzone
142            Change  the timezone to the local timezone at the host that is the
143            source of the performance  metrics,  as  specified  in  the  label
144            record of the archive log.
145
146       -Z timezone, --timezone=timezone
147            By  default,  pmdumplog  reports  the time of day according to the
148            local timezone on the system  where  pmdumplog  is  run.   The  -Z
149            option changes the timezone to timezone in the format of the envi‐
150            ronment variable TZ as described in environ(7).
151
152       -?, --help
153            Display usage message and exit.
154

FILES

156       $PCP_LOG_DIR/pmlogger/<hostname>
157              Default directory for PCP archives containing performance metric
158              values collected from the host hostname.
159

PCP ENVIRONMENT

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

SEE ALSO

168       PCPIntro(1),   pmlogcheck(1),  pmlogger(1),  pmlogger_check(1),  pmlog‐
169       ger_daily(1), pmloglabel(1), pmlogextract(1), PMAPI(3),  pmGetInDom(3),
170       pmLookupDesc(3), pcp.conf(5), pcp.env(5) and PMNS(5).
171
172
173
174Performance Co-Pilot                  PCP                         PMDUMPLOG(1)
Impressum