python-haproxy

Read or write to the HAProxy stats socket.

This is a fork of https://github.com/nl5887/python-haproxy

Install

This is available via the pip command:

pip install hapctl

CLI Usage

This provides a hapctl command.

# See the help menu
hapctl --help

# Run a command against the socket
hapctl --socket=/path/to/socket "<command here>"

For example:

hapctl --socket=/run/haproxy/admin.sock "show info"

Note that the command "show info" is quoted, as it includes spaces.

Python Usage

You can it it in code directly:

from hapctl import haproxy

stats = haproxy.HAProxyStats('/run/haproxy/admin.sock')

result = stats.execute('show info')

print(result) # [u'Name: HAProxy', u'Version: 1.4.18' ...]

Available Commands

Available socket commands can be found under section 9.2 "Unix Socket commands" in the Haproxy 1.6 (current stable version) management docs.

Some common commands are shown here:

clear counters : clear max statistics counters (add 'all' for all counters)
help           : HAProxy help message, which lists available commands
prompt         : toggle interactive mode with prompt
quit           : disconnect
show info      : report information about the running process
show stat      : report counters for each proxy and server
show errors    : report last request and response errors for each proxy
show sess [id] : report the list of current sessions or dump this session
get weight     : report a server's current weight
set weight     : change a server's weight  
set timeout    : change a timeout setting
disable server : set a server in maintenance mode
enable server  : re-enable a server that was previously in maintenance mode