X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.md;h=44105b262e7ae14a1391c34d38b5cad61f570b4e;hb=f742608f4ad8442336a9ca3b1cbedfe8df183a27;hp=5983b8fb26c5ced5a97fb6797c01e202ed83d509;hpb=61ff0f8849f480f8757739449a3e5b12d692478b;p=pstop.git diff --git a/README.md b/README.md index 5983b8f..44105b2 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,6 @@ update or delete activity. User activity is now shown showing the number of different hosts that connect with the same username and the actiity of those users. -This program was started as a simple project to allow me to learn -go, which I'd been following for a while, but hadn't used in earnest. -This probably shows in the code so suggestions on improvement are -most welcome. - ### Installation Install and update this go package with `go get -u github.com/sjmudd/pstop` @@ -22,13 +17,13 @@ Install and update this go package with `go get -u github.com/sjmudd/pstop` ### Configuration Access to MySQL is currently via a defaults-file which is assumed -to be `~/.my.cnf`. This should probably be made more configurable. -If you see a need for this please let me know. +to be `~/.my.cnf`. Alternatively you can now provide +-defaults-file=/path/to/.my.cnf if needed. ### Grants -Do not forget to ensure that the MySQL user you configure has access -to the `performance_schema` tables. +`pstop` needs `SELECT` access to `performance_schema` tables. It +will not run if access to the required tables is not available. ### Screens @@ -37,7 +32,12 @@ pstop has 5 different screens which get updated by default every second. * Ops (operations) mode: order table activity by the number of operations MySQL performs on them. * I/O mode: show where MySQL is spending it's time in file I/O. * Locks mode: show order based on table locks -* User mode: show ordering based on how long users are running queries, or the number of connections they have to MySQL. +* User mode: show ordering based on how long users are running +queries, or the number of connections they have to MySQL. This is +really missing a feature in MySQL (see: http://bugs.mysql.com/75156) +to provide higher resolution query times than seconds. It gives +some info but if the queries are very short then the integer runtime +in seconds makes the output far less interesting. You can change the polling interval and switch between modes (see below). @@ -62,9 +62,28 @@ See also: * [NEW_FEATURES](https://github.com/sjmudd/pstop/blob/master/NEW_FEATURES) which describe things that probably need looking at * [screen_samples.txt](https://github.com/sjmudd/pstop/blob/master/screen_samples.txt) provides some sample output from my own system. +### Contributing + +This program was started as a simple project to allow me (Simon) to learn +go, which I'd been following for a while, but hadn't used in earnest. +This probably shows in the code so suggestions on improvement are +most welcome. + +You may find "Contributing to Open Source Git Repositories in Go" +by Katrina Owen to be useful: +https://blog.splice.com/contributing-open-source-git-repositories-go/ + +### Licensing + +BSD 2-Clause License + ### Feedback -Feedback and patches welcome. +Feedback and patches welcome. I am especially interested in hearing +from you if you are using pstop, or if you have ideas of how I can +better use other information from the performance_schema tables to +provide a more complete vision of what MySQL is doing or where it's +busy. Simon J Mudd