pmiputmark(3) — Linux manual page

NAME | C SYNOPSIS | Perl SYNOPSIS | DESCRIPTION | DIAGNOSTICS | SEE ALSO | COLOPHON

PMIPUTMARK(3)            Library Functions Manual           PMIPUTMARK(3)

NAME         top

       pmiPutMark - write a <mark> record to a PCP archive

C SYNOPSIS         top

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

       int pmiPutMark(void);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS         top

       use PCP::LogImport;

       pmiPutMark();

DESCRIPTION         top

       As   part   of  the  Performance  Co-Pilot  Log  Import  API  (see
       LOGIMPORT(3)), pmiPutMark writes a <mark> record  to  the  current
       PCP  output  archive.   This  is required when there is a temporal
       discontinuity between the current input source and the next  input
       source,  if  any,  and  should  be  called after the final call to
       pmiWrite(3) for the current input.  If there is no next  input  to
       be  processed  or no temporal gap between sources, then the <mark>
       record is not required.

       The <mark> record is used to signify a temporal gap, so that  when
       replaying  the  output PCP archive, interpolation of metric values
       should not be performed between the last timestamp in the  current
       input source to the first timestamp in the next input source, i.e.
       across the <mark> record.

DIAGNOSTICS         top

       pmiPutMark  returns zero on success else a negative value that can
       be turned into an error message by calling pmiErrStr(3).

SEE ALSO         top

       LOGIMPORT(3),  pmiAddInstance(3),  pmiAddMetric(3),  pmiErrStr(3),
       pmiPutResult(3),       pmiPutValue(3),       pmiPutValueHandle(3),
       pmiPutText(3), pmiPutLabel(3) and pmiWrite(3).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.   In‐
       formation  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
       2025-02-02.  (At that time, the date of  the  most  recent  commit
       that was found in the repository was 2025-01-30.)  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                                        PMIPUTMARK(3)

Pages that refer to this page: logimport(3)