The Real-Time Dashboard is a user interface for real-time monitoring and management of an HAProxy instance.

It draws on the concepts and features of the HAProxy Stats Web page to provide a graphical overview of specific metrics, real-time statistic updates, and other functions.

The Real-Time Dashboard can also work in in cluster mode to monitor and display aggregated statistics for multiple related HAProxy instances. In this mode, you can carry out administrative tasks on these instances via a unified interface.

Prerequisites

  • The Real-Time Dashboard works with HAProxy Enterprise versions 1.7 and higher.

  • Older versions of HAProxy Enterprise require the Real-Time Dashboard Gateway.

Installing the Real-Time Dashboard

You can use the Real-Time Dashboard as a Web interface or as a graphic user interface on a local machine.

Web application

The Real-Time Dashboard is an Web interface that does not require any installation.

Users with a valid HAProxy Technologies Customer Portal account have immediate access to the Real-Time Dashboard:

  1. Go to http://dashboard.haproxy.com/.

  2. Browse to the section HAProxy Enterpris Real-Time Dashboard Module.

Local machine

Install the Real-Time Dashboard
  1. Get the HAPPE RT Dashboard package for your distribution, located in the hapee-plus repository for each supported distribution. The name of the package is hapee-<full-version-name>-lb-dashboard. See the HAProxy Enterpris User Guide for installation instructions.

  2. Set up a minimal Web server to serve static files anywhere on your network.

  3. Locate the Web server's "document root" (usually /var/www/html/)

  4. Create a shortcut (symlink) or copy the files from the directory /opt/hapee-<version>/dashboard/dashboard/ to the Web server's document root sub-directory dashboard/, as follows:

    cd /var/www/html
    
    # Symlink (preferred)
    ln -sf /opt/hapee-*/dashboard/dashboard .
    
    # Copy
    cp -a /opt/hapee-*/dashboard/dashboard .
  5. Access the Real-Time Dashboard at http://web.server.address/dashboard/index.html.

  6. Configure HAProxy instances to respond to requests coming from Real-Time Dashboard (see below).

Configuring HAProxy instances

To access HAProxy instances from the Real-Time Dashboard, you load a configuration block into each instance in order to connect it to HAProxy processes.

  1. Load a configuration file /etc/hapee-<version>/dashboard-module.cfg with HAProxy instances on startup, which must go under the OPTIONS environment variable in the configuration file for your operating system, as follows:

    • Debian: /etc/default/hapee-<version>-lb

    • Redhat: /etc/sysconfig/hapee-<version>-lb

      # HAPEE LB Environment variables
      
      # HAPEE lb configuration file can reference environment variables from this
      # file. Be careful, due to a systemd limitation, variables are not reloaded on
      # 'systemctl reload', use 'systemctl restart' to reload variables.
      
      # Extra options to the haproxy daemon can be set here.
      OPTIONS="-f /etc/hapee-<version>/dashboard-module.cfg"
  2. Reload the HAProxy service, as follows:

    systemctl reload hapee-<version>-lb.service
  3. In all commands and filenames above, replace <version> with your current HAProxy Enterprise version.

Loading the configuration file for Real-Time Dashboard

  1. From an HAProxy configuration file named dashboard-module.cfg, load a Lua configuration file (config.lua).

  2. Load config.lua before the line that loads the dashboard.luac module in dashboard-module.cfg.

Defining an Aggregation Cluster

The Real-Time Dashboard supports the aggregation of statistics across multiple HAProxy instances (or separate HAProxy processes running in parallel, or any combination of these), with simultaneous control of these instances through a single instance.

We refer to this instance as the Aggregation Master instance.

There are two types of HAProxy instances in such deployment: the Master Node instance, and other Node instances.

The Real-Time Dashboard UI in the Web browser connects directly to the Aggregation Master instance, which communicates with other nodes. The topology is shown below:

Aggregation Cluster Topology

Aggregation Cluster Topology

