pmdapmid(3) — Linux manual page

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

PMDAPMID(3)              Library Functions Manual             PMDAPMID(3)

NAME         top

       pmdaPMID - translate a dynamic performance metric name into a PMID

C SYNOPSIS         top

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

       int pmdaPMID(char *name, pmID *pmid, pmdaExt *pmda);

       cc ... -lpcp_pmda -lpcp

DESCRIPTION         top

       As  part  of  the Performance Metrics Domain Agent (PMDA) API (see
       PMDA(3)), pmdaPMID is the generic callback for translating  a  dy‐
       namic metric name into a PMID (pmid).

       Because implementing dynamic performance metrics requires specific
       PMDA  support, and the facility is an optional component of a PMDA
       (most PMDAs do not support dynamic performance metrics),  pmdaPMID
       is a skeleton implementation that returns PM_ERR_NAME.

       A  PMDA  that  supports dynamic performance metrics will provide a
       private callback that replaces pmdaPMID  (by  assignment  to  ver‐
       sion.four.pmid  of the pmdaInterface structure) and implements the
       translation from a dynamic performance metric name into the  asso‐
       ciated pmid.

CAVEAT         top

       The  PMDA must be using PMDA_INTERFACE_4 or later, as specified in
       the call to pmdaDSO(3) or pmdaDaemon(3).

DIAGNOSTICS         top

       pmdaPMID returns PM_ERR_NAME if the name is not recognized or can‐
       not be translated, else returns 0.

SEE ALSO         top

       PMAPI(3),  PMDA(3),  pmdaDaemon(3),  pmdaDSO(3),  pmdaMain(3)  and
       pmLookupName(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-08-11.   (At  that  time,  the date of the most recent commit
       that was found in the repository was 2025-08-11.)  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                        PMDAPMID(3)

Pages that refer to this page: pmdamain(3)