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  [-adehIilLmMrstxzV?]   [-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  lo‐
21       cal 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  as‐
52            sociated 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       -I, --on-disk-insts
60            Display  the  on-disk  instance domains, which may use a different
61            format and encoding than the one  visible  above  the  Performance
62            Metrics Programming Interface (PMAPI) when using pmGetInDom(3) and
63            related routines.  The on-disk format is only of interest when in‐
64            vestigating the internal structure of PCP archives.
65
66       -l, --label
67            Dump  the  archive label, showing the log format version, the time
68            and date for the start and (current) end of the archive,  and  the
69            host from which the performance metrics values were collected.
70
71       -L   Like -l, just a little more verbose.
72
73       -m, --metrics
74            Print  the  values  for  the performance metrics from the archive.
75            This is the default display option.
76
77            Metrics without an instance domain are reported as:
78              [timestamp] metric-id (metric-name): value1 value2
79
80            Metrics with an instance domain are reported as:
81              [timestamp] metric-id (metric-name):
82                  inst [internal-id or "external-id"] value1 value2
83
84            The timestamp is only reported for the first metric in a group  of
85            metrics sharing the same timestamp.
86
87       -M, --markrecs
88            If  no  metricname  is  specified then <mark> records are reported
89            when they are found in the archive.  If metricname  arguments  are
90            specified,  then  <mark> records are not reported by default.  The
91            -M option forces <mark> records to be reported, even when  metric‐
92            name arguments are specified.
93
94            <mark> records are inserted into a PCP archive log by pmlogger(1),
95            pmlogextract(1), and similar tools to indicate a temporal  discon‐
96            tinuity in the time-series of metric values.
97
98       -n pmnsfile, --namespace=pmnsfile
99            Load  an alternative Performance Metrics Name Space (PMNS(5)) from
100            the file pmnsfile.
101
102       -r, --reverse
103            Process the archive in reverse order, from most recent  to  oldest
104            recorded metric values.
105
106       -s, --sizes
107            Report the size in bytes of each physical record in the archive.
108
109       -S starttime, --start=starttime
110            When  using  the -m option, the report will be restricted to those
111            records logged at or after starttime.  Refer to PCPIntro(1) for  a
112            complete description of the syntax for starttime.
113
114       -t   Dump the temporal index that is used to provide accelerated access
115            to large archive files.
116
117            The integrity of the index will also be checked.  If the index  is
118            found  to be corrupted, the ``*.index'' file can be renamed or re‐
119            moved and the archive will still be accessible, however retrievals
120            may  take longer without the index.  Note however that a corrupted
121            temporal index is usually indicative of a deeper malaise that  may
122            infect all files in a PCP archive.
123
124       -T endtime, --finish=endtime
125            When  using  the -m option, the report will be restricted to those
126            records logged before or at endtime.  Refer to PCPIntro(1)  for  a
127            complete description of the syntax for endtime.
128
129       -v file
130            Verbose  mode.   Dump  the records from a physical archive file in
131            hexadecimal format.  In this case file is the  name  of  a  single
132            file, usually a basename (as would otherwise appear as the archive
133            command line argument), concatenated with ``.'' followed by one of
134            meta  (the  metadata), index (the temporal index), or a digit (one
135            of the volumes of metric values).
136
137            Use of -v precludes the use of all other options and arguments.
138
139       -V, --version
140            Display version number and exit.
141
142       -x   Extended timestamp reporting format that includes the day  of  the
143            week,  day  of  the  month, month and year in addition to the (de‐
144            fault) hours, minutes and seconds time.  This is  useful  for  ar‐
145            chives that span multiple days.
146
147            A  second  -x  option  will also report the timestamp as an offset
148            from the start of the archive in units of seconds.  This is useful
149            in  conjunction  with  debug diagnostics from the archive handling
150            routines in libpcp.
151
152       -z, --hostzone
153            Change the timezone to the local timezone at the host that is  the
154            source  of  the  performance  metrics,  as  specified in the label
155            record of the archive log.
156
157       -Z timezone, --timezone=timezone
158            By default, pmdumplog reports the time of day according to the lo‐
159            cal  timezone on the system where pmdumplog is run.  The -Z option
160            changes the timezone to timezone in the format of the  environment
161            variable TZ as described in environ(7).
162
163       -?, --help
164            Display usage message and exit.
165

FILES

167       $PCP_LOG_DIR/pmlogger/<hostname>
168            Default  directory  for PCP archives containing performance metric
169            values collected from the host hostname.
170

PCP ENVIRONMENT

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

SEE ALSO

179       PCPIntro(1),  pmlogcheck(1),  pmlogger(1),  pmlogger_check(1),   pmlog‐
180       ger_daily(1),  pmloglabel(1), pmlogextract(1), PMAPI(3), pmGetInDom(3),
181       pmLookupDesc(3), pcp.conf(5), pcp.env(5) and PMNS(5).
182
183
184
185Performance Co-Pilot                  PCP                         PMDUMPLOG(1)
Impressum