pmiputvalue(3) — Linux manual page

PMIPUTVALUE(3)          Library Functions Manual          PMIPUTVALUE(3)

NAME

       pmiPutValue - add a value for a metric-instance pair

C SYNOPSIS

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

       int pmiPutValue(const char *name, const char *instance,
               const char *value);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS

       use PCP::LogImport;

       pmiPutValue($name, $instance, $value);

DESCRIPTION

       As   part  of  the  Performance  Co-Pilot  Log  Import  API  (see
       LOGIMPORT(3)), pmiPutValue adds a single  value  to  the  current
       output record for a given metric and instance.

       The  metric's  name should match one defined earlier in a call to
       pmiAddMetric(3).

       For singular metrics (those defined with an  instance  domain  of
       PM_INDOM_NULL),  the  instance should be NULL or an empty string,
       otherwise instance should match the name of an  instance  defined
       earlier  in a call to pmiAddInstance(3) for the metric's instance
       domain.

       The value should be in a format consistent with the metric's type
       as defined in the call to pmiAddMetric(3).

       No data will be written until pmiWrite(3) is called, so  multiple
       calls  to  pmiPutValue or pmiPutValueHandle(3) are typically used
       to accumulate data values for several metric-instance  pairs  be‐
       fore calling pmiWrite(3).

DIAGNOSTICS

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

SEE ALSO

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

COLOPHON

       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  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                                      PMIPUTVALUE(3)

Pages that refer to this page: logimport(3), pmiaddinstance(3), pmiaddmetric(3), pmigethandle(3), pmiputlabel(3), pmiputmark(3), pmiputresult(3), pmiputtext(3), pmiputvaluehandle(3), pmistart(3), pmiwrite(3)

---