Man Linux: Main Page and Category List


       genpmda - Performance Co-Pilot PMDA Generator


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


       Genpmda is a  rapid  application  development  tool  for  creating  new
       Performance  Metrics  Domain  Agents,  see PMDA(3).  It provides a very
       easy and efficient way to extend the Performance  Co-pilot  (PCP)  with
       new  performance  metrics  without  needing to understand the low level
       details of how PMDAs are constructed.

       Genpmda reads a config file containing an augmented Performance Metrics
       Name  Space,  see pmns(4), and automatically generates virtually all of
       the source code to implement a fully  functional  PMDA,  including  the
       Makefile, name space, support scripts for configuring the new PMDA, and
       the metrics help  text.   Fairly  simple  PMDAs  can  be  automatically
       generated  from  the  config  file without writing any additional code.
       More complicated PMDAs,  e.g.  containing  multiple  instance  domains,
       require only the refresh methods for the instance domains to be written

       An example of the config file  format  accepted  by  genpmda  is  given


       Required options:

       -c config
              input config file, see example below

       -i IAM pmda name IAM, should appear in stdpmid or the -D option must be
              used to specify a domain.

       Other options:

       -d     generate an Install script for a daemon PMDA (default is DSO)

       -t topdir
              use topdir in generated GNUmakefile, default ../../..

       -n pmns
              use pmns as root of the namespace (default matches -i flag)

       -D domain
              use domain number in the generated pmns and domain.h (if  -s  is
              not given)

       -s stdpmid
              path to stdpmid (default ../../pmns/stdpmid)

       -o dir use dir for generated source code, default ./generated

       -v     print verbose messages about what genpmda is doing.

           Generate an "example" pmda using domain 99:
           genpmda -D 99 -v -i EXAMPLE -c example.conf

       Here is example.conf config file (for the required -c option):

            example {

            example.metric {
                ##  metric            string
                ##  pmid              EXAMPLE:CLUSTER:0
                ##  indom             PM_INDOM_NULL
                ##  type              PM_TYPE_STRING
                ##  units             PMDA_PMUNITS(0,0,0,0,0,0)
                ##  semantics         PM_SEM_DISCRETE
                ##  briefhelptext     one line help text for example.metric.string
                ##  helptext          long help text for example.metric.string
                ##  helptext          This is the second line of the long help text
                ##  helptext          and this is the third line.
                ##  fetch             function example_string_fetch_callback
                ##  code              atom->cp = "hello world";
                ##  code              return 1;
                ##  endmetric


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


       PMDA(3), pmns(4), pmcd(1), pcp.conf(4) and pcp.env(4).


       Many, but all are intended to be easily understood.