DOKK / manpages / debian 10 / hatop / hatop.1.en
HATOP(1) General Commands Manual HATOP(1)

HATop - interactive ncurses client for haproxy

hatop -s SOCKET [OPTIONS]

HATop is an interactive ncurses client and real-time monitoring, statistics displaying tool for the HAProxy TCP/HTTP load balancer.

HATop's appearance is similar to top(1). It supports various modes for detailed statistics of all configured proxies and services in near realtime. In addition, it features an interactive CLI for the haproxy unix socket. This allows administrators to control the given haproxy instance (change server weight, put servers into maintenance mode, ...) directly out of hatop (using keybinds or the CLI) and monitor the results immediately.

HATop uses a unix domain socket to communicate with HAProxy. This can be configured in the HAProxy configuration using the "stats socket" option. To enable all of HATop's features the "level" parameter of this option should be set to "admin".

show version number and exit
show help message and exit
path to the haproxy stats socket
update interval in seconds (1-30, default: 3)
start in specific mode (1-5, default: 1)
disable the cli and query for stats only

The following filter options may be given multiple times:

stat filter in format "<iid> <type> <sid>"
proxy filter in format "<pxname>"

Display help screen
Quit
Cycle mode forwards
Cycle mode backwards
Switch to mode n, where n is the numeric mode id
Jump to previous mode
Display hotkey menu for selected service
Copy and paste selected service identifier to the CLI
Scroll the stat views to select a given service

Restore initial server weight

Decrease server weight: - 10
Decrease server weight: - 1
Increase server weight: + 1
Increase server weight: + 10

Enable server (return from maintenance mode)
Disable server (put into maintenance mode)

haproxy(1)

A much better documentation can be found online:

http://feurix.org/projects/hatop/

HATop and this man page was written by John Feuerstein.

19 August 2010