1GENPMDA(1) General Commands Manual GENPMDA(1)
2
6 genpmda - Performance Co-Pilot PMDA Generator
7
9 genpmda [-dv] [-D domain] [-n pmns] [-o dir] [-s stdpmid] [-t topdir]
10 -c config -i IAM
11
13 genpmda is a rapid application development tool for creating new Per‐
14 formance Metrics Domain Agents, see PMDA(3). It provides a very easy
15 and efficient way to extend the Performance Co-pilot (PCP) with new
16 performance metrics without needing to understand the low level details
17 of how PMDAs are constructed.
18 genpmda reads a config file containing an augmented Performance Metrics
20 Name Space, see PMNS(5), and automatically generates virtually all of
21 the source code to implement a fully functional PMDA, including the
22 Makefile, name space, support scripts for configuring the new PMDA, and
23 the metrics help text. Fairly simple PMDAs can be automatically gener‐
24 ated from the config file without writing any additional code. More
25 complicated PMDAs, e.g. containing multiple instance domains, require
26 only the refresh methods for the instance domains to be written manu‐
27 ally.
28 An example of the config file format accepted by genpmda is given
30 below.
31
33 Required options:
34 -c config
36 input config file, see example below
37 -i IAM
39 PMDA name IAM, should appear in stdpmid or the -D option must be
40 used to specify a domain.
41 Other options:
43 -d generate an Install script for a daemon PMDA (default is DSO)
45 -D domain
47 use domain number in the generated pmns and domain.h (if -s is not
48 given)
49 -n pmns
51 use pmns as root of the namespace (default matches -i flag)
52 -o dir
54 use dir for generated source code, default ./generated
55 -s stdpmid
57 path to stdpmid (default ../../pmns/stdpmid)
58 -t topdir
60 use topdir in generated GNUmakefile, default ../../..
61 -v print verbose messages about what genpmda is doing.
63 Example:
65 Generate an "example" PMDA using domain 99:
66 genpmda -D 99 -v -i EXAMPLE -c example.conf
67 Here is example.conf config file (for the required -c option):
69 example {
71 metric
72 }
73 example.metric {
75 ## metric string
76 ## pmid EXAMPLE:CLUSTER:0
77 ## indom PM_INDOM_NULL
78 ## type PM_TYPE_STRING
79 ## units PMDA_PMUNITS(0,0,0,0,0,0)
80 ## semantics PM_SEM_DISCRETE
81 ## briefhelptext one line help text for example.metric.string
82 ## helptext long help text for example.metric.string
83 ## helptext This is the second line of the long help text
84 ## helptext and this is the third line.
85 ## fetch function example_string_fetch_callback
86 ## code atom->cp = "hello world";
87 ## code return 1;
88 ## endmetric
89 }
90
95 Many, but all are intended to be easily understood.
96
98 Environment variables with the prefix PCP_ are used to parameterize the
99 file and directory names used by PCP. On each installation, the file
100 /etc/pcp.conf contains the local values for these variables. The
101 $PCP_CONF variable may be used to specify an alternative configuration
102 file, as described in pcp.conf(5).
103
105 pmcd(1), PMDA(3), pcp.conf(5), pcp.env(5) and PMNS(5).
106Performance Co-Pilot PCP GENPMDA(1)