HAProxy

• Overview
• Setup
  • Prerequisites
  • Configuration
• Metrics and Tags
  • Default Metric Tags
  • All Metrics

Overview

HAProxy is a free, very fast and reliable solution offering high availability, load balancing, and proxying for TCP and HTTP-based applications.

Setup

The haproxy plugin is included with the SolarWinds Snap Agent by default, please follow the directions below to enable it for a agent instance.

Prerequisites

This plugin requires that HAProxy is running and its stats endpoint API is available from the host where the plugin runs. The integration supports connecting via local/remote URI or unix socket.

You might want to customize the relevant values in haproxy configuration file:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
...
global
  ...
  stats socket /run/haproxy/haproxy.sock mode 660 level admin
...
listen stats
  bind 127.0.0.1:1936 # default
  stats enable
  stats auth admin:admin
  stats realm HAProxy\ Statistics
  stats show-node
  stats uri /haproxy?stats # default
...

Configuration

The agent provides an example configuration file to help you get started quickly. It defines the plugin and task file to be loaded by the agent, but requires you to provide the correct settings for your HAProxy server. To enable the plugin:

1. Make a copy of the haproxy example configuration file /opt/SolarWinds/Snap/etc/plugins.d/haproxy.yaml.example, renaming it to /opt/SolarWinds/Snap/etc/plugins.d/haproxy.yaml:

Copy

$ sudo cp /opt/SolarWinds/Snap/etc/plugins.d/haproxy.yaml.example /opt/SolarWinds/Snap/etc/plugins.d/haproxy.yaml

2. Update /opt/SolarWinds/Snap/etc/plugins.d/haproxy.yaml configuration file with settings specific to your HAProxy server for example:

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
collector:
  haproxy:
    all:
      ## Endpoint URI (required)
      ## Setting should correspond to values set in 'listen stats' section in haproxy.cfg at 'bind', 'mode' and 'stats uri'
      ## should begin with http:// or https://
      endpoint: "http://127.0.0.1:1936/haproxy?stats;csv"
      ##
      ## ... or with unix:// for socket-based connection, as set in haproxy.cfg at 'stats socket'
      # endpoint: "unix:///run/haproxy/haproxy.sock"
      ##
      ## Can optionally include auth credentials
      ## Setting should correspond to value set in haproxy.cfg at 'stats auth' (if any), eg:
      # endpoint: "http://username:password@127.0.0.1:1936/haproxy?stats;csv"
      ##
      ## Can also be a list of endpoints using embedded multiline YAML string syntax:
      # endpoint: |
      #   list:
      #     - endpoint: http://127.0.0.1:1936/haproxy?stats;csv
      #       username: username
      #       password: password
      #       timeout: 15s
      #
      ## Or in a simpler yet deprecated format:
      # endpoint: |
      #   unix:///run/haproxy/haproxy.sock
      #   http://username:password@my.remote.service.com:1936/haproxy?stats;csv
      #
      ## Timeout for connecting to HAProxy API
      ## Defaults to 5s
      # timeout: "5s"
load:
  plugin: snap-plugin-collector-aohaproxy
  task: task-aohaproxy.yaml

The setting endpoint (required): should be set to the valid HAProxy API server IP or FQDN or unix socket path. Can be a single endpoint or a yaml multiline string with many endpoints (newline-delimited). For multiline YAML, a yaml-in-yaml syntax with embedded key-value settings is also supported (since version 9 of the plugin).

The setting timeout (optional, defaults to 5s): it is a timeout for connecting to HAProxy stats endpoint.

3. Restart the agent:

Copy

$ sudo service swisnapd restart

4. Enable the HAProxy plugin in the AppOptics UI

On the Integrations Page you will see the HAProxy plugin available if the previous steps were successful. If you do not see the plugin, see Troubleshooting Linux.

Select the HAProxy plugin to open the configuration menu in the UI, and enable the plugin.

You should soon see the haproxy metrics reported to your dashboard.

Metrics and Tags

The table below lists each of the metrics gathered from the status endpoint.

Default Metric Tags

All HAProxy metrics are tagged with hostname. Instead of using this tag we recommend using the @host alias. Additionally, every metric is tagged with endpoint, pxname and svname.

Metrics status, check_status, agent_status and mode are additionally tagged with their original textual values.

All Metrics

All metrics keep their original names as returned from HAProxy stats and are extensively described in the official HAProxy CSV stats docs <https://cbonte.github.io/haproxy-dconv/1.9/management.html#9.1>.

Every metric can be requested in the following form: /haproxy/<endpoint>/<pxname>/<svname>/<metric_name> with the values in brackets given explicitly or using a wildcard (*). For endpoint(s), any valid substring of the requested endpoint(s) would work.

All available metrics list are listed below. Type values in are literally adapted from the official docs and state which type may have a value for given field. The types are L (Listeners), F (Frontends), B (Backends), and S (Servers).

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.