Various adjustments
[pstop.git] / README.md
1 pstop
2 =====
3
4 pstop - a top-like program for MySQL
5
6 pstop is a program which collects information from MySQL 5.6+'s
7 performance_schema database and uses this information to display server
8 load in real-time. This should also work for MariaDB 10.0 though I
9 have not tested this at all. Data is shown by table or filename and the
10 metrics also show how this is split between select, insert, update or
11 delete activity.
12
13 This program was started as a simple project to allow me to learn go,
14 which I'd been following for a while, but hadn't used in earnest.  This
15 probably shows in the code so suggestions on improvement are most welcome.
16
17 Access to MySQL is currently via a defaults-file which is assumed to be
18 ~/.my.cnf. I should probably make this more configurable.
19
20 See also BUGS and NEW_FEATURES which describe things that probably need
21 looking at, keys.txt which describes the keys used inside pstop, and
22 screen_samples.txt which provides some sample output from my own system.
23
24 Feedback and patches welcome.
25
26 Simon J Mudd
27 <sjmudd@pobox.com>