pmdaDesc(3)

pmdaDesc3

Get the description of a metric from a pmda

C synopsis

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

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

cc ... -lpcp_pmda -lpcp

Overview

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

Caveat

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

Diagnostics

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

Releases

8 releases since Debian 5.0 (Lenny); the text changed 6 times.

  1. 5.0
  2. 6.0
  3. 8
  4. 10
  5. 11
  6. 12–13
  7. Arch

From pcp 7.2.2-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.