HAProxy Enterprise Documentation 2.1r1


The Real-Time Dashboard is a Web application that shows live metrics from your servers and allows you to manage HAProxy Enterprise by gathering statistics via a specialized endpoint.

As an HAProxy Enterprise customer, you have access to an instance of the dashboard within the Customer Portal at https://dashboard.haproxy.com.

You can also install the dashboard on your own server, as described here. In either case, this dashboard starts off empty until you connect it to a data source.

  1. Use your system's package manager (apt or yum) to install the dashboard package onto the HAProxy Enterprise server:

    $ # On Debian/Ubuntu
    $ sudo apt-get install hapee-2.1r1-lb-dashboard
    $ # On CentOS/RedHat/Oracle
    $ sudo yum install hapee-2.1r1-lb-dashboard
    $ # On SUSE
    $ sudo zypper install hapee-2.1r1-lb-dashboard
    $ # On FreeBSD
    $ sudo pkg install hapee-2.1r1-lb-dashboard

    This installs the following components:




    Configuration that exposes a new endpoint within HAProxy Enterprise at port 9022. When a request arrives at this port, HAProxy Enterprise dispatches it to a Lua module that returns statistics for the dashboard to use.


    Folder that contains the Lua module that exposes HAProxy Enterprise statistics. It contains:

    • dashboard.luac - Lua module for statistics.

    • dashboard-config.lua - Configuration file that defines a cluster of HAProxy Enterprise instances from which to gather statistics.


    Folder that contains the Web application for the dashboard.

  2. If you don't use the dashboard at https://dashboard.haproxy.com, copy the folder /opt/hapee-2.1/dashboard/dashboard to your Web server to host it yourself. Consult your Web server's instructions for hosting static files.

  3. By default, the Real-Time Dashboard configuration looks for metrics data at the same IP address as the one where it is hosted. You must configure HAProxy Enterprise to expose metrics data, and update the dashboard to point to this new data source.

Host the Real-Time Dashboard

  1. To give you an example of hosting the dashboard yourself, you can use the following Python commands to start a rudimentary web server, as follows:

    $ cd /opt/hapee-2.1/dashboard/dashboard
    $ python3 -m http.server 8000
  2. Open the Real-Time Dashboard at port 8000 using your Web browser.

    [Real-Time Dashboard]

Next up

Lua Module