Using the Dashboard

Header bar

Located at the top of the screen, the header bar allows you to perform the following tasks:

Reload the page

Click on the HAProxy Enterprise Logo (1)

Enter the address of the HAProxy Enterprise node

In the URL Box (2), use a format similar to [<http|https>://]domain|IP[:port][/path]

Turn on or off data fetching

Click on the Start/Stop button (3). If you set the data refresh interval to "Off" in "Settings", you can display an instantaneous update by clicking "Refresh".

Display the overview

Click on Overview button (4)

Display the cluster overview

Click on Cluster button (5) Available only in Cluster Aggregation mode. In Single Mode, it displays the Cluster Setup Dialog (see below).

Display statistics

Click on Stats button (6)

Display stick tables

Click on Stick button (7)

Configure the Real-time Dashboard

Click Settings (8) to display configuration options

Info Bar

The Info Bar contains general information about an node. In Cluster Aggregation mode, it displays nodes to which the Real-time Dashboard is connected.

When in Cluster Aggregation mode, the main view of the Info Bar displays aggregated information; to drill down to information for each node, click the icon.

The Info bar gives the following information:

Overview

The Overview window is the initial view of the application. It displays the node-level (or cluster-level) summarized information, as well as key metric charts.

It contains the following elements:

HTTP Request Rate Chart (1)

Charts the total HTTP request rate across the node (or across all nodes in Cluster Mode).

HTTP Error Rate Chart (2)

Charts the total HTTP error rate across the node (or across all nodes in Cluster Mode).

Average Response Time Chart (3)

Charts the average response time across the node (or across all nodes in Cluster Mode).

HTTP Requests Panel (4)

Displays the node-level (or aggregate) HTTP Request related stats and limits.

SSL Connections Panel (5)

Displays the node-level (or aggregate) SSL Connection related stats and limits.

TCP Connections Panel (6)

Displays the node-level (or aggregate) TCP Connection related stats and limits.

Overview Charts

The Overview graphs display information for HTTP traffic, average response time, and SSL/TCP connections.

Zoom Level Selector (1)

Sets five different zoom levels for the Main Chart Display (30 seconds, 1 minute, 3 minutes, 10 minutes, and 30 minutes) The zoom level is synchronized across all three Overview Graphs.

Main Chart Display (2)

A tool tip appears when hovering over any chart point to show the detailed data point (time and value). This data point is synchronized across all three Overview Charts.

Time Axis (3)

Horizontal axis is the data point event time axis

Value Axis (4)

Vertical axis is the data-point values axis

Chart Navigator (5)

Displays the local data history in a miniature view with its own time axis.

Navigator Handles (6)

Focuses on a time period in the local history when you drag the handles. When you release the handle, the selected zoom level/period is synchronized across the three Overview Charts.

Stats Pane

The Stats Pane presents individual Proxy (frontend, backend or listen block) statistics, as well as individual Server statistics in a table view.

The Stats Pane consists of the following major sections:

Filter Block (1)

See Set filter criteria

Quick Navigation buttons (2)

Gives quick access to the selected Proxy on the screen.

Stats Tables (3)

Proxy and Server statistics, see Stats Pane under Data Fields for more detailed data on statistics values.

Quick Action Buttons (4)

See below

Stats Table

The tables operate slightly differently depending on the Data Source Mode:

• Single Node: Each server appears on one line, and its statistics and status come from the node to which Real-time Dashboard is connected.

• Cluster Aggregation: Each server appears as a header line in gray with statistics and status aggregated across all the nodes that it contains.

Depending on the mode, Stats tables display the following information:

Proxy Name

Real-time Dashboard infers from available server lines whether the block is a frontend, backend, or listen (or FE/BE pair with same name, which it treats as a listen block).

Server Names

Name of the server

Statistics Columns

Hover over each column heading to display additional information. If the server state is not up, the entire row takes on the Server State color, as used for Filter Block labels. See "Stats Pane" in the section Understanding data from Real-time Dashboard for more detailed data on statistics values.

Select filter

You can set filters in the following ways:

• Text - Allows filtering by Frontend or Backend Name (i.e. Proxy name) or by Server Name. There are three modes of filtering:

  • Partial String Matching: For example, when you enter "ss", it matches up with "blessing", "pass", or "sserver".

  • Multi-String Partial Matching: For example, when you enter "we se" it matches up with "webserver", "awesome_service" and "we_base".

  • RegEx Matching: For example, when you enter a string that begins and ends with a forward slash ("/") it matches only those strings that a regular expression between those two slashes would match. The precise regular expression syntax used is JavaScript Regular Expressions.

• Server Status - Allows filtering by server status. A click on any server status toggles its state between selected and unselected.

Use filter for administrative tasks

For a list of administrative tasks, see the section on how to Manage servers.

Reset filter

• Click to restore the filter to default state (all Proxies/Servers visible); this function is enabled only when filter is active.

Hide filter

• Click to collapse the filter block (to free up vertical screen space).

Retrieve a stick table

1. Click on in the header bar to display the Stick Table Explorer.

2. Select a table from a drop-down list (1).

3. Filter out any unwanted data by clicking (2) and specifying the filter criteria. Toggling this button shows or hides the filter.

4. Click (3) to retrieve the following stick table information (4):

   • Type - type of key

   • Length - number of table columns

   • Expires - how long a row is kept in the table before it expires

   • Purge - whether the table purges old elements

   • Size - maximum number of rows

   • Used - current number of rows

Apply filters

You can filter table data in two stages:

• Globally, prior to node retrieval (5): Real-time Dashboard retrieves data on the HAProxy Enterprise node itself according to the filtering criteria (up to four maximum).

• Locally, in the browser (6): In contrast to the global filter, which occurs on the HAProxy Enterprise node itself, the local filter happens within the browser. When you remove a criterion, the table refreshes accordingly; however, it has no effect on the amount of data retrieved from the node.

You can combine the two filters to limit the data retrieved and refine the data to display within the browser.

Export CSV

• Click (7) to download the entire table in CSV format.

Navigate between pages

1. Click on the page number (8) or << and >> to switch pages.

2. Choose the number of items to display: 10, 25, or 50.

Sort data

• Click on the up or down arrow next to the column header to sort data by ascending or descending order.

Overview Pane

The "Overview" pane displays general and summarized real-time information about the HAProxy Enterprise node.

Stats Pane

The "Stats" pane displays detailed real time information about the HAProxy Enterprise frontends and backends, and allows you to perform management actions on servers.

Perform an action on server(s)

1. Select a server by clicking on the checkbox next to its name. To select all servers in a block, click the checkbox next to the block name.

2. Select a task from the drop-down list (see below).

3. Click "Apply".