~percona-toolkit-dev/percona-toolkit/1.0

« back to all changes in this revision

Viewing changes to docs/user/pt-mysql-summary.rst

  • Committer: Daniel Nichter
  • Date: 2011-07-14 19:08:47 UTC
  • Revision ID: daniel@percona.com-20110714190847-lggalkuvdrh7c4jp
Add standard pkg files (COPYING, README, etc.), percona-toolkit.pod, and user docs.  Remove dev/docs/html.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
################
 
3
pt-mysql-summary
 
4
################
 
5
 
 
6
.. highlight:: perl
 
7
 
 
8
 
 
9
****
 
10
NAME
 
11
****
 
12
 
 
13
 
 
14
pt-mysql-summary - Summarize MySQL information in a nice way.
 
15
 
 
16
 
 
17
********
 
18
SYNOPSIS
 
19
********
 
20
 
 
21
 
 
22
Usage: pt-mysql-summary [OPTION...]
 
23
 
 
24
 
 
25
***********
 
26
DESCRIPTION
 
27
***********
 
28
 
 
29
 
 
30
Goals: work well on all UNIXes; create a compact diff-able report that is
 
31
easy to paste into a wiki or email, and easy to scan and compare too.
 
32
 
 
33
To use, simply execute it.  Optionally add the same command-line options
 
34
you would use to connect to MySQL, such as "./mysql-summary --user=foo"
 
35
 
 
36
 
 
37
****
 
38
TODO
 
39
****
 
40
 
 
41
 
 
42
 
 
43
.. code-block:: perl
 
44
 
 
45
    * Parse queries out of processlist and aggregate them.
 
46
 
 
47
 
 
48
 
 
49
***********
 
50
DOWNLOADING
 
51
***********
 
52
 
 
53
 
 
54
Visit `http://www.percona.com/software/ <http://www.percona.com/software/>`_ to download the latest release of
 
55
Percona Toolkit.  Or, to get the latest release from the command line:
 
56
 
 
57
 
 
58
.. code-block:: perl
 
59
 
 
60
    wget percona.com/latest/percona-toolkit/PKG
 
61
 
 
62
 
 
63
Replace \ ``PKG``\  with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\  to download the package in that
 
64
format.  You can also get individual tools from the latest release:
 
65
 
 
66
 
 
67
.. code-block:: perl
 
68
 
 
69
    wget percona.com/latest/percona-toolkit/TOOL
 
70
 
 
71
 
 
72
Replace \ ``TOOL``\  with the name of any tool.
 
73
 
 
74
 
 
75
***********
 
76
ENVIRONMENT
 
77
***********
 
78
 
 
79
 
 
80
The environment variable \ ``PTDEBUG``\  enables verbose debugging output to STDERR.
 
81
To enable debugging and capture all output to a file, run the tool like:
 
82
 
 
83
 
 
84
.. code-block:: perl
 
85
 
 
86
    PTDEBUG=1 pt-mysql-summary ... > FILE 2>&1
 
87
 
 
88
 
 
89
Be careful: debugging output is voluminous and can generate several megabytes
 
90
of output.
 
91
 
 
92
 
 
93
*******************
 
94
SYSTEM REQUIREMENTS
 
95
*******************
 
96
 
 
97
 
 
98
You need Perl, DBI, DBD::mysql, and some core packages that ought to be
 
99
installed in any reasonably new version of Perl.
 
100
 
 
101
 
 
102
****
 
103
BUGS
 
104
****
 
105
 
 
106
 
 
107
For a list of known bugs, see `http://www.percona.com/bugs/pt-mysql-summary <http://www.percona.com/bugs/pt-mysql-summary>`_.
 
108
 
 
109
Please report bugs at `https://bugs.launchpad.net/percona-toolkit <https://bugs.launchpad.net/percona-toolkit>`_.
 
110
Include the following information in your bug report:
 
111
 
 
112
 
 
113
\* Complete command-line used to run the tool
 
114
 
 
115
 
 
116
 
 
117
\* Tool "--version"
 
118
 
 
119
 
 
120
 
 
121
\* MySQL version of all servers involved
 
122
 
 
123
 
 
124
 
 
125
\* Output from the tool including STDERR
 
126
 
 
127
 
 
128
 
 
129
\* Input files (log/dump/config files, etc.)
 
130
 
 
131
 
 
132
 
 
133
If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ;
 
134
see "ENVIRONMENT".
 
135
 
 
136
 
 
137
*******
 
138
AUTHORS
 
139
*******
 
140
 
 
141
 
 
142
Baron Schwartz
 
143
 
 
144
 
 
145
*********************
 
146
ABOUT PERCONA TOOLKIT
 
147
*********************
 
148
 
 
149
 
 
150
This tool is part of Percona Toolkit, a collection of advanced command-line
 
151
tools developed by Percona for MySQL support and consulting.  Percona Toolkit
 
152
was forked from two projects in June, 2011: Maatkit and Aspersa.  Those
 
153
projects were created by Baron Schwartz and developed primarily by him and
 
154
Daniel Nichter, both of whom are employed by Percona.  Visit
 
155
`http://www.percona.com/software/ <http://www.percona.com/software/>`_ for more software developed by Percona.
 
156
 
 
157
 
 
158
********************************
 
159
COPYRIGHT, LICENSE, AND WARRANTY
 
160
********************************
 
161
 
 
162
 
 
163
This program is copyright 2010-2011 Baron Schwartz, 2011 Percona Inc.
 
164
Feedback and improvements are welcome.
 
165
 
 
166
THIS PROGRAM IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
 
167
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 
168
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
169
 
 
170
This program is free software; you can redistribute it and/or modify it under
 
171
the terms of the GNU General Public License as published by the Free Software
 
172
Foundation, version 2; OR the Perl Artistic License.  On UNIX and similar
 
173
systems, you can issue \`man perlgpl' or \`man perlartistic' to read these
 
174
licenses.
 
175
 
 
176
You should have received a copy of the GNU General Public License along with
 
177
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 
178
Place, Suite 330, Boston, MA  02111-1307  USA.
 
179
 
 
180
 
 
181
*******
 
182
VERSION
 
183
*******
 
184
 
 
185
 
 
186
Percona Toolkit v1.0.0 released 2011-08-01
 
187