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

FILES

130       $PCP_VAR_DIR/pmns/*
131                 default local PMNS specification files
132       $PCP_LOG_DIR/pmlogger/hostname
133                 Default directory for  PCP  archives  containing  performance
134                 metric values collected from the host hostname.
135

PCP ENVIRONMENT

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

SEE ALSO

144       PCPIntro(1),   pmlogcheck(1),  pmlogger(1),  pmlogger_check(1),  pmlog‐
145       ger_daily(1), pmloglabel(1), pmlogextract(1), PMAPI(3),  pmGetInDom(3),
146       pmLookupDesc(3), pcp.conf(5), pcp.env(5) and pmns(5).
147
148
149
150Performance Co-Pilot                  PCP                         PMDUMPLOG(1)
Impressum