HAProxy plugin
This plugin
collects statistics from an HAProxy instance.
To get statistics from HAProxy instance, you must instruct HAProxy where to host the statistics. Either a filesocket or webpage can be specified.
Prerequisites
Meter 4.2 or later must be installed.
The HAProxy plugin supports the following Operating Systems.
Linux | ✅️ |
Windows | ✅️ |
Smart OS | ✅️ |
OS X | ✅️ |
Plugin setup
The plugin requires a web page to collect HAProxy statistics.
To use a File Socket for hosting HAProxy statistics
The following snippet of configuration will host the statistics on a file socket.
- The mode parameter sets the mode of the file socket.
If the relay is running as the same user as haproxy, mode 777 can be omitted. - The level parameter limits the commands available from the file socket.
To use a Web Page for hosting HAProxy statistics
The following snippet of configuration will tell haproxy to host a webpage the plugin will scrape (you can view the webpage as well)
- stats enable tells haproxy to enable the webpage.
- stats uri /stats tells haproxy to host the webpage at /stats. Use a unique URL that is not being used in your application. If your website already has a /stats page, use another value.
- stats auth username:password tells haproxy to password protect the page with the username and password combination.
- stats refresh 10 tells haproxy to refresh the webpage every 10 seconds if your browser is viewing it.
After you make the update, type sudo service haproxy reload to reload your haproxy configuration.
To install the plugin
- From the top right of the screen, perform one of the following actions:
- Click
> Data Collection, select the TrueSight meter, and select the Sources tab.
- Click
> Configure Sources.
- Click
- Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
- Click the name of the source to view source details.
- Select the Plugins tab.
- Use the search box or scroll through the page to find the plugin you want to install.
Click + Install to start the installation.
Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.
Configuration details
Field Name | JS | LUA | Description |
---|---|---|---|
Source | X | X | The Source to display in the legend for the haproxy data. It will default to the hostname of the server |
Socket path | X |
| The Haproxy statistics Socket path. Socket or URL is required |
Statistics URL | X | X | The URL endpoint of where the haproxy statistics are hosted. Socket or URL is required |
Username | X | X | If the endpoint is password protected, what username should graphdat use when calling it. |
Password | X | X | If the endpoint is password protected, what password should graphdat use when calling it. |
Filter | X | X | Which Server groups would you like to view |
Poll Seconds | X | X | How often should the plugin poll the Haproxy endpoint |
Plugin metrics
Metric Name | Description |
---|---|
Haproxy Queued Requests | current queued requests |
Haproxy Queue Limit | queue Limit |
Haproxy Handled Requests | total number of HTTP requests handled |
Haproxy Client Aborts | number of data transfers aborted by the client |
Haproxy Server aborts | number of data transfers aborted by the server |
Haproxy Current Sessions | current sessions |
Haproxy Session Limit | session limit |
Haproxy Bytes In | bytes in |
Haproxy Bytes Out | bytes out |
Haproxy Warnings | retries + redispatched |
Haproxy Errors | request errors + connection errors + response errors |
Haproxy Failed Health Checks | the number of failed health checks |
Haproxy Downtime | the number of seconds haproxy is down |
Haproxy 1XX Resp | The number of 1XX HTTP responses |
Haproxy 2XX Resp | the number of 2XX HTTP responses |
Haproxy 3XX Resp | the number of 3XX HTTP responses |
Haproxy 4XX Resp | the number of 4XX HTTP responses |
Haproxy 5XX Resp | the number of 5XX HTTP responses |
Haproxy Other Resp | http responses with other codes (protocol error) |