In general, the nodes are identified by a combination of IP address and port that the Real-Time Dashboard uses to listen on for each instance.

The Master Node keeps a list of other nodes in its local state. The Master Node provides two services to the Dashboard:

  • It collects the statistics data from other nodes, and sends them to the Real-Time Dashboard upon receiving a request for it

  • When it receives administrative actions for the Aggregation Cluster, it relays these actions to each node specified in the original action payload, collects the responses (i.e. results from the action), and relays the collected responses back to the Real-Time Dashboard.

Prerequisites

  • HAProxy Enterprise version >= 1.7 on all HAProxy Enterprise instances within the in the cluster

  • HAProxy Enterprise Dashboard Module v0.9 or higher must be installed and configured on all instances.

Set up an aggregation cluster

To set up a new aggregation cluster:

  • If you are in "Single Node" data source mode: click on cluster_icon to display the "Cluster Setup" window.

  • If you are in "Cluster Aggregation" data source mode, click clustersetup_icon on the right side of the "Cluster Overview" pane to display the "Cluster Setup" window.

//cdn.haproxy.com/documentation/hapee/1-8r1/_assets/images/rtd-graphics/rtd-cluster-setup.png

The current Real-Time Dashboard instance becomes the new master node by default. You can set a different node the "Master Node" box.

Note

You can close the dialog box at any time without making changes.

  1. Enter the cluster nodes IPs in the boxes. The nodes displayed in the setup window come from the configuration of the master node.

  2. If necessary, click add_icon to add more nodes, or trash_icon to delete them.

  3. Click "Create Cluster". When successful, a green check mark appears next to the node; if not, a red X appears.

  4. Click "Use Cluster" to switch Real-Time Dashboard to work in cluster mode.

Initialize an Aggregation Cluster

There are three different ways in which you can initialize an Aggregation Cluster, using:

  • A declarative configuration with the config.lua file

  • The Dashboard Cluster Setup window (see below)

  • The JSON RESTful API of the Dashboard Module, or Dashboard Gateway.

After you bring up all the instances, you instantiate the Master Node by passing it the list of nodes in a JSON array of strings containing the IP:port pairs to the /cluster/nodes endpoint with a PUT request.

For example, a cluster that includes the following nodes:

Node

Node IP address

Real-Time Dashboard port

1

127.0.0.1

9022

2

127.0.0.2

9122

3

127.0.0.3

9222

The JSON array sent to the Master Node looks like the following:

[
    "127.0.0.1:9022",
    "127.0.0.2:9122",
    "127.0.0.3:9222"
]

Using curl and the following parameters:

  • Master node: 127.0.0.1:9022

  • User name and password: dashboard:test (Basic Authorization configured in Real-Time Dashboard configuration file /etc/hapee-<version>/dashboard-module.cfg).

  • Request Content-Type: application/json

    curl -XPUT -s -u dashboard:test 127.0.0.1:9022/cluster/nodes \
         -H "Content-Type: application/json" \
         -d '["127.0.0.1:9022", "127.0.0.2:9122", "127.0.0.3:9222"]'

The master node solicits acknowledgment from the other nodes, and it returns a list of all nodes with available stats with a host:port and HTTP status code like the following:

{"127.0.0.1:9022":201, "127.0.0.2:9122":201, "127.0.0.3:9222":201}
  • If the requests are successful, the status codes indicate 201.

  • The master node retains only the nodes that were successfully added in its state and collects their data.

    Tip

    You can perform a GET request from the same endpoint /cluster/nodes to get a list of nodes added to the aggregation cluster in JSON array form, e.g. ["127.0.0.1:9022", "127.0.0.2:9122", "127.0.0.3:9222"]

  • The Master Node receives and returns its own IP:port. This is necessary, but it does not have to be the first entry in the array.

Add/delete nodes

You can add and/or delete nodes from aggregation performing a PUT request for a different array of nodes to the /cluster/nodes endpoint in the master node. The change takes effect in Real-Time Dashboard when it gets the next cluster data response with the new list of nodes.

