pmdadesc(3) [centos man page]

PMDADESC(3)						     Library Functions Manual						       PMDADESC(3)

NAME

       pmdaDesc - get the description of a metric from a PMDA

C SYNOPSIS

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

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

       cc ... -lpcp_pmda -lpcp

DESCRIPTION

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

DIAGNOSTICS

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

CAVEAT

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

SEE ALSO

       PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3) and pmLookupDesc(3).

Performance Co-Pilot							PCP							       PMDADESC(3)

PMDADSO(3)						     Library Functions Manual							PMDADSO(3)

NAME

       pmdaDSO - initialize the PMDA to run as a DSO

C SYNOPSIS

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

       int pmdaDSO(pmdaInterface *dispatch, int interface, char *name, char *helptext);

       cc ... -lpcp_pmda -lpcp

DESCRIPTION

       pmdaDSO	initializes  the pmdaInterface structure to use the interface extensions, assuming the PMDA(3) is to be run as a DSO.  The pmdaIn-
       terface structure is initialized with:

       name	      The name of the agent.

       helptext       The default path to the help text (see pmdaText(3).  If no help text is installed, or you are not  using	pmdaText(3),  then
		      this should be set to NULL.

       The callbacks are initialized to pmdaProfile(3), pmdaFetch(3), pmdaDesc(3), pmdaText(3), pmdaInstance(3) and pmdaStore(3).

       The  interface structure also contains the domain of the PMDA(3), which is defined in the pmcd(1) configuration file. The domain is used to
       initialize the metric and instance descriptors (see pmdaInit(3)).

DIAGNOSTICS

       Incompatible version of pmcd detected
		      When pmcd(1) creates the pmdaInterface structure, the dispatch.comm.version field is set to the highest  protocol  that  pm-
		      cd(1) understands.  This message indicates that the pmcd(1) process does not understand the protocol used by pmdaDSO.

       Unable to allocate memory for pmdaExt structure
		      In addition, dispatch->status is set to a value less than zero.

CAVEAT

       The PMDA must be using PMDA_INTERFACE_2 or later.

SEE ALSO

       pmcd(1), PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaInit(3) and pmdaText(3).

Performance Co-Pilot							PCP								PMDADSO(3)