NAME¶
pmFetchArchive - get performance metrics directly from an archive log
C SYNOPSIS¶
#include <pcp/pmapi.h>
int pmFetchArchive(pmResult **
result);
cc ... -lpcp
DESCRIPTION¶
pmFetchArchive is a variant of
pmFetch(3) that may only be used
when the current Performance Metrics Application Programming Interface (PMAPI)
context is associated with an archive log.
The
result is instantiated with all of the metrics (and instances) from
the next archive record, consequently there is no notion of a list of desired
metrics, and the instance profile of the PMAPI context is ignored.
It is expected that
pmFetchArchive would be used to create utilities that
scan archive logs, while the more common access to the archives would be via
the
pmFetch(3) interface.
To skip records within the archive log, use
pmSetMode(3) to change the
collection time within the current PMAPI context, then call
pmFetchArchive.
Note that the
result returned by
pmFetchArchive is dynamically
allocated, and must be released using
pmFreeResult(3), not
free(3C). See
pmFetch(3) and
pmFreeResult(3) for further
details.
pmFetchArchive returns zero on success.
SEE ALSO¶
PMAPI(3),
pmFetch(3),
pmFreeResult(3),
pmNewContext(3),
pmSetMode(3) and
pmTrimNameSpace(3).
DIAGNOSTICS¶
- PM_ERR_NOTARCHIVE
- the current PMAPI context is not associated with an archive log