1PMPROXY(1) General Commands Manual PMPROXY(1)
2
6 pmproxy - proxy for performance metrics collector daemon
7
9 pmproxy [-f] [-i ipaddress] [-l logfile] [-L bytes] [-U username] [-x
10 file]
11
13 pmproxy acts as a protocol proxy for pmcd(1), allowing Performance Co-
14 Pilot (PCP) monitoring clients to connect to one or more pmcd(1)
15 instances via pmproxy.
16 Normally pmproxy is deployed in a firewall domain, or on a ``head''
18 node of a cluster where the IP (Internet Protocol) address of the hosts
19 where pmcd(1) is running may be unknown to the PCP monitoring clients,
20 although the IP address of the host where pmproxy is running is known
21 to these clients. Similarly, the clients may have network connectivity
22 only to the host where pmproxy is running, while there is network con‐
23 nectivity from that host to the hosts of interest where pmcd(1) is run‐
24 ning.
25 The behaviour of the PCP monitoring clients is controlled by either the
27 PMPROXY_HOST environment variable or through the extended hostname
28 specification (see PCPIntro(1) for details). If neither of these mech‐
29 anisms is used, clients will make their connections directly to
30 pmcd(1). If the proxy hostname syntax is used or PMPROXY_HOST is set,
31 then this should be the hostname or IP address of the system where
32 pmproxy is running, and the clients will connect to pmcd(1) indirectly
33 through the protocol proxy services of pmproxy.
34 The options to pmproxy are as follows.
36 -f By default pmproxy is started as a daemon. The -f option indi‐
38 cates that it should run in the foreground. This is most useful
39 when trying to diagnose problems with establishing connections.
40 -i ipaddress
42 This option is usually only used on hosts with more than one
43 network interface (very common for firewall and ``head'' node
44 hosts where pmproxy is most likely to be deployed). If no -i
45 options are specified pmproxy accepts PCP client connections on
46 any of its host's IP addresses. The -i option is used to spec‐
47 ify explicitly an IP address that PCP client connections should
48 be accepted on. ipaddress should be in the standard dotted form
49 (e.g. 100.23.45.6). The -i option may be used multiple times to
50 define a list of IP addresses. When one or more -i options is
51 specified, attempted connections made on any other IP addresses
52 will be refused.
53 -l logfile
55 By default a log file named pmproxy.log is written in the cur‐
56 rent directory. The -l option causes the log file to be written
57 to logfile instead of the default. If the log file cannot be
58 created or is not writable, output is written to the standard
59 error instead.
60 -L bytes
62 PDUs received by pmproxy from PCP monitoring clients are
63 restricted to a maximum size of 65536 bytes by default to defend
64 against Denial of Service attacks. The -L option may be used to
65 change the maximum incoming PDU size.
66 -U username
68 Assume the identity of username before starting to accept incom‐
69 ing packets from PCP monitoring clients.
70 -x file
72 Before the pmproxy logfile can be opened, pmproxy may encounter
73 a fatal error which prevents it from starting. By default, the
74 output describing this error is sent to /dev/tty but it may
75 redirected to file.
76
78 Normally, pmproxy is started automatically at boot time and stopped
79 when the system is being brought down (see rc2(1M) and rc0(1M)). Under
80 certain circumstances it is necessary to start or stop pmproxy manu‐
81 ally. To do this one must become superuser and type
82 # $PCP_RC_DIR/pmproxy start
84 to start pmproxy, or
86 # $PCP_RC_DIR/pmproxy stop
88 to stop pmproxy. Starting pmproxy when it is already running is the
90 same as stopping it and then starting it again.
91 Normally pmproxy listens for PCP client connections on TCP/IP port num‐
93 ber 44322 (registered at http://www.isecom.info). The environment
94 variable PMPROXY_PORT may be used to specify an alternative port num‐
95 ber. If PMPROXY_PORT is used, care should be taken to ensure the envi‐
96 ronment variable is set before pmproxy is started.
97
99 PCP_PMPROXYOPTIONS_PATH
100 command line options and environment variable settings for
101 pmproxy when launched from PCP_RC_DIR/pmproxy All the command
102 line option lines should start with a hyphen as the first char‐
103 acter. This file can also contain environment variable settings
104 of the form "VARIABLE=value".
105 ./pmproxy.log
106 (or PCP_LOG_DIR/pmproxy/pmproxy.log when started automatically)
107 All messages and diagnostics are directed here
108
110 In addition to the PCP environment variables described in the PCP ENVI‐
111 RONMENT section below, there are several environment variables that
112 influence the interactions between a PCP monitoring client, pmcd and
113 pmcd(1).
114 PMCD_PORT
116 For the PCP monitoring client this (or the default port number)
117 is passed to pmproxy and used to connect to pmcd(1). In the
118 environment of pmproxy PMCD_PORT is not used.
119 PMPROXY_HOST
121 For the PCP monitoring client this is the hostname or IP address
122 of the host where pmproxy is running. In recent versions of PCP
123 (since version 3) this has been superceded by the extended host‐
124 name syntax (see PCPIntro(1) for details).
125 PMPROXY_PORT
127 For the PCP monitoring client this is the port on which pmproxy
128 will accept connections. The default is 44322.
129 PMCD_CONNECT_TIMEOUT, PMCD_RECONNECT_TIMEOUT and PMCD_REQUEST_TIMEOUT
131 (see PCPIntro(1)) For the PCP monitoring client, setting these
132 environment variables will modify the timeouts used for interac‐
133 tions between the client and pmproxy (independent of which
134 pmcd(1) is being used). For pmproxy these same environment
135 variables control the timeouts between pmproxy and all pmcd(1)
136 instances (independent of which monitoring client is involved).
137
139 Environment variables with the prefix PCP_ are used to parameterize the
140 file and directory names used by PCP. On each installation, the file
141 /etc/pcp.conf contains the local values for these variables. The
142 PCP_CONF variable may be used to specify an alternative configuration
143 file, as described in pcp.conf(4).
144
146 PCPIntro(1), pmcd(1), pmdbg(1), pcp.conf(4) and pcp.env(4).
147
149 If pmproxy is already running the message "Error: OpenRequestSocket
150 bind: Address already in use" will appear. This may also appear if
151 pmproxy was shutdown with an outstanding request from a client. In
152 this case, a request socket has been left in the TIME_WAIT state and
153 until the system closes it down (after some timeout period) it will not
154 be possible to run pmproxy.
155 In addition to the standard PCP debugging flags, see pmdbg(1), pmproxy
157 currently uses DBG_TRACE_CONTEXT for tracing client connections and
158 disconnections
159Performance Co-Pilot SGI PMPROXY(1)