__pmlogwritemark(3) — Linux manual page

PMLOGWRITEMARK(3)       Library Functions Manual       PMLOGWRITEMARK(3)

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 discontinuity 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).

COLOPHON

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at 
       ⟨http://www.pcp.io/⟩.  If you have a bug report for this manual
       page, send it to pcp@groups.io.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2024-06-14.
       (At that time, the date of the most recent commit that was found
       in the repository was 2024-06-14.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

Performance Co-Pilot               PCP                 PMLOGWRITEMARK(3)