percona/percona-toolkit
1
0
Fork 0
mirror of https://github.com/percona/percona-toolkit.git synced 2025-09-09 18:30:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update RISKS section in all tools.

Browse Source
This commit is contained in:
Daniel Nichter
2013-03-09 09:50:49 -07:00
parent 61983050de
commit 157c7ad5d5
32 changed files with 432 additions and 494 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
bin/pt-align
View File

@@ -99,22 +99,21 @@ then pt-align reprints the output as,
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-align is a read-only tool. It should be very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-align>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

30
bin/pt-archiver
View File

@@ -6474,7 +6474,7 @@ pt-archiver - Archive rows from a MySQL table into another table or a file.
=head1 SYNOPSIS
Usage: pt-archiver [OPTION...] --source DSN --where WHERE
Usage: pt-archiver [OPTIONS] --source DSN --where WHERE
pt-archiver nibbles records from a MySQL table. The --source and --dest
arguments use DSN syntax; if COPY is yes, --dest defaults to the key's value
@@ -6495,29 +6495,21 @@ Purge (delete) orphan rows from child table:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-archiver is a read-write tool. It deletes data from the source by default,
so you should test your archiving jobs with the L<"--dry-run"> option if
you're not sure about them. It is designed to have as little impact on
production systems as possible, but tuning with L<"--limit">, L<"--txn-size">
and similar options might be a good idea too.
=over
If you write or use L<"--plugin"> modules, you should ensure they are good
quality and well-tested.
=item * Read the tool's documentation
At the time of this release there is an unverified bug with
L<"--bulk-insert"> that may cause data loss.
=item * Review the tool's known L<"BUGS">
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-archiver>.
=item * Test the tool on a non-production server
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

23
bin/pt-config-diff
View File

@@ -5248,22 +5248,21 @@ Diff the [mysqld] section of two option files:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-config-diff reads MySQL's configuration and examines it and is thus very
low risk.
=over
At the time of this release there are no known bugs that pose a serious risk.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-config-diff>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

26
bin/pt-deadlock-logger
View File

@@ -4879,25 +4879,21 @@ Save deadlocks on host1 to percona_schema.fke on host2:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-deadlock-logger is a read-only tool unless you specify a L<"--dest"> table.
In some cases polling SHOW INNODB STATUS too rapidly can cause extra load on the
server. If you're using it on a production server under very heavy load, you
might want to set L<"--interval"> to 30 seconds or more.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-deadlock-logger>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

25
bin/pt-diskstats
View File

@@ -4824,7 +4824,7 @@ pt-diskstats - An interactive I/O monitoring tool for GNU/Linux.
=head1 SYNOPSIS
Usage: pt-diskstats [OPTION...] [FILES]
Usage: pt-diskstats [OPTIONS] [FILES]
pt-diskstats prints disk I/O statistics for GNU/Linux. It is somewhat similar
to iostat, but it is interactive and more detailed. It can analyze samples
@@ -4832,22 +4832,21 @@ gathered from another machine.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-diskstats simply reads F</proc/diskstats>. It should be very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-diskstats>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

26
bin/pt-duplicate-key-checker
View File

@@ -5038,7 +5038,7 @@ pt-duplicate-key-checker - Find duplicate indexes and foreign keys on MySQL tabl
=head1 SYNOPSIS
Usage: pt-duplicate-key-checker [OPTION...] [DSN]
Usage: pt-duplicate-key-checker [OPTIONS] [DSN]
pt-duplicate-key-checker examines MySQL tables for duplicate or redundant
indexes and foreign keys. Connection options are read from MySQL option files.
@@ -5047,23 +5047,21 @@ indexes and foreign keys. Connection options are read from MySQL option files.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-duplicate-key-checker is a read-only tool that executes SHOW CREATE TABLE and
related queries to inspect table structures, and thus is very low-risk.
=over
At the time of this release, there is an unconfirmed bug that causes the tool
to crash.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-duplicate-key-checker>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

25
bin/pt-fifo-split
View File

@@ -1380,24 +1380,21 @@ Read hugefile.txt in chunks of a million lines without physically splitting it:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-fifo-split creates and/or deletes the L<"--fifo"> file. Otherwise, no other
files are modified, and it merely reads lines from the file given on the
command-line. It should be very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-fifo-split>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

28
bin/pt-find
View File

