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

« back to all changes in this revision

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