Stop aggregation

You can stop aggregation on the Master Node by performing a PUT request for an empty tray. The node ceases to be the master node.

Aggregation Cluster and Stick Table Aggregator

Real-Time Dashboard also works with the Stick Table Explorer to enable you to explore the contents of HAProxy Stick Tables in your instance(s).

The aggregation cluster mode assumes that the Stick Table Aggregator (hapee-stktagg) aggregates stick tables across the same set of instances, and that the master node instance uses aggregated stick tables from the Stick Table Aggregator.

Local tables used for aggregation have the suffix .local, and resulting aggregated tables have the suffix with .aggr (modifiable in General Settings).

Note

If you do not use the Stick Table Aggregator in aggregation cluster mode, then stick tables are only available in the single node mode from each of the HAProxy instances; in cluster mode, the non-aggregated tables get filtered out. The Stick Table Explorer pane is available, but the list of available stick tables is empty.

Apart from setting up the aggregation cluster and editing table suffixes as necessary, there is no additional setting to configure in Real-Time Dashboard.

Configuring the Real-Time Dashboard

You configure the Real-Time Dashboard in "Settings" at the top right of the header bar.

Real-Time Dashboard basic settings

Real-Time Dashboard basic settings

Real-Time Dashboard saves these settings automatically in the browser's "local storage" and they persist throughout page reloads and browser restarts.

  1. You can modify the following settings:

    Basic setting

    Description

    Data Refresh Interval

    Data refresh period.

    Theme

    GUI theme. Currently available themes are Dark (default) and Light.

    Data Source

    Real Time Dashboard Module (default) or Real Time Dashboard Gateway.

    Data Source Mode

    • Single Node - Real-Time Dashboard requests and displays only the data from the module instance it connects to, or the addressed node when the data source is Gateway

    • Cluster Aggregation - Real-Time Dashboard requests and displays data from all HAProxy instances from which the module or Gateway was configured to aggregate data.

    Username

    Username for connecting to the Module or Gateway.

    Password

    Password for connecting to the Module or Gateway.

    Real Time Dashboard Gateway Address

    URL of the Real-Time Dashboard Gateway (applicable when Data Source is set to "Real-Time Dashboard Gateway").

    Advanced setting

    Description

    Number Format

    Select between three different formats to display numerical values in Real-Time Dashboard:

    • Human Readable - formats values and adds SI order-of-magnitude suffixes (i.e. 1.26 kb/s)

    • Formatted Values - inserts commas in the value and limits the number of decimal places (i.e. 1,261.00 b/s)

    • Raw Values - displays the raw value from the statistics, except when Real-Time Dashboard calculates the value, in which case it also limits the number of decimal places (i.e. 1261.00 b/s)

    Calculated Values Source

    • Frontend Values - The values for graphs and Info Bar are summarized from the frontend block stats, errors are request errors

    • Backend Values - The values for graphs and Info Bar are summarized from the backend block stats, errors are response errors

    Cluster Overview Node Display

    Determines the Node display format on Cluster Overview pane:

    • Node #Process ID - i.e. my_server #2

    • Host:Port - i.e. 127.0.0.1:9022

    Warning Threshold

    For values on the Overview Pane with configured limits, this determines the percentage of the limit acting as a threshold over which values show a warning color (yellow). Default is 70%.

    Critical Threshold

    For values on the Overview Pane with configured limits, this determines the percentage of the limit acting as a threshold over which values show a critical color (red). Default is 90%.

    Aggregated Stick Table Suffix

    The suffix that the Stick Table Aggregator takes on to denote the aggregated (i.e. to) stick tables. Default is .aggr

    Local Stick Table Suffix

    The suffix that the Stick Table Aggregator takes on to denote the source (i.e. from) stick tables. Default is .local

    Module HTTP Port

    Port number that Real-Time Dashboard listens on by default for non-TLS HTTP connections. If there is no other value specified in the Header URL Box, this is the port number that Real-Time Dashboard connects to. Default: 9022.

    Module HTTPS Port

    Port number where the Real-Time Dashboard listens on by default for HTTPS connections (when the URL Box is in "locked" state lock_icon). Default: 9023.

    Gateway TCP Port

    Port number where the HAProxy Admin Socket listens on by default for non-TLS socket connections. This value gets relayed to the Dashboard Gateway if there is no other value specified in the URL Box. Default: 9024.

    Gateway SSL Port

    Port number where the HAProxy Admin Socket listens on by default for TLS-encrypted socket connections (when the URL Box is in "locked" state lock_icon. If there is no other port value given, this value gets relayed to the Dashboard Gateway). Default: 9025.

  2. Click "Close" to modify your settings.

  3. Click "Load defaults" if you need to return to default settings.