@@ -4175,7 +4175,7 @@ pt-find - Find MySQL tables and execute actions, like GNU find.
=head1 SYNOPSIS
Usage: pt-find [OPTION...] [DATABASE...]
Usage: pt-find [OPTIONS] [DATABASES]
pt-find searches for MySQL tables and executes actions, like GNU find. The
default action is to print the database and table name.
@@ -4213,25 +4213,21 @@ As above, but this time, insert the data back into the database for posterity:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-find only reads and prints information by default, but L<"--exec"> and
L<"--exec-plus"> can execute user-defined SQL. You should be as careful with it
as you are with any command-line tool that can execute queries against your
database.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-find>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

20
bin/pt-fingerprint
View File

@@ -1925,15 +1925,21 @@ Convert a file full of queries:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
The pt-fingerprint tool simply reads data and transforms it, so risks are
minimal.
=over
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Read the tool's documentation
=item * Review the tool's known L<"BUGS">
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

26
bin/pt-fk-error-logger
View File

@@ -4031,7 +4031,7 @@ pt-fk-error-logger - Log MySQL foreign key errors.
=head1 SYNOPSIS
Usage: pt-fk-error-logger [OPTIONS] DSN
Usage: pt-fk-error-logger [OPTIONS] [DSN]
pt-fk-error-logger logs information about foreign key errors on the given
DSN. Information is printed to C<STDOUT>, and it can also be saved to a
@@ -4052,23 +4052,21 @@ Save foreign key errors on host1 to percona_schema.fke on host2:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-fk-error-logger is read-only unless you specify L<"--dest">. It should be
very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-fk-error-logger>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

24
bin/pt-heartbeat
View File

@@ -5417,23 +5417,21 @@ Check slave lag once and exit (using optional DSN to specify slave host):
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-heartbeat merely reads and writes a single record in a table. It should be
very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-heartbeat>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

27
bin/pt-index-usage
View File

@@ -6811,7 +6811,7 @@ pt-index-usage - Read queries from a log and analyze how they use indexes.
=head1 SYNOPSIS
Usage: pt-index-usage [OPTION...] [FILE...]
Usage: pt-index-usage [OPTIONS] [FILES]
pt-index-usage reads queries from logs and analyzes how they use indexes.
@@ -6825,24 +6825,21 @@ Disable reports and save results to percona database for later analysis:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
This tool is read-only unless you use L<"--save-results-database">. It reads a
log of queries and EXPLAIN them. It also gathers information about all tables
in all databases. It should be very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-index-usage>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

30
bin/pt-ioprofile
View File

@@ -916,29 +916,21 @@ the result. If you specify a FILE, then step 1) is not performed.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-ioprofile is a read-only tool, so your data is not at risk. However, it works
by attaching C<strace> to the process using C<ptrace()>, which will make it run
very slowly until C<strace> detaches. In addition to freezing the server, there
is also some risk of the process crashing or performing badly after C<strace>
detaches from it, or indeed of C<strace> not detaching cleanly and leaving the
process in a sleeping state. As a result, this should be considered an
intrusive tool, and should not be used on production servers unless you are
comfortable with that.
=over
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-ioprofile>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

25
bin/pt-kill
View File

@@ -7144,24 +7144,21 @@ See which queries in the processlist right now would match:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-kill kills queries if you use the L<"--kill"> option, so it can disrupt
your database's users, of course. You should test with the <"--print"> option,
which is safe, if you're unsure what the tool will do.
=over
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-kill>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

23
bin/pt-mext
View File

@@ -161,22 +161,21 @@ Get output from a file:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-mext is a read-only tool. It should be very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-mext>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

22
bin/pt-mysql-summary
View File

@@ -2472,21 +2472,21 @@ well on any modern UNIX systems.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-mysql-summary is a read-only tool. It should be very low-risk.
=over
At the time of this release, we know of no bugs that could harm users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-mysql-summary>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

41
bin/pt-pmp
View File

