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

NAME

6       pmLookupInDomArchive  -  translate  an  instance  name into an instance
7       identifier
8

C SYNOPSIS

10       #include <pcp/pmapi.h>
11
12       int pmLookupInDomArchive(pmInDom indom, const char *name);
13
14       cc ... -lpcp
15

DESCRIPTION

17       Provided the current Performance Metrics Application Programming Inter‐
18       face  (PMAPI)  context  is  associated  with  a  set  of  archive logs,
19       pmLookupInDomArchive will scan the union of  all  the  instance  domain
20       metadata  for the instance domain indom, locate the first instance with
21       the external identification given by  name,  and  return  the  internal
22       instance identifier.
23
24       This routine is a specialized version of the more general PMAPI routine
25       pmLookupInDom.
26
27       Only the leading non-space characters of name will be used to  identify
28       the instance.
29
30       The  value  for the instance domain indom is typically extracted from a
31       pmDesc structure, following a call to pmLookupDesc(3) for a  particular
32       performance metric.
33
34       pmLookupInDomArchive will return a positive instance identifier on suc‐
35       cess.
36

SEE ALSO

38       PMAPI(3),   pmGetConfig(3),   pmGetInDomArchive(3),    pmLookupDesc(3),
39       pmLookupInDom(3), pmNameInDomArchive(3), pcp.conf(5) and pcp.env(5).
40

DIAGNOSTICS

42       PM_ERR_NOTARCHIVE
43              the  current  PMAPI  context is not associated with a set of ar‐
44              chive logs
45
46       PM_ERR_INDOM_LOG
47              indom is not a defined instance domain identifier for the set of
48              archive logs
49
50       PM_ERR_INST_LOG
51              the  external instance name is not known for the instance domain
52              indom in the set of archive logs
53
54
55
56Performance Co-Pilot                  PCP              PMLOOKUPINDOMARCHIVE(3)
Impressum