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

NAME

6       pmdasample - sample performance metrics domain agent (PMDA)
7

SYNOPSIS

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

DESCRIPTION

13       pmdasample is a sample Performance Metrics Domain  Agent  (PMDA)  which
14       exports a variety of synthetic performance metrics.
15
16       This  PMDA  was  developed as part of the quality assurance testing for
17       the PCP product, but has other uses, most notably in the development of
18       new PCP clients.
19
20       The  metrics  exported  by the sample PMDA cover the full range of data
21       types, data semantics, value cardinality, instance domain stability and
22       error conditions found in real PMDAs.
23
24       A brief description of the pmdasample command line options follows:
25
26       -d   It  is absolutely crucial that the performance metrics domain num‐
27            ber specified here is unique  and  consistent.   That  is,  domain
28            should  be  different for every PMDA on the one host, and the same
29            domain number should be used for the same PMDA on all hosts.
30
31       -i   Expect PMCD to connect to pmdasample on the specified TCP/IP port.
32            port may be a port number or port name.
33
34       -l   Location of the log file.  By default, a log file named sample.log
35            is written in the current directory of pmcd(1) when pmdasample  is
36            started,  i.e.  $PCP_LOG_DIR/pmcd.  If the log file cannot be cre‐
37            ated or is not writable, output is written to the  standard  error
38            instead.
39
40       -p   Expect  PMCD  to create a pipe and the connection to pmdasample is
41            via standard input and standard output.  This is the default  con‐
42            nection mode.
43
44       -u   Expect  PMCD  to  connect  to pmdasample on the Unix domain socket
45            named socket.
46
47       -U   User account under which to run the agent.   The  default  is  the
48            unprivileged  "pcp"  account  in  current  versions of PCP, but in
49            older versions the superuser account ("root") was used by default.
50
51       At most one of the options -i, -p and -u may be specified.
52

INSTALLATION

54       If you want access to the names, help text and values  for  the  sample
55       performance metrics, do the following as root:
56
57            # cd $PCP_PMDAS_DIR/sample
58            # ./Install
59
60       Note  that the installation script also installs the DSO version of the
61       sample PMDA, so there are in fact two PMDAs installed, and two sets  of
62       performance metrics, namely sample.*  and sampledso.*.
63
64       If  you  want  to undo the installation (and remove both PMDAs), do the
65       following as root:
66
67            # cd $PCP_PMDAS_DIR/sample
68            # ./Remove
69
70       pmdasample  is  launched  by  pmcd(1)  and  should  never  be  executed
71       directly.  The Install and Remove scripts notify pmcd(1) when the agent
72       is installed or removed.
73

FILES

75       $PCP_PMCDCONF_PATH
76                 command line options used to launch pmdasample
77       $PCP_PMDAS_DIR/sample/help
78                 default help text file for the sample metrics
79       $PCP_PMDAS_DIR/sample/Install
80                 installation script for the pmdasample agent
81       $PCP_PMDAS_DIR/sample/Remove
82                 undo installation script for the pmdasample agent
83       $PCP_LOG_DIR/pmcd/sample.log
84                 default log file for error  messages  and  other  information
85                 from pmdasample
86

PCP ENVIRONMENT

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

SEE ALSO

95       PCPIntro(1),   pmcd(1),  pmdasimple(1),  pmdatrivial(1),  pmdatxmon(1),
96       pcp.conf(5) and pcp.env(5).
97
98
99
100Performance Co-Pilot                  PCP                        PMDASAMPLE(1)
Impressum