@@ -250,30 +250,21 @@ a process is waiting for.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-pmp is a read-only tool. However, collecting GDB stacktraces is achieved by
attaching GDB to the program and printing stack traces from all threads. This
will freeze the program for some period of time, ranging from a second or so to
much longer on very busy systems with a lot of memory and many threads in the
program. In the tool's default usage as a MySQL profiling tool, this means that
MySQL will be unresponsive while the tool runs, although if you are using the
tool to diagnose an unresponsive server, there is really no reason not to do
this. In addition to freezing the server, there is also some risk of the server
crashing or performing badly after GDB detaches from it.
=over
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-pmp>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION
@@ -286,6 +277,16 @@ from each level of the stack, and combines them with commas. It does this
for each thread in the output. Afterwards, it sorts similar threads together
and counts how many of each one there are, then sorts them most-frequent first.
pt-pmp is a read-only tool. However, collecting GDB stacktraces is achieved by
attaching GDB to the program and printing stack traces from all threads. This
will freeze the program for some period of time, ranging from a second or so to
much longer on very busy systems with a lot of memory and many threads in the
program. In the tool's default usage as a MySQL profiling tool, this means that
MySQL will be unresponsive while the tool runs, although if you are using the
tool to diagnose an unresponsive server, there is really no reason not to do
this. In addition to freezing the server, there is also some risk of the server
crashing or performing badly after GDB detaches from it.
=head1 OPTIONS
Options must precede files on the command line.

26
bin/pt-query-advisor
View File

@@ -8817,7 +8817,7 @@ pt-query-advisor - Analyze queries and advise on possible problems.
=head1 SYNOPSIS
Usage: pt-query-advisor [OPTION...] [FILE]
Usage: pt-query-advisor [OPTIONS] [FILE]
pt-query-advisor analyzes queries and advises on possible problems. It can read
queries from several types of log files, or you can use the --query or --review
@@ -8829,21 +8829,21 @@ To analyze all queries in a MySQL slow query log file:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-query-advisor simply reads queries and examines them, and is thus
very low risk. At the time of this release we know of no issues that could harm
users.
=over
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-query-advisor>.
=item * Read the tool's documentation
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Review the tool's known L<"BUGS">
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

28
bin/pt-query-digest
View File

@@ -14210,29 +14210,21 @@ you don't need the default report:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
By default pt-query-digest merely collects and aggregates data from the files
specified. It is designed to be as efficient as possible, but depending on the
input you give it, it can use a lot of CPU and memory. Practically speaking, it
is safe to run even on production systems, but you might want to monitor it
until you are satisfied that the input you give it does not cause undue load.
=over
Various options will cause pt-query-digest to insert data into tables, execute
SQL queries, and so on. These include the L<"--review"> option.
=item * Read the tool's documentation
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Review the tool's known L<"BUGS">
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-query-digest>.
=item * Test the tool on a non-production server
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

24
bin/pt-show-grants
View File

@@ -2028,23 +2028,21 @@ Examples:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-show-grants is read-only by default, and very low-risk. If you specify
L<"--flush">, it will execute C<FLUSH PRIVILEGES>.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-show-grants>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

23
bin/pt-sift
View File

@@ -615,22 +615,21 @@ is given, the tool browses all pt-stalk files in it.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-sift is a read-only tool. It should be very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-sift>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

41
bin/pt-slave-delay
View File

