~percona-toolkit-dev/percona-toolkit/docu-ptc-rbr-limitation

« back to all changes in this revision

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