pcp-archive man page

pcp-archive — Archive Files for Performance Co-Pilot

Synopsis

$PCP_LOG_DIR/pmlogger/*/*.{meta,index,0}

$PCP_LOG_DIR/pmmgr/*/*.{meta,index,0}

Description

PCP log archives store volumes of historical values of arbitrary Performance Co-Pilot metrics recorded from a single host. Archives are self-contained in the sense that they contain all the important metadata that would be required for off-line or off-site analysis. The format is intended to be stable in order to allow long-term historical storage and processing by current tools. (Compatibility in the other direction - new files, old tools - is not as fully assured.)

Archives may be read by most PCP client tools, using the -a ARCHIVE option, or dumped raw by pmdumplog(1). Archives may be created by pmlogger(1) and bulk-import tools. Archives may be merged, analyzed, and subsampled using specialized tools such as pmlogsummary(1), pmlogreduce(1), pmlogrewrite(1), and pmlogextract(1). In addition, PCP archives may examined in sets or grouped together into PCP "archive folios", which are managed by the pmafm(1) tool.

PCP archives consist of several physical files that share a common arbitrary prefix, e.g., myarchive.

myarchive.0, myarchive.1, ...
Metric values. May grow rapidly.
myarchive.meta
Information for PMAPI functions such as pmLookupDesc(3) and pmGetInDom(3). May grow in fits and spurts, as logged instances and instance domains vary.
myarchive.index
A temporal index, mapping timestamps to offsets in the other files. Grows slowly.

Common Features

All three types of files have a similar record-based structure, a convention of network-byte-order (big-endian) encoding, and 32-bit fields for tagging/padding for those records. Strings are stored as 8-bit characters without assuming a specific encoding, so normally ASCII. See also the __pmLog* types in include/pcp/impl.h.

Record Framing

The volume and meta files are divided into self-identifying records.

OffsetLengthName
04N, length of record, in bytes, including this field
4N-8record payload, usually starting with a 32-bit tag
N-44N, length of record (again)

Archive Log Label

All three types of files begin with a "log label" header, which identifies the host name, the time interval covered, and a time zone.

OffsetLengthName
04tag, PM_LOG_MAGIC | PM_LOG_VERS02=0x50052602
44pid of pmlogger process that wrote file
84log start time, seconds part (past UNIX epoch)
124log start time, microseconds part
164current log volume number (or -1=.meta, -2=.index)
2064name of collection host
8040time zone string ($TZ environment variable)

All fields, except for the current log volume number field, match for all archive-related files produced by a single run of the tool.

Archive Volume (.0, .1, ...) Records

pmResult

After the archive log label record, an archive volume file contains metric values corresponding to the pmResult set of one pmFetch operation, which is almost identical to the form on disk. The record size may vary according to number of PMIDs being fetched, the number of instances for their domains. File size is limited to 2GB, due to storage of 32-bit offsets within the .index file.

OffsetLengthName
04timestamp, seconds part (past UNIX epoch)
44timestamp, microseconds part
84number of PMIDs with data following
12MpmValueSet #0
12+MNpmValueSet #1
12+M+N......
NOPXpmValueBlock #0
NOP+XYpmValueBlock #1
NOP+X+Y......

Records with a number-of-PMIDs equal to zero are "markers", and may represent interruptions, missing data, or time discontinuities in logging.

pmValueSet

This subrecord represents the measurements for one metric.

OffsetLengthName
04PMID
44number of values
84storage mode, PM_VAL_INSITU=0 or PM_VAL_DPTR=1
12MpmValue #0
12+MNpmValue #1
12+M+N......

The metric-description metadata for PMIDs is found in the .meta files. These entries are not timestamped, so the metadata is assumed to be unchanging throughout the archiving session.

pmValue

This subrecord represents one measurement for one instance of the metric. It is a variant type, depending on the parent pmValueSet's value-format field. This allows small numbers to be encoded compactly, but retain flexibility for larger or variable-length data to be stored later in the pmResult record.