@@ -4225,7 +4225,7 @@ sub main {
if ( $master_dbh ) {
PTDEBUG && _d('Getting binlog pos from master');
my $res = $master_dbh->selectrow_hashref("SHOW MASTER STATUS");
die "Binary logging is disabled on the MASTER-HOST"
die "Binary logging is disabled on the MASTER_DSN"
unless $res && %$res && $res->{file};
my $pos = $positions[-1];
if ( !@positions || $pos->[$FILE] ne $res->{file}
@@ -4396,11 +4396,11 @@ pt-slave-delay - Make a MySQL slave server lag behind its master.
=head1 SYNOPSIS
Usage: pt-slave-delay [OPTION...] SLAVE-HOST [MASTER-HOST]
Usage: pt-slave-delay [OPTIONS] SLAVE_DSN [MASTER_DSN]
pt-slave-delay starts and stops a slave server as needed to make it lag
behind the master. The SLAVE-HOST and MASTER-HOST use DSN syntax, and
values are copied from the SLAVE-HOST to the MASTER-HOST if omitted.
behind the master. The SLAVE_DSN and MASTER_DSN use DSN syntax, and
values are copied from the SLAVE_DSN to the MASTER_DSN if omitted.
To hold slavehost one minute behind its master for ten minutes:
@@ -4408,24 +4408,21 @@ To hold slavehost one minute behind its master for ten minutes:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-slave-delay is generally very low-risk. It simply starts and stops the
replication SQL thread. This might cause monitoring systems to think the slave
is having trouble.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-slave-delay>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION
@@ -4449,8 +4446,8 @@ daemonized. In this case, it exits. Therefore, if you think your slave might
encounter this condition, you should be sure to either specify
L<"--use-master"> explicitly when daemonizing, or don't specify L<"--ask-pass">.
The SLAVE-HOST and optional MASTER-HOST are both DSNs. See L<"DSN OPTIONS">.
Missing MASTER-HOST values are filled in with values from SLAVE-HOST, so you
The SLAVE_DSN and optional MASTER_DSN are both DSNs. See L<"DSN OPTIONS">.
Missing MASTER_DSN values are filled in with values from SLAVE_DSN, so you
don't need to specify them in both places. C<pt-slave-delay> reads all normal
MySQL option files, such as ~/.my.cnf, so you may not need to specify username,
password and other common options at all.
@@ -4617,14 +4614,14 @@ Socket file to use for connection.
Get binlog positions from master, not slave. Don't trust the binlog positions
in the slave's relay log. Connect to the master and get binlog positions
instead. If you specify this option without giving a MASTER-HOST on the command
instead. If you specify this option without giving a MASTER_DSN on the command
line, C<pt-slave-delay> examines the slave's SHOW SLAVE STATUS to determine the
hostname and port for connecting to the master.
C<pt-slave-delay> uses only the MASTER_HOST and MASTER_PORT values from SHOW
SLAVE STATUS for the master connection. It does not use the MASTER_USER
value. If you want to specify a different username for the master than the
one you use to connect to the slave, you should specify the MASTER-HOST option
one you use to connect to the slave, you should specify the MASTER_DSN option
explicitly on the command line.
=item --user

25
bin/pt-slave-find
View File

@@ -3925,7 +3925,7 @@ pt-slave-find - Find and print replication hierarchy tree of MySQL slaves.
=head1 SYNOPSIS
Usage: pt-slave-find [OPTION...] MASTER-HOST
Usage: pt-slave-find [OPTIONS] [DSN]
pt-slave-find finds and prints a hierarchy tree of MySQL slaves.
@@ -3935,22 +3935,21 @@ Examples:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-slave-find is read-only and very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-slave-find>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

25
bin/pt-slave-restart
View File

@@ -5175,22 +5175,21 @@ errors, and tries to restart replication if it stops.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-slave-restart is a brute-force way to try to keep a slave server running when
it is having problems with replication. Don't be too hasty to use it unless you
need to. If you use this tool carelessly, you might miss the chance to really
solve the slave server's problems.
=over
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-slave-restart>.
=item * Read the tool's documentation
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Review the tool's known L<"BUGS">
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

26
bin/pt-stalk
View File

@@ -1449,25 +1449,21 @@ collect data on demand without waiting for the trigger to occur.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-stalk is a read-write tool; it collects data from the system and writes it
into a series of files. It should be very low-risk. Some of the options
can cause intrusive data collection to be performed, however, so if you enable
any non-default options, you should read their documentation carefully.
=over
At the time of this release, we know of no bugs that could cause serious harm
to users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-stalk>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

22
bin/pt-summary
View File

@@ -2333,21 +2333,21 @@ Download and run:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-summary is a read-only tool. It should be very low-risk.
=over
At the time of this release, we know of no bugs that could harm users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-summary>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

76
bin/pt-table-checksum
View File

@@ -10888,28 +10888,23 @@ different, you can resolve the problem with pt-table-sync.
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-table-checksum can add load to the MySQL server, although it has many
safeguards to prevent this. It inserts a small amount of data into a table that
contains checksum results. It has checks that, if disabled, can potentially
cause replication to fail when unsafe replication options are used. In short,
it is safe by default, but it permits you to turn off its safety checks.
=over
The tool presumes that schemas and tables are identical on the master and
all replicas. Replication will break if, for example, a replica does not
have a schema that exists on the master (and that schema is checksummed),
or if the structure of a table on a replica is different than on the master.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-table-checksum>.
=item * Review the tool's known L<"BUGS">
See also L<"LIMITATIONS"> and L<"BUGS">.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
See also L<"LIMITATIONS">.
=head1 DESCRIPTION
@@ -11047,6 +11042,32 @@ can try something like the following:
SET boundaries = COALESCE(CONCAT('id BETWEEN ', lower_boundary,
' AND ', upper_boundary), '1=1');
=head1 LIMITATIONS
=over
=item Replicas using row-based replication
pt-table-checksum requires statement-based replication, and it sets
C<binlog_format=STATEMENT> on the master, but due to a MySQL limitation
replicas do not honor this change. Therefore, checksums will not replicate
past any replicas using row-based replication that are masters for
further replicas.
The tool automatically checks the C<binlog_format> on all servers.
See L<"--[no]check-binlog-format"> .
(L<Bug 899415|https://bugs.launchpad.net/percona-toolkit/+bug/899415>)
=item Schema and table differences
The tool presumes that schemas and tables are identical on the master and
all replicas. Replication will break if, for example, a replica does not
have a schema that exists on the master (and that schema is checksummed),
or if the structure of a table on a replica is different than on the master.
=back
=head1 Percona XtraDB Cluster
pt-table-checksum works with Percona XtraDB Cluster (PXC) 5.5.28-23.7 and newer.
@@ -12089,25 +12110,6 @@ of output.
You need Perl, DBI, DBD::mysql, and some core packages that ought to be
installed in any reasonably new version of Perl.
=head1 LIMITATIONS
=over
=item Replicas using row-based replication
pt-table-checksum requires statement-based replication, and it sets
C<binlog_format=STATEMENT> on the master, but due to a MySQL limitation
replicas do not honor this change. Therefore, checksums will not replicate
past any replicas using row-based replication that are masters for
further replicas.
The tool automatically checks the C<binlog_format> on all servers.
See L<"--[no]check-binlog-format"> .
(L<Bug 899415|https://bugs.launchpad.net/percona-toolkit/+bug/899415>)
=back
=head1 BUGS
For a list of known bugs, see L<http://www.percona.com/bugs/pt-table-checksum>.

69
bin/pt-table-sync
View File

@@ -11288,19 +11288,19 @@ pt-table-sync - Synchronize MySQL table data efficiently.
=head1 SYNOPSIS
Usage: pt-table-sync [OPTION...] DSN [DSN...]
Usage: pt-table-sync [OPTIONS] DSN [DSN]
pt-table-sync synchronizes data efficiently between MySQL tables.
This tool changes data, so for maximum safety, you should back up your data
before you use it. When synchronizing a server that is a replication slave with
the --replicate or --sync-to-master methods, it B<always> makes the changes on
the replication master, B<never> the replication slave directly. This is in
general the only safe way to bring a replica back in sync with its master;
changes to the replica are usually the source of the problems in the first
place. However, the changes it makes on the master should be no-op changes that
set the data to their current values, and actually affect only the replica.
Please read the detailed documentation that follows to learn more about this.
before using it. When synchronizing a server that is a replication slave
with the L<"--replicate"> or L<"--sync-to-master"> methods, it B<always>
makes the changes on the replication master, B<never> the replication slave
directly. This is in general the only safe way to bring a replica back in
sync with its master; changes to the replica are usually the source of the
problems in the first place. However, the changes it makes on the master
should be no-op changes that set the data to their current values, and
actually affect only the replica.
Sync db.tbl on host1 to host2:
@@ -11337,41 +11337,23 @@ through replication and change master1's data:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
C<WARNING>: pt-table-sync changes data! Before using this tool, please:
With great power comes great responsibility! This tool changes data, so it is a
good idea to back up your data. It is also very powerful, which means it is
very complex, so you should run it with the L<"--dry-run"> option to see what it
will do, until you're familiar with its operation. If you want to see which
rows are different, without changing any data, use L<"--print"> instead of
L<"--execute">.
=over
Be careful when using pt-table-sync in any master-master setup. Master-master
replication is inherently tricky, and it's easy to make mistakes. You need to
be sure you're using the tool correctly for master-master replication. See the
L<"SYNOPSIS"> for the overview of the correct usage.
=item * Read the tool's documentation
Also be careful with tables that have foreign key constraints with C<ON DELETE>
or C<ON UPDATE> definitions because these might cause unintended changes on the
child tables.
=item * Review the tool's known L<"BUGS">
In general, this tool is best suited when your tables have a primary key or
unique index. Although it can synchronize data in tables lacking a primary key
or unique index, it might be best to synchronize that data by another means.
=item * Test the tool on a non-production server
At the time of this release, due to bugs in earlier versions of MySQL,
L<"--lock-and-rename"> is disabled in versions earlier than 5.5. Consider
using pt-online-schema-change instead.
=item * Backup your production server and verify the backups
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-table-sync>.
pt-table-sync is mature, proven in the real world, and well tested,
but if used improperly it can have adverse consequences. Always test
syncing first with L<"--dry-run"> and L<"--print">.
See also L<"BUGS"> for more information on filing bugs and getting help.
=back
=head1 DESCRIPTION
@@ -11499,6 +11481,19 @@ The tool rewrites queries to C<DELETE> and C<REPLACE> in this case. This is
automatically handled after the first index violation, so you don't have to
worry about it.
Be careful when using pt-table-sync in any master-master setup. Master-master
replication is inherently tricky, and it's easy to make mistakes. You need to
be sure you're using the tool correctly for master-master replication. See the
L<"SYNOPSIS"> for the overview of the correct usage.
Also be careful with tables that have foreign key constraints with C<ON DELETE>
or C<ON UPDATE> definitions because these might cause unintended changes on the
child tables.
In general, this tool is best suited when your tables have a primary key or
unique index. Although it can synchronize data in tables lacking a primary key
or unique index, it might be best to synchronize that data by another means.
=head1 REPLICATION SAFETY
Synchronizing a replication master and slave safely is a non-trivial problem, in

21
bin/pt-table-usage
View File

@@ -6975,18 +6975,21 @@ FILE is specified, it reads STDIN. It prints a report for each query.
=head1 RISKS
pt-table-use is very low risk. By default, it simply reads queries from a log.
It executes C<EXPLAIN EXTENDED> if you specify the L<"--explain-extended">
option.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
At the time of this release, we know of no bugs that could harm users.
=over
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-table-usage>.
=item * Read the tool's documentation
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Review the tool's known L<"BUGS">
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

25
bin/pt-upgrade
View File

@@ -13192,24 +13192,21 @@ Compare a single query, no slowlog needed:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-upgrade is a read-only tool that is meant to be used on non-production
servers. It executes the SQL that you give it as input, which could cause
undesired load on a production server.
=over
At the time of this release, there is a bug that causes the tool to crash,
and a bug that causes a deadlock.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-upgrade>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

26
bin/pt-variable-advisor
View File

@@ -5216,7 +5216,7 @@ pt-variable-advisor - Analyze MySQL variables and advise on possible problems.
=head1 SYNOPSIS
Usage: pt-variable-advisor [OPTION...] [DSN]
Usage: pt-variable-advisor [OPTIONS] [DSN]
pt-variable-advisor analyzes variables and advises on possible problems.
@@ -5230,23 +5230,21 @@ Get SHOW VARIABLES output saved in vars.txt:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-variable-advisor reads MySQL's configuration and examines it and is thus
very low risk.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-variable-advisor>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION

25
bin/pt-visual-explain
View File

@@ -2483,7 +2483,7 @@ pt-visual-explain - Format EXPLAIN output as a tree.
=head1 SYNOPSIS
Usage: pt-visual-explain [OPTION...] [FILE...]
Usage: pt-visual-explain [OPTIONS] [FILES]
pt-visual-explain transforms EXPLAIN output into a tree representation of
the query plan. If FILE is given, input is read from the file(s). With no
@@ -2499,22 +2499,21 @@ Examples:
=head1 RISKS
The following section is included to inform users about the potential risks,
whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs.
Percona Toolkit is mature, proven in the real world, and well tested,
but all database tools can pose a risk to the system and the database
server. Before using this tool, please:
pt-visual-explain is read-only and very low-risk.
=over
At the time of this release, we know of no bugs that could cause serious harm to
users.
=item * Read the tool's documentation
The authoritative source for updated information is always the online issue
tracking system. Issues that affect this tool will be marked as such. You can
see a list of such issues at the following URL:
L<http://www.percona.com/bugs/pt-visual-explain>.
=item * Review the tool's known L<"BUGS">
See also L<"BUGS"> for more information on filing bugs and getting help.
=item * Test the tool on a non-production server
=item * Backup your production server and verify the backups
=back
=head1 DESCRIPTION