documentation".
90 | html_title = 'HATop: Interactive ncurses client for HAProxy'
91 |
92 | # A shorter title for the navigation bar. Default is the same as html_title.
93 | html_short_title = 'HATop'
94 |
95 | # The name of an image file (relative to this directory) to place at the top
96 | # of the sidebar.
97 | #html_logo = None
98 |
99 | # The name of an image file (within the static path) to use as favicon of the
100 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
101 | # pixels large.
102 | #html_favicon = None
103 |
104 | # Add any paths that contain custom static files (such as style sheets) here,
105 | # relative to this directory. They are copied after the builtin static files,
106 | # so a file named "default.css" will overwrite the builtin "default.css".
107 | html_static_path = ['static']
108 |
109 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
110 | # using the given strftime format.
111 | html_last_updated_fmt = '%b %d, %Y'
112 |
113 | # If true, SmartyPants will be used to convert quotes and dashes to
114 | # typographically correct entities.
115 | html_use_smartypants = True
116 |
117 | # Custom sidebar templates, maps document names to template names.
118 | html_sidebars = {
119 | 'index': 'indexsidebar.html',
120 | }
121 |
122 | # Additional templates that should be rendered to pages, maps page names to
123 | # template names.
124 | html_additional_pages = {
125 | 'index': 'indexcontent.html',
126 | }
127 |
128 |
129 |
130 | # If false, no module index is generated.
131 | html_use_modindex = False
132 |
133 | # If false, no index is generated.
134 | html_use_index = False
135 |
136 | # If true, the index is split into individual pages for each letter.
137 | html_split_index = False
138 |
139 | # If true, links to the reST sources are added to the pages.
140 | html_show_sourcelink = True
141 |
142 | # If true, an OpenSearch description file will be output, and all pages will
143 | # contain a {{ docstitle|e }}
4 |
5 |
7 |
8 | Welcome! This is
9 | {% block description %}the documentation for {{ project|e }}
10 | version {{ release|e }}{% if last_updated %}, last updated {{ last_updated|e }}{% endif %}{% endblock %}.
11 |
12 |
13 | What is HATop?
14 |
15 |
16 | HATop is an interactive ncurses client and real-time monitoring,HAProxy
19 | TCP/HTTP load balancer.
20 |
21 |
22 |
23 |
24 | HATop's appearance is similar to
25 | top (1).
26 | It supports various modes for detailed statistics of all configured proxies
27 | and services in near realtime. In addition, it features an interactive CLI for
28 | the haproxy unix socket. This allows administrators to control the given
29 | haproxy instance (change server weight, put servers into maintenance mode, ...)
30 | directly out of hatop (using keybinds or the CLI) and monitor the results
31 | immediately.
32 |
33 |
34 |
35 | HATop is written in pure Python
36 | and has no external dependencies.
39 |
40 |
41 |
42 |
43 |
46 |
47 |
48 |
49 | Documentation:
53 |
54 |
55 |
56 | What's new in HATop v{{ version }}? or see the complete changelog
58 | Complete Table of Contents lists all sections and subsections
60 |
61 |
62 | Screenshots some screenshots
64 | Keybinds keybind quickref
66 |
67 |
68 |
69 |
70 | Meta information:
71 |
72 |
73 |
74 | License and Copyright how you may use the code
76 |
77 | Reporting bugs please inform us of any problems
79 |
80 |
81 |
82 | {% endblock %}
83 |
84 | Quickstart
85 |
86 |
87 | First of all, make sure you have the stats socket enabled in the haproxy config:
88 |
89 |
90 |
global
91 | stats socket /var/run/haproxy/haproxy.sock mode 0600 level admin
92 |
93 |
96 | That's all you need to use HATop:
97 |
98 |
99 |
100 | $ hatop -s /var/run/haproxy/haproxy.sock
101 |
102 |
105 | See also:
106 | HATop Installation
108 |
109 | Development
110 |
111 |
112 | Getting the HATop source code using Git:
113 |
114 |
115 |
116 | $ git clone git://labs.feurix.org/feurix/admin/hatop.git
117 |
118 |
121 | See also:
122 | Git Webinterface Source Browser
125 |
126 | {% endblock %}
127 |
--------------------------------------------------------------------------------
/doc/templates/indexsidebar.html:
--------------------------------------------------------------------------------
1 | Documentation
2 |
9 |
10 | Examples
11 |
14 |
15 | Resources
16 |
21 |
22 | Downloads
23 |
28 |
29 | Contact us
30 |
31 |
32 | Support us
33 |
41 |
--------------------------------------------------------------------------------
/doc/templates/layout.html:
--------------------------------------------------------------------------------
1 | {% extends "!layout.html" %}
2 | {% block rootrellink %}
3 | Feurix Free Open Source Projects {{ reldelim1 }}{{ shorttitle }} {{ reldelim1 }}
14 |
16 | {% endblock %}
17 | {% block footer %}
18 |
23 | {% endblock %}
24 |
--------------------------------------------------------------------------------
/man/hatop.1:
--------------------------------------------------------------------------------
1 | .TH HATOP 1 "19 August 2010"
2 | .SH NAME
3 | HATop \- interactive ncurses client for haproxy
4 | .SH SYNOPSIS
5 | hatop \-s \fISOCKET\fB [\fIOPTIONS\fB]
6 | .SH DESCRIPTION
7 | HATop is an interactive ncurses client and real\-time monitoring,
8 | statistics displaying tool for the HAProxy TCP/HTTP load balancer.
9 |
10 | HATop's appearance is similar to top(1). It supports various modes for
11 | detailed statistics of all configured proxies and services in near realtime.
12 | In addition, it features an interactive CLI for the haproxy unix socket.
13 | This allows administrators to control the given haproxy instance
14 | (change server weight, put servers into maintenance mode, ...) directly out
15 | of hatop (using keybinds or the CLI) and monitor the results immediately.
16 |
17 | HATop uses a unix domain socket to communicate with HAProxy. This can be
18 | configured in the HAProxy configuration using the "stats socket" option.
19 | To enable all of HATop's features the "level" parameter of this option
20 | should be set to "admin".
21 | .SH OPTIONS
22 | .TP
23 | \fB\-\-version\fP
24 | show version number and exit
25 | .TP
26 | \fB\-h, \-\-help\fP
27 | show help message and exit
28 | .TP
29 | \fB\-s \fISOCKET\fB, \-\-unix\-socket=\fISOCKET\fP
30 | path to the haproxy stats socket
31 | .TP
32 | \fB\-i \fIINTERVAL\fB, \-\-update\-interval=\fIINTERVAL\fP
33 | update interval in seconds (1\-30, default: 3)
34 | .TP
35 | \fB\-m \fIMODE\fB, \-\-mode=\fIMODE\fP
36 | start in specific mode (1\-5, default: 1)
37 | .TP
38 | \fB\-n, \-\-read\-only\fP
39 | disable the cli and query for stats only
40 |
41 | .PP
42 | The following filter options may be given multiple times:
43 | .TP
44 | \fB\-f \fIFILTER\fB, \-\-filter=\fIFILTER\fP
45 | stat filter in format " "
46 | .TP
47 | \fB\-p \fIPROXY\fB, \-\-proxy=\fIPROXY\fP
48 | proxy filter in format ""
49 | .SH KEYBINDS
50 | .TP
51 | \fBHh?\fP
52 | Display help screen
53 | .TP
54 | \fBQq\fP
55 | Quit
56 | .TP
57 | \fBTAB\fP
58 | Cycle mode forwards
59 | .TP
60 | \fBS\-TAB\fP
61 | Cycle mode backwards
62 | .TP
63 | \fBESC\-n\fP
64 | Switch to mode n, where n is the numeric mode id
65 | .TP
66 | \fBESC\fP
67 | Jump to previous mode
68 | .TP
69 | \fBENTER\fP
70 | Display hotkey menu for selected service
71 | .TP
72 | \fBSPACE\fP
73 | Copy and paste selected service identifier to the CLI
74 | .TP
75 | \fBUP\fP / \fBDOWN\fP / \fBPGUP\fP / \fBPGDOWN\fP / \fBHOME\fP / \fBEND\fP
76 | Scroll the stat views to select a given service
77 | .SH HOTKEYS
78 | .TP
79 | \fBF4\fP
80 | Restore initial server weight
81 |
82 | .TP
83 | \fBF5\fP
84 | Decrease server weight: \- 10
85 | .TP
86 | \fBF6\fP
87 | Decrease server weight: \- 1
88 | .TP
89 | \fBF7\fP
90 | Increase server weight: + 1
91 | .TP
92 | \fBF8\fP
93 | Increase server weight: + 10
94 |
95 | .TP
96 | \fBF9\fP
97 | Enable server (return from maintenance mode)
98 | .TP
99 | \fBF10\fP
100 | Disable server (put into maintenance mode)
101 | .SH SEE ALSO
102 | .BR haproxy (1)
103 |
104 | A much better documentation can be found online:
105 | .PP
106 | http://feurix.org/projects/hatop/
107 | .SH AUTHOR
108 | HATop and this man page was written by John Feuerstein.
109 |
--------------------------------------------------------------------------------
/test/.gitignore:
--------------------------------------------------------------------------------
1 | *.sock
2 | *.txt
3 |
--------------------------------------------------------------------------------
/test/sample-socket.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # Thu Apr 08 16:51:58 CEST 2010 John Feuerstein
3 | #
4 | # This script emulates the haproxy stats unix socket to help in
5 | # hatop development and to provide some (fake) sample data.
6 |
7 | SOCKET_PATH='sample-socket.sock'
8 | SOCKET_PROMPT='> '
9 |
10 | import os
11 | import socket
12 | import sys
13 | import time
14 |
15 | if not len(sys.argv) == 3:
16 | sys.stderr.write(
17 | 'usage: %s '
18 | ' '
19 | '\n' % sys.argv[0])
20 | sys.exit(1)
21 |
22 | def read_info():
23 | with file(sys.argv[1]) as info:
24 | data = info.read()
25 | return data
26 |
27 | def read_stat():
28 | with file(sys.argv[2]) as stat:
29 | data = stat.read()
30 | return data
31 |
32 | try:
33 | os.unlink(SOCKET_PATH)
34 | except:
35 | pass
36 |
37 | s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
38 | s.bind(SOCKET_PATH)
39 | s.listen(1)
40 |
41 | while 1:
42 | conn, addr = s.accept()
43 |
44 | while 1:
45 | data = conn.recv(1024).strip()
46 | print('--- %s' % time.ctime())
47 | print('<<< %s' % data)
48 | if not data:
49 | continue
50 | if data == 'quit':
51 | break
52 | elif data.startswith('show info'):
53 | print('>>> info...')
54 | conn.sendall(read_info())
55 | elif data.startswith('show stat'):
56 | print('>>> stat...')
57 | conn.sendall(read_stat())
58 | print('>>> empty line (end of response)')
59 | conn.sendall('\n')
60 | print('>>> prompt')
61 | conn.sendall(SOCKET_PROMPT)
62 | print('--- %s\n' % time.ctime())
63 |
64 | conn.close()
65 |
66 |
--------------------------------------------------------------------------------
 }})
