1PMDANAME(3)                Library Functions Manual                PMDANAME(3)
2
3
4

NAME

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

C SYNOPSIS

10       #include <pcp/pmapi.h>
11       #include <pcp/pmda.h>
12
13       int pmdaName(pmID pmid, char ***nameset, pmdaExt *pmda);
14
15       cc ... -lpcp_pmda -lpcp
16

DESCRIPTION

18       As part of  the  Performance  Metrics  Domain  Agent  (PMDA)  API  (see
19       PMDA(3)),  pmdaName is the generic callback for translating a pmid into
20       one or more dynamic metric names (nameset).
21
22       Because implementing dynamic performance metrics requires specific PMDA
23       support,  and  the  facility  is  an optional component of a PMDA (most
24       PMDAs do not support dynamic performance metrics), pmdaName is a skele‐
25       ton implementation that returns PM_ERR_NAME.
26
27       A PMDA that supports dynamic performance metrics will provide a private
28       callback that replaces pmdaName (by assignment to version.four.name  of
29       the pmdaInterface structure) and implements the translation from a pmid
30       to a set of dynamic performance metric names returned via nameset.  The
31       behaviour,  return  values  and memory allocation rules for nameset are
32       the same as for pmNameAll(3).
33

DIAGNOSTICS

35       pmdaName returns PM_ERR_PMID if the name is not recognized or cannot be
36       translated,  otherwise  the number of metric names found (most commonly
37       1).
38

CAVEAT

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

SEE ALSO

44       PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3), pmdaMain(3), pmNameAll(3)
45       and pmNameID(3).
46
47
48
49Performance Co-Pilot                  PCP                          PMDANAME(3)
Impressum