OffsetLengthName
04number in instance-domain (or PM_IN_NULL=-1)
44value (INSITU) or
offset in pmResult to our pmValueBlock (DPTR)

The instance-domain metadata for PMIDs is found in the .meta files. Since the numeric mappings may change during the lifetime of the logging session, it is important to match up the timestamp of the measurement record with the corresponding instance-domain record. That is, the instance-domain corresponding to a measurement at time T are the records with largest timestamps T' <= T.

pmValueBlock

Instances of this subrecord are placed at the end of the pmValueSet, after all the pmValue subrecords. Iff needed, they are padded at the end to the next-higher 32-bit boundary.

OffsetLengthName
01value type (same as pmDesc.type)
134 + N, the length of the subrecord
4Nbytes that make up the raw value
4+N0-3padding (not included in the 4+N length field)

Note that for PM_TYPE_STRING, the length includes an explicit NUL terminator byte. For PM_TYPE_EVENT, the value bytestring is further structured.

pmEventArray

(TBD)

METADATA FILE (.meta) RECORDS

After the archive log label record, the metadata file contains interleaved metric-description and timestamped instance-domain descriptors. File size is limited to 2GB, due to storage of 32-bit offsets within the .index file. Unlike the archive volumes, these records are not forced to 32-bit alignment! See also src/libpcp/src/logmeta.c.

pmDesc

Instances of this record represent the metric description, giving a name, type, instance-domain identifier, and a set of names to each PMID used in the archive volume.

OffsetLengthName
04tag, TYPE_DESC=1
44pmid
84type (PM_TYPE_*)
124instance domain number
164semantics of value (PM_SEM_*)
204units: bit-packed pmUnits
44number of alternative names for this PMID
284N: number of bytes in this name
32Nbytes of the name, no NUL terminator nor padding
32+N4N2: number of bytes in next name
36+NN2bytes of the name, no NUL terminator nor padding
.........

pmLogIndom

Instances of this record represent the number-string mapping table of an instance domain. The instance domain number will have already been mentioned in a prior pmDesc record. Since new instances may appear over a long archiving run, these records are timestamped, and must be searched when decoding pmResult records from the main archive volumes. Instance names may be reused between instance numbers, so an offset-based string table is used that could permit sharing.

OffsetLengthName
04tag, TYPE_INDOM=2
44timestamp, seconds part (past UNIX epoch)
84timestamp, microseconds part
124instance domain number
164N: number of instances in domain, normally >0
204first instance number
244second instance number (if appropriate)
.........
20+4*N4first offset into string table (see below)
20+4*N+44second offset into string table (etc.)
.........
20+8*NMbase of string table, containing
packed, NUL-terminated instance names

Records of this form replace the existing instance-domain: prior records are not searched for resolving instance numbers in measurements after this timestamp.

INDEX FILE (.index) RECORDS

After the archive log label record, the temporal index file contains a plainly concatenated, unframed group of tuples, which relate timestamps to 32-bit seek offsets in the volume and meta files. (This limits those files to 2GB in size.) These records are fixed-size, fixed-format, and are not enclosed in the standard length/payload/length wrapper: they just take up the entire remainder of the .index file. See also src/libpcp/src/logutil.c.

OffsetLengthName
04event time, seconds part (past UNIX epoch)
44event time, microseconds part
84archive volume number (0...N)
124byte offset in .meta file of pmDesc or pmLogIndom
164byte offset in archive volume file of pmResult

Since temporal indexes are optional, and exist only to speed up time-wise random access of metrics and their metadata, index records are emitted only intermittently. An archive reader program should not presume any particular rate of data flow into the index. However, common events that may trigger a new temporal-index record include changes in instance-domains, switching over to a new archive volume, just starting or stopping logging. One reliable invariant however is that, for each index entry, there are to be no meta or archive-volume records with a timestamp after that in the index, but physically before the byte-offset in the index.

See Also

PCPIntro(1), PMAPI(3), pmlogger(1), pmdumplog(1), pmafm(1), pcp.conf(5), and pcp.env(5).

Referenced By

PCPIntro(1), pmrep(1).

Performance Co-Pilot