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

NAME

6       pmdahaproxy - HAProxy PMDA
7

DESCRIPTION

9       pmdahaproxy is a Performance Metrics Domain Agent (PMDA) which extracts
10       live performance data from HAProxy statistics socket or URL.
11
12       By default the HAProxy stats socket is used to retrieve the metric  but
13       if  the optional URL option is set (see below), then the HAProxy URL is
14       used instead.
15
16       See the HAProxy documentation for detailed description of each metric.
17

INSTALLATION

19       pmdahaproxy reads an optional ini-style configuration file
20
21           • $PCP_PMDAS_DIR/haproxy/haproxy.conf
22
23       This file can contain in its [pmda] section overriding values  for  the
24       following PMDA options:
25
26           • user
27           • socket
28
29       By  default,  root  and  /var/lib/haproxy/stats, are used as values for
30       these options, respectively.
31
32       The section can also contain the following parameters:
33
34           • url
35           • auth
36           • pass
37
38       When the url option is defined, URL connection to HAProxy is used.  pm‐
39       dahaproxy  expects  CSV data from the HAProxy URL; an example of a com‐
40       patible URL is http://127.0.0.1:9000/?stats;csv.
41
42       Note that the HAProxy statistics socket and/or URL  need  to  be  sepa‐
43       rately  enabled  in the HAProxy configuration file; please refer to the
44       HAProxy configuration documentation for details.  Depending  on  system
45       and  HAProxy  configuration,  using non-root user may also be possible,
46       especially with URL based connections.
47
48       Once the needed setup is ready, you can test the connection and install
49       the  PMDA to enable access to the names and values for the HAProxy per‐
50       formance metrics.  To install, do the following as root:
51
52           # cd $PCP_PMDAS_DIR/haproxy
53           # ./connect
54           # ./Install
55
56       To uninstall, do the following as root:
57
58           # cd $PCP_PMDAS_DIR/haproxy
59           # ./Remove
60
61       pmdahaproxy is launched by pmcd(1) and should  never  be  executed  di‐
62       rectly.   The  Install and Remove scripts notify pmcd(1) when the agent
63       is installed or removed.
64

FILES

66       $PCP_PMDAS_DIR/haproxy/haproxy.conf
67              configuration file for the pmdahaproxy agent
68
69       $PCP_PMDAS_DIR/haproxy/connect
70              connection test helper using the pmdahaproxy agent configuration
71
72       $PCP_PMDAS_DIR/haproxy/Install
73              installation script for the pmdahaproxy agent
74
75       $PCP_PMDAS_DIR/haproxy/Remove
76              undo installation script for the pmdahaproxy agent
77
78       $PCP_LOG_DIR/pmcd/haproxy.log
79              default log file for messages from the pmdahaproxy agent
80

PCP ENVIRONMENT

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

SEE ALSO

89       PCPIntro(1), haproxy(1) and pmcd(1).
90
91
92
93Performance Co-Pilot                  PCP                       PMDAHAPROXY(1)
Impressum