NAME¶

__pmLogWriteMark - append a <mark> record to a PCP archive

C SYNOPSIS¶

#include <pcp/pmapi.h>
#include <pcp/libpcp.h>

int __pmLogWriteMark(__pmArchCtl *acp, const __pmTimestamp *last_stamp, const __pmTimestamp *inc)

cc ... -lpcp

CAVEAT¶

This documentation is intended for internal Performance Co-Pilot (PCP) developer use.

These interfaces are not part of the PCP APIs that are guaranteed to remain fixed across releases, and at some point in the future they may not work or may provide different semantics.

DESCRIPTION¶

__pmLogWriteMark appends a <mark> record to the current data file of a PCP archive. A <mark> record indicates a dicontinuity in the time series of logged data in the archive, see PCPIntro(1) for more information.

The timestamp of the <mark> record is given by last_stamp optionally incremented by inc unless inc is NULL (in which case no increment is done).

The current data volume's I/O stream and the archive version (determines the format of the <mark> record) are determined from acp.

DIAGNOSTICS AND RETURN VALUES¶

The return value is 0 if all is well, else some error code less than zero that can be turned into an error message by calling pmErrStr(3).

SEE ALSO¶

PCPIntro(1), PMAPI(3) and __pmLogWrite(3).