pmdaname(3) — Linux manual page

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

PMDANAME(3)              Library Functions Manual             PMDANAME(3)

NAME         top

       pmdaName - translate a PMID to a set of dynamic performance metric
       names

C SYNOPSIS         top

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

       int pmdaName(pmID pmid, char ***nameset, pmdaExt *pmda);

       cc ... -lpcp_pmda -lpcp

DESCRIPTION         top

       As  part  of  the Performance Metrics Domain Agent (PMDA) API (see
       PMDA(3)), pmdaName is the generic callback for translating a  pmid
       into one or more dynamic metric names (nameset).

       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),  pmdaName
       is a skeleton implementation that returns PM_ERR_NAME.

       A  PMDA  that  supports dynamic performance metrics will provide a
       private callback that replaces pmdaName  (by  assignment  to  ver‐
       sion.four.name  of the pmdaInterface structure) and implements the
       translation from a pmid to a set  of  dynamic  performance  metric
       names returned via nameset.  The behaviour, return values and mem‐
       ory allocation rules for nameset are the same as for pmNameAll(3).

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

       pmdaName returns PM_ERR_PMID if the name is not recognized or can‐
       not be translated, otherwise the  number  of  metric  names  found
       (most commonly 1).

SEE ALSO         top

       PMAPI(3),   PMDA(3),   pmdaDaemon(3),   pmdaDSO(3),   pmdaMain(3),
       pmNameAll(3) and pmNameID(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                        PMDANAME(3)

Pages that refer to this page: pmdamain(3)