37b13958c63f6cc019a9bf96ec3c1651e90c6f51
[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. Data is shown by table or filename and the
9 metrics also show how this is split between select, insert, update or
10 delete activity.  User activity is now shown showing the number of
11 different hosts that connect with the same username and the actiity
12 of those users.
13
14 This program was started as a simple project to allow me to learn go,
15 which I'd been following for a while, but hadn't used in earnest.  This
16 probably shows in the code so suggestions on improvement are most welcome.
17
18 Access to MySQL is currently via a defaults-file which is assumed to be
19 ~/.my.cnf. I should probably make this more configurable.
20
21 Do not forget to ensure that the MySQL user you configure has access
22 to the performance_schema tables.
23
24 See also BUGS and NEW_FEATURES which describe things that probably need
25 looking at, keys.txt which describes the keys used inside pstop, and
26 screen_samples.txt which provides some sample output from my own system.
27
28 Feedback and patches welcome.
29
30 Simon J Mudd
31 <sjmudd@pobox.com>