Reading metrics in Real-Time Dashboard

Overview

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

//cdn.haproxy.com/documentation/hapee/1-8r1/_assets/images/rtd-graphics/overview2.png

It contains the following elements:

HTTP Request Rate Chart (1)

Charts the total HTTP request rate across the instance (or across all instances in Cluster Mode).

HTTP Error Rate Chart (2)

Charts the total HTTP error rate across the instance (or across all instances in Cluster Mode).

Average Response Time Chart (3)

Charts the average response time across the instance (or across all instances in Cluster Mode).

HTTP Requests Panel (4)

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

SSL Connections Panel (5)

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

TCP Connections Panel (6)

Displays the instance-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.

//cdn.haproxy.com/documentation/hapee/1-8r1/_assets/images/rtd-graphics/overviewcharts.png
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.

Reading statistics in Real-Time Dashboard

Stats Pane

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

//cdn.haproxy.com/documentation/hapee/1-8r1/_assets/images/rtd-graphics/statspane.png

The Stats Pane consists of the following major sections:

Filter Block (1)

See Setting 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 instance 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.

Drill down for more information

Click the add_icon icons to display statistics for each node (when in cluster mode)

Perform an administrative task

  1. Select a server or all servers in the proxy.

  2. Choose an action from the drop-down list.

  3. Click "Apply".

Enable or disable proxy

The "Enable/Disable" button on the right of the screen allows you to turn off the server for maintenance or turn it back on if it is down.

Reading proxy and server states

The Cluster Overview displays with a matrix/"spreadsheet" overview of states of Proxies and Servers for each connected HAProxy Node (see Dashboard Aggregation Cluster). The columns in the matrix represent the nodes (which can be HAProxy instances or processes).

//cdn.haproxy.com/documentation/hapee/1-8r1/_assets/images/rtd-graphics/clusterpane.png

The key elements on the pane are:

Quick navigation buttons (1)

Allows quick access to a server or proxy.

Cluster nodes (2)

The rows in the matrix represent HAProxy Nodes. The check boxes allow you to select a server or proxy on which to perform an administrative task.

Cluster Overview Matrix (3)

Displays an overview of statuses for Proxies and Servers across Nodes. Servers that do not exist on specific nodes display an empty space (background color) in the matrix.

Proxy Rows (4)

The rows are organized into Proxies containing Servers. The check boxes allow you to select a server or proxy on which to perform an administrative task.

Server Rows (5)

The status color of the header column is medium-gray when the status for the server varies across nodes

Server Columns (6)

Each cell (column) represents the Server status on that column's node.

Setting filter criteria

Filtering allows you to display or to perform administrative tasks on selected proxies (i.e. frontend, backend and/or listen blocks) in both Stats and Cluster panes.

The filter criteria persist when you switch between Stats and Cluster panes.

//cdn.haproxy.com/documentation/hapee/1-8r1/_assets/images/rtd-graphics/filterblock.png

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 Managing servers.

Reset filter

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

Hide filter

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

Retrieving Stick Table contents

The Stick Table Explorer enables the user to retrieve the contents of stick tables from the HAProxy instance, and to sort them and filter them to gain insight into the data contained within, and even export them into Excel-friendly CSV format.

//cdn.haproxy.com/documentation/hapee/1-8r1/_assets/images/rtd-graphics/rtd_1.1_st_explorer_elements_800.png

Retrieve a stick table

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

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

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

  4. Click get_icon (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 instance retrieval (5): Real-Time Dashboard retrieves data on the HAProxy instance 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 instance 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 data retrieved from the instance.

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

Set a filter using the interface

  1. Enter a key (string enclosed in quotes "").

  2. Select an operator from the drop-down list and enter a value.

    Note

    "Key" does not have any operator and requires a substring for matching.

Set a filter using an expression

  1. In the filter box, click on pencil_icon to turn it into a text input box.

  2. Enter an expression in the following format: [data_name operator value] AND [data_name operator value] ... AND [data_name operator value]. The logical AND is implicit in the filter and no other logical operator is accepted.

    where:

    • data_name is one of: key, server_id, gpc0, gpc0_rate, gpc1, gpc1_rate, conn_cnt, conn_cur, conn_rate, sess_cnt, sess_rate, http_req_cnt, http_req_rate, http_err_cnt, http_err_rate, bytes_in_cnt, bytes_in_rate, bytes_out_cnt, bytes_out_rate. When you hover over the table header, a tool tip displays its data point name.

    • operator is any of =, !=, <, >, <= and =>

    • value is numerical value used for comparison in the filter.

Export CSV

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

    Note

    All data gets exported to CSV, regardless of any filter previously set.

Sort data

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

Understanding data from Real-Time Dashboard

The Real-Time Dashboard interface contains a number of input and output values. The following list documents their meaning, syntax, and, if applicable, the current method of value calculation.

Overview Pane

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

Overview

Description

Overview - Throughput

Real time throughput rates for the HAProxy process, containing 3 values:

  • In - Rate of incoming data, in bits per second.

  • Out - Rate of outgoing data, in bits per second.

  • Error Rate - HTTP Error Rate, in errors per second.

Overview - HTTP Request Rate

A graph representation of HTTP request rate, in requests per second.

Overview - HTTP Error Rate

A graph representation of HTTP error rate, in errors per second.

Overview - Average Response Time

A graph representation of average HTTP response time, in milliseconds.

Overview - HAProxy Information

HAProxy process information, containing:

  • Instance name - HAProxy info field "Name"

  • Instance version - HAProxy info field "Version"

  • Node name - HAProxy info field "node"

  • Process ID - HAProxy info field "Pid"

  • Instance description - HAProxy info field "Description"

  • Uptime - HAProxy info field "Uptime"

  • Idle% - HAProxy info field "Idle_pct"

HTTP Requests

Description

HTTP Requests - Rate

Data block containing two values:

  • Current HTTP request rate, in requests per second.

  • Maximum allowed HTTP request rate, in requests per second.

HTTP Requests - Total

Data block containing two values:

  • Total HTTP requests since the HAProxy instance was started or since the counters were reset.

  • Highest HTTP request rate seen, in requests per second, since the HAProxy instance was started or since the counters were reset.

HTTP Requests - Error Rate

Data block containing two values:

  • Current HTTP error rate, in errors per second.

  • Highest HTTP error rate seen, in requests per second, since the HAProxy instance was started or since the counters were reset.

SSL Connections

Description

SSL Connections - Rate

Data block containing two values:

  • Current SSL connection rate, in requests per second.

  • Maximum allowed SSL connection rate, in requests per second.

SSL Connections - #Conn

Data block containing two values:

  • Current number of active SSL connections.

  • Maximum allowed number of active SSL connections.

SSL Connections - Total

Data block containing two values:

  • Total SSL connections since the HAProxy instance was started or since the counters were reset.

  • Highest SSL connection rate seen, in requests per second, since the HAProxy instance was started or since the counters were reset.

TCP Connections

Description

TCP Connections - Rate

Data block containing two values:

  • Current TCP connection rate, in requests per second.

  • Maximum allowed TCP connection rate, in requests per second.

TCP Connections - #Conn

Data block containing two values:

  • Current number of active TCP connections.

  • Maximum allowed number of active TCP connections.

TCP Connections - Total

Data block containing two values:

  • Total TCP connections since the HAProxy instance was started or since the counters were reset.

  • Highest TCP connection rate seen, in requests per second, since the HAProxy instance was started or since the counters were reset.

HAProxy Enterprise Real Time Dashboard Copyright and Version

Page footer containing the version of the HAProxy Enterprise Real Time Dashboard. The most recent released version is "v1.0".

Stats Pane

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

Filter

Description

Filter - Frontend/Backend Name

Filters the list and only displays frontend and backend sections whose name matches filter criteria.

Filter - Server Name Full or partial server name

Filters the list and only displays servers (and their corresponding frontend or backend sections) whose name matches the specified filter.

Filter - Server State List of server states

Filters the list and only displays servers (and their corresponding frontend or backend sections) whose state matches one of the selected states. Holding "Ctrl" while clicking on a particular state will deselect or select all other states for convenience.

Filter - Action to perform

Select the action to perform on all servers visible after filtering (see Managing servers)

Statistics

Description

Frontend or Backend Name

Name of the Frontend/Backend/Listen block (pxname). The checkbox left to the name selects all servers in the block for the Server Management ------ Actions at the bottom. For each server line:

Server name

Name of the server (svname)

Queue - Cur

Current number of requests in server's queue

Queue - Max

Maximum value of current queued requests

Queue - Limit

Configured maximum queue for the server

Session Rate - Cur

Number of sessions per second over last elapsed second

Session Rate - Max

Maximum number of new sessions per second

Session Rate - Limit

Configured limit on new sessions per second

Sessions - Cur

Current number of sessions

Sessions - Max

Maximum number of sessions

Sessions - Limit

Configured session limit

Sessions - Total

Cumulative number of sessions

Sessions - LbTot

Total number of times the server was selected

Bytes - In

Cumulative bytes in to server

Bytes - Out

Cumulative bytes out from server

Denied - Req

Requests denied due to security concerns

Denied - Resp

Responses denied due to security concerns

Error - Req

Request errors

Error - Conn

Number of requests that encountered an error while trying to connect to a backend server

Error - Resp

Response errors

Warnings - Retr

Number of times a connection to a server was retried

Warnings - Redis

Number of times a request was redispatched to another server

Server - Status

Current status and time elapsed since last UP <-> DOWN transition

Server - LastChk

Status of last health check

Server - Wght

Total weight (backend), or server weight (server)

Server - Act

Number of active servers (backend)

Server - Bck

Number of backup servers (backend

Server - Chk

Failed Health Checks

Server - Dwn

Number of UP -> DOWN transitions

Server - Dwntime

Total downtime (backend)

Server - Throttle

Current throttle percentage for the server

Actions

Action on server (see Managing servers)

  • Enable - Set server to READY

  • Disable - Set server to MAINT

Managing servers

You can perform specific management tasks on selected frontends, backends and listen blocks.

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".

Statistics

Description

Set state to READY

Set server state to READY (Enable Server)

Set state to DRAIN

Set server state to DRAIN (remove from load balancing, but remain available for health checks and persistent connections)

Set state to MAINT

Set server state to MAINT (Disable Server)

Health: disable checks

Mark primary server health checks as temporarily stopped

Health: enable checks

Enable primary server health checks

Health: force UP

Force server health to UP (regardless of pending checks)

Health: force NOLB

Force server health to NOLB state (regardless of slow checks)

Health: force DOWN

Force server health to DOWN (regardless of pending checks)

Agent: disable checks

Mark auxiliary agent checks as temporarily stopped

Agent: enable checks

Enable auxiliary agent checks

Agent: force UP

Force server agent state to UP

Agent: force DOWN

Force server agent state to DOWN

Kill Sessions

Immediately terminate all server sessions