pmdadesc(3) — Linux manual page

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

PMDADESC(3)              Library Functions Manual             PMDADESC(3)

NAME         top

       pmdaDesc - get the description of a metric from a PMDA

C SYNOPSIS         top

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

       int pmdaDesc(pmID pmid, pmDesc *desc, pmdaExt *pmda);

       cc ... -lpcp_pmda -lpcp

DESCRIPTION         top

       pmdaDesc  uses  the standard PMDA(3) data structures to return the
       pmDesc description in desc for the metric identified by pmid.

CAVEAT         top

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

DIAGNOSTICS         top

       If  the  pmid  does not correspond to any metric supported by this
       PMDA, pmdaDesc returns PM_ERR_PMID.

SEE ALSO         top

       PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3) and pmLookupDesc(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                        PMDADESC(3)

Pages that refer to this page: pmda(3)pmdadaemon(3)pmdadso(3)pmdamain(3)