1GENPMDA(1)                  General Commands Manual                 GENPMDA(1)
2
3
4

NAME

6       genpmda - Performance Co-Pilot PMDA Generator
7

SYNOPSIS

9       genpmda  [-d]  [-D  domain] [-s stdpmid] [-t topdir] [-n pmns] [-o dir]
10       [-v] -i IAM -c config
11

DESCRIPTION

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
19       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
29       An example of the config file  format  accepted  by  genpmda  is  given
30       below.
31

OPTIONS

33       Required options:
34
35       -c config
36              input config file, see example below
37
38       -i IAM pmda name IAM, should appear in stdpmid or the -D option must be
39              used to specify a domain.
40
41       Other options:
42
43       -d     generate an Install script for a daemon PMDA (default is DSO)
44
45       -t topdir
46              use topdir in generated GNUmakefile, default ../../..
47
48       -n pmns
49              use pmns as root of the namespace (default matches -i flag)
50
51       -D domain
52              use domain number in the generated pmns and domain.h (if  -s  is
53              not given)
54
55       -s stdpmid
56              path to stdpmid (default ../../pmns/stdpmid)
57
58       -o dir use dir for generated source code, default ./generated
59
60       -v     print verbose messages about what genpmda is doing.
61
62       Example:
63           Generate an "example" pmda using domain 99:
64           genpmda -D 99 -v -i EXAMPLE -c example.conf
65
66       Here is example.conf config file (for the required -c option):
67
68            example {
69                metric
70            }
71
72            example.metric {
73                ##  metric            string
74                ##  pmid              EXAMPLE:CLUSTER:0
75                ##  indom             PM_INDOM_NULL
76                ##  type              PM_TYPE_STRING
77                ##  units             PMDA_PMUNITS(0,0,0,0,0,0)
78                ##  semantics         PM_SEM_DISCRETE
79                ##  briefhelptext     one line help text for example.metric.string
80                ##  helptext          long help text for example.metric.string
81                ##  helptext          This is the second line of the long help text
82                ##  helptext          and this is the third line.
83                ##  fetch             function example_string_fetch_callback
84                ##  code              atom->cp = "hello world";
85                ##  code              return 1;
86                ##  endmetric
87            }
88
89
90
91

PCP ENVIRONMENT

93       Environment variables with the prefix PCP_ are used to parameterize the
94       file and directory names used by PCP.  On each installation,  the  file
95       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
96       $PCP_CONF variable may be used to specify an alternative  configuration
97       file, as described in pcp.conf(5).
98

SEE ALSO

100       PMDA(3), pmns(5), pmcd(1), pcp.conf(5) and pcp.env(5).
101

DIAGNOSTICS

103       Many, but all are intended to be easily understood.
104
105
106
107Performance Co-Pilot                  PCP                           GENPMDA(1)
Impressum