Skip to main content

Agent reference

Heartbeat payload (HAProxy-relevant)

The agent sends JSON including:

  • ip — declared/probed IPv4
  • hostname
  • haproxy block — monitored, active, topology, listeners, optional show stat summary

ServerCTL validates IP against enrollment and stores the latest row per node.

CLI essentials

sudo balctl_heartbeat.py --version
sudo balctl_heartbeat.py --provision-haproxy # local install
sudo balctl_heartbeat.py --update # from configured agent.zip URL
sudo journalctl -u balctl-heartbeat.service -f

Job loop

  1. POST /api/agents/heartbeat
  2. Server returns pending jobs
  3. Agent executes, posts POST /api/agents/jobs/complete

Full agent docs: agents/README.md in the repo.

Back to top