HATOP(1)

📦 version 0.8.2, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 HATOP — the manual, but make it make sense 💖

okay bestie, welcome to HATOP(1), from the General Commands Manual section of the library (yes she's filed under General Commands, she's that girl). HATop — an interactive ncurses client for haproxy. let's get into it 🫶

✨ SYNOPSIS ✨

hatop -s SOCKET [OPTIONS]

that's the whole vibe check. one required socket, everything else is optional 💅

🌸 DESCRIPTION 🌸

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

Her whole aesthetic is basically top(1) but for haproxy, and honestly? iconic. She supports various modes so you can dig into detailed stats for all your configured proxies and services in near realtime. 👑

AND — and this is the part that really ate — she's got an interactive CLI for the haproxy unix socket. which means admins can control the given haproxy instance directly out of hatop, like:

  • change server weight
  • put servers into maintenance mode
  • ...and more

all of it either via keybinds or straight through the CLI, and you get to watch the results update immediately. main character energy fr fr. 🔥

HATop talks to HAProxy over a unix domain socket. you set that up in your HAProxy config with the "stats socket" option. and listen — if you want all of HATop's features to actually show up, you need to set the "level" parameter of that option to "admin". don't skip that part, bestie, or she's gonna be giving half the show. 😭

🎀 OPTIONS 🎀

  • --version — shows the version number and then exits. cute, quick, done. ✨
  • -h, --help — shows the help message and exits.
  • -s SOCKET, --unix-socket=SOCKET — the path to the haproxy stats socket.
  • -i INTERVAL, --update-interval=INTERVAL — update interval in seconds. valid range is 1-30, default is 3.
  • -m MODE, --mode=MODE — start in a specific mode. valid range is 1-5, default is 1.
  • -n, --read-only — disables the cli and only queries for stats. no touching, just watching. 🙈

The following filter options may be given multiple times:

  • -f FILTER, --filter=FILTER — stat filter, in the format "<iid> <type> <sid>".
  • -p PROXY, --proxy=PROXY — proxy filter, in the format "<pxname>".

🦋 KEYBINDS 🦋

  • H, h, ? — display the help screen. your little safety net 🫶
  • Q, q — quit. bye bestie 👋
  • TAB — cycle mode forwards.
  • S-TAB — cycle mode backwards. (yes, backwards. we love a rewind)
  • ESC-n — switch to mode n, where n is the numeric mode id.
  • ESC — jump to the previous mode. take me back 🌀
  • ENTER — display the hotkey menu for the selected service.
  • SPACE — copy and paste the selected service identifier to the CLI. so handy, obsessed.
  • UP / DOWN / PGUP / PGDOWN / HOME / END — scroll the stat views to select a given service.

💅 HOTKEYS 💅

  • F4 — restore initial server weight.
  • F5 — decrease server weight: - 10
  • F6 — decrease server weight: - 1
  • F7 — increase server weight: + 1
  • F8 — increase server weight: + 10
  • F9 — enable server (return from maintenance mode).
  • F10 — disable server (put into maintenance mode).
lowkey the F-keys are where the real power lives. weight goes up, weight goes down, servers get yeeted into maintenance and pulled right back out. queen behavior 👑

🌈 SEE ALSO 🌈

a much better documentation can be found online:

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

⭐ AUTHOR ⭐

HATop and this man page was written by John Feuerstein.

and that's the whole page, bestie 💖 this version is HATOP(1) from the General Commands Manual, dated 19 August 2010. go forth, monitor your proxies, and slay ✨🎀

📦 where this page comes from