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

NAME

6       pmGetDerivedControl,  pmSetDerivedControl   -  get and set controls for
7       derived metrics
8

C SYNOPSIS

10       #include <pcp/pmapi.h>
11
12       int pmGetDerivedControl(int what, int *valuep);
13       int pmSetDerivedControl(int what, int value);
14
15       cc ... -lpcp
16

DESCRIPTION

18       These routines may be used to influence the behaviour  of  the  derived
19       metric  services  that  are  activated for global derived metrics using
20       pmRegisterDerived(3), pmRegisterDerivedMetric(3) and  pmLoadDerivedCon‐
21       fig(3),  or per-context derived metrics using pmAddDerived(3) and pmAd‐
22       dDerivedDerived(3).
23
24       The what argument selects a control,  the  value  argument  provides  a
25       value for pmSetDerivedControl and the valuep argument is used to return
26       the value for pmGetDerivedControl.
27
28       The what argument has one of the following values:
29
30       PCP_DERIVED_GLOBAL_LIMIT
31              The maximum  number  of  global  derived  metrics  that  may  be
32              defined.  The value -1 indicates no limit.
33
34       PCP_DERIVED_CONTEXT_LIMIT
35              The  maximum  number  of per-context derived metrics that may be
36              defined.  The value -1 indicates no limit.
37
38       PCP_DERIVED_DEBUG_SYNTAX
39              Debug diagnostics during parsing of derived  metric  expression.
40              The value 1 enables the diagnostics, the value 0 disables them.
41
42       PCP_DERIVED_DEBUG_SEMANTICS
43              Debug diagnostics for semantic checks during the binding of met‐
44              rics in the derived metric expression to the  available  metrics
45              in  a  new  PMAPI context.  The value 1 enables the diagnostics,
46              the value 0 disables them.
47
48       PCP_DERIVED_DEBUG_EVAL
49              Debug diagnostics when derived metrics are used in PMAPI  opera‐
50              tions like pmFetch(3), pmGetChildren(3), pmGetChildrenStatus(3),
51              pmLookupDesc(3), pmLookupName(3), pmNameAll(3), pmNameID(3)  and
52              pmTraversePMNS(3).
53

RETURN VALUES

55       Both routines return 0 on success, else a value less than 0 that can be
56       decoded using pmErrStr(3).
57

SEE ALSO

59       PCPIntro(1),    pmAddDerived(3),    pmAddDerivedMetric(3),    PMAPI(3),
60       pmErrStr(3),  pmLoadDerivedConfig(3), pmRegisterDerived(3), pmRegister‐
61       DerivedMetric(3) and PMNS(5).
62
63
64
65Performance Co-Pilot                                       PMDERIVEDCONTROL(3)
Impressum