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

NAME

6       pmdasimple - simple performance metrics domain agent (PMDA)
7

SYNOPSIS

9       $PCP_PMDAS_DIR/simple/pmdasimple  [-d  domain]  [-i  port] [-l logfile]
10       [-p] [-u socket] [-U username]
11

DESCRIPTION

13       pmdasimple is a simple Performance Metrics Domain  Agent  (PMDA)  which
14       exports a small number of synthetic performance metrics.
15
16       The  simple PMDA is shipped as source code and is designed to be an aid
17       for PMDA developers.  In terms of code size and features,  it  is  more
18       complex  than  the  trivial  PMDA, about the same as the txmon PMDA and
19       less complex than the sample PMDA.  The source for the simple PMDA is a
20       good template from which production, customized PMDAs can be developed.
21
22       A brief description of the pmdasimple command line options follows:
23
24       -d   It  is absolutely crucial that the performance metrics domain num‐
25            ber specified here is unique  and  consistent.   That  is,  domain
26            should  be  different for every PMDA on the one host, and the same
27            domain number should be used for the same PMDA on all hosts.
28
29       -i   Expect PMCD to connect to pmdasimple on the specified TCP/IP port.
30            port may be a port number or port name.
31
32       -l   Location of the log file.  By default, a log file named simple.log
33            is written in the current directory of pmcd(1) when pmdasimple  is
34            started,  i.e.  $PCP_LOG_DIR/pmcd.  If the log file cannot be cre‐
35            ated or is not writable, output is written to the  standard  error
36            instead.
37
38       -p   Expect  PMCD  to create a pipe and the connection to pmdasimple is
39            via standard input and standard output.  This is the default  con‐
40            nection mode.
41
42       -u   Expect  PMCD  to  connect  to pmdasimple on the Unix domain socket
43            named socket.
44
45       -U   User account under which to run the agent.  The default is the un‐
46            privileged  "pcp" account in current versions of PCP, but in older
47            versions the superuser account ("root") was used by default.
48
49       At most one of the options -i, -p and -u may be specified.
50

INSTALLATION

52       If you want access the names, help text and values for the simple  per‐
53       formance metrics, do the following as root:
54
55            # cd $PCP_PMDAS_DIR/simple
56            # ./Install
57
58       If you want to undo the installation, do the following as root:
59
60            # cd $PCP_PMDAS_DIR/simple
61            # ./Remove
62
63       pmdasimple  is  launched  by  pmcd(1)  and should never be executed di‐
64       rectly.  The Install and Remove scripts notify pmcd(1) when  the  agent
65       is installed or removed.
66

FILES

68       $PCP_PMCDCONF_PATH
69                 command line options used to launch pmdasimple
70       $PCP_PMDAS_DIR/simple/help
71                 default help text file for the simple metrics
72       $PCP_PMDAS_DIR/simple/Install
73                 installation script for the pmdasimple agent
74       $PCP_PMDAS_DIR/simple/Remove
75                 undo installation script for the pmdasimple agent
76       $PCP_PMDAS_DIR/simple/simple.conf
77                 configuration  file  for the dynamic instance domain that un‐
78                 derlies the simple.now performance metric.   For  a  descrip‐
79                 tion, refer to the help text file, or run the command
80                 $ pminfo -T simple.now
81       $PCP_PMDAS_DIR/simple/*.pmda_simple.so
82                 The DSO version of the PMDA.  The same source is used to cre‐
83                 ate both the DSO and the daemon versions of the simple  PMDA,
84                 and  one  or the other may be installed as part of the dialog
85                 in the Install script.
86       $PCP_LOG_DIR/pmcd/simple.log
87                 default log file for error  messages  and  other  information
88                 from pmdasimple
89

PCP ENVIRONMENT

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

SEE ALSO

98       PCPIntro(1),   pmcd(1),  pmdasample(1),  pmdatrivial(1),  pmdatxmon(1),
99       PMDA(3), pcp.conf(5) and pcp.env(5).
100
101
102
103Performance Co-Pilot                  PCP                        PMDASIMPLE(1)
Impressum