pmiputlabel(3) — Linux manual page

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

PMIPUTLABEL(3)          Library Functions Manual          PMIPUTLABEL(3)

NAME         top

       pmiPutLabel - add labels to the output archive

C SYNOPSIS         top

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

       int pmiPutLabel(unsigned int type, unsigned int id, unsigned int
               instance, const char *name, const char *value)

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS         top

       use PCP::LogImport;

       pmiPutLabel($type, $id, $instance, $name, $value);

DESCRIPTION         top

       As part of the Performance Co-Pilot Log Import API (see
       LOGIMPORT(3)), pmiPutLabel adds a label for the global context or
       for a given domain, cluster, item, instance domain or instance.

       The type must be one of PM_LABEL_CONTEXT, PM_LABEL_DOMAIN,
       PM_LABEL_CLUSTER, PM_LABEL_ITEM, PM_LABEL_INDOM, or
       PM_LABEL_INSTANCES.

       If type is PM_LABEL_CONTEXT, then id and instance are ignored.
       Otherwise, id should match a domain, cluster, metric or instance
       domain defined earlier in a call to pmiAddMetric(3).

       If type is PM_LABEL_INSTANCES, then instance should match an
       instance number of the selected domain. Otherwise instance is
       ignored.

       name is a string containing the name of the label to be added.

       value is a string containing the value of the label to be added.

       No data will be written until pmiWrite(3) is called, so multiple
       calls to pmiPutLabel are typically used to accumulate several
       labels before calling pmiWrite(3).

DIAGNOSTICS         top

       pmiPutLabel 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) and pmiWrite(3).

COLOPHON         top

       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 2021-08-27.
       (At that time, the date of the most recent commit that was found
       in the repository was 2021-08-27.)  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                                      PMIPUTLABEL(3)

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