6 |
7 |  }})
44 | Download HATop v{{ version }} [hatop-{{ version }}.tar.gz]
45 |
46 |
47 |  }})
 }}){kind=logo}
15 |
16 | {% endblock %}
17 | {% block footer %}
18 |
23 | {% endblock %}
24 |
--------------------------------------------------------------------------------
/man/hatop.1:
--------------------------------------------------------------------------------
1 | .TH HATOP 1 "19 August 2010"
2 | .SH NAME
3 | HATop \- interactive ncurses client for haproxy
4 | .SH SYNOPSIS
5 | hatop \-s \fISOCKET\fB [\fIOPTIONS\fB]
6 | .SH DESCRIPTION
7 | HATop is an interactive ncurses client and real\-time monitoring,
8 | statistics displaying tool for the HAProxy TCP/HTTP load balancer.
9 |
10 | HATop's appearance is similar to top(1). It supports various modes for
11 | detailed statistics of all configured proxies and services in near realtime.
12 | In addition, it features an interactive CLI for the haproxy unix socket.
13 | This allows administrators to control the given haproxy instance
14 | (change server weight, put servers into maintenance mode, ...) directly out
15 | of hatop (using keybinds or the CLI) and monitor the results immediately.
16 |
17 | HATop uses a unix domain socket to communicate with HAProxy. This can be
18 | configured in the HAProxy configuration using the "stats socket" option.
19 | To enable all of HATop's features the "level" parameter of this option
20 | should be set to "admin".
21 | .SH OPTIONS
22 | .TP
23 | \fB\-\-version\fP
24 | show version number and exit
25 | .TP
26 | \fB\-h, \-\-help\fP
27 | show help message and exit
28 | .TP
29 | \fB\-s \fISOCKET\fB, \-\-unix\-socket=\fISOCKET\fP
30 | path to the haproxy stats socket
31 | .TP
32 | \fB\-i \fIINTERVAL\fB, \-\-update\-interval=\fIINTERVAL\fP
33 | update interval in seconds (1\-30, default: 3)
34 | .TP
35 | \fB\-m \fIMODE\fB, \-\-mode=\fIMODE\fP
36 | start in specific mode (1\-5, default: 1)
37 | .TP
38 | \fB\-n, \-\-read\-only\fP
39 | disable the cli and query for stats only
40 |
41 | .PP
42 | The following filter options may be given multiple times:
43 | .TP
44 | \fB\-f \fIFILTER\fB, \-\-filter=\fIFILTER\fP
45 | stat filter in format "