percona/percona-toolkit
1
0
Fork 0
mirror of https://github.com/percona/percona-toolkit.git synced 2025-12-25 02:01:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove "internal" bugs from Changelog. Make build-packages write simple version and update sphinx-build/conf.py. Make write-user-docs remove double blank lines. Remove pt-checksum-filter and other removed tools from user docs.

Browse Source
This commit is contained in:
Daniel Nichter
2011-08-31 09:44:31 -06:00
parent 52ef2062e6
commit 8c6f6a7f17
14 changed files with 47 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/percona-toolkit.pod
View File

@@ -30,10 +30,6 @@ This release of Percona Toolkit includes the following tools:
Archive rows from a MySQL table into another table or a file.
=item pt-checksum-filter
Filter checksums from pt-table-checksum.
=item pt-collect
Collect information from a server for some period of time.
@@ -98,10 +94,6 @@ Perform online, non-blocking table schema changes.
Aggregate GDB stack traces for a selected program.
=item pt-profile-compact
Compact the output from pt-query-profiler.
=item pt-query-advisor
Analyze queries and advise on possible problems.
@@ -110,10 +102,6 @@ Analyze queries and advise on possible problems.
Analyze query execution logs and generate a query report, filter, replay, or transform queries for MySQL, PostgreSQL, memcached, and more.
=item pt-query-profiler
Execute SQL statements and print statistics, or measure activity caused by other processes.
=item pt-show-grants
Canonicalize and print MySQL grants so you can effectively replicate, compare and version-control them.

3
docs/user/authors.rst
View File

@@ -1,11 +1,8 @@
.. highlight:: perl
*******
AUTHORS
*******
Percona Toolkit is primarily developed by Baron Schwartz and Daniel Nichter,
both of whom are employed by Percona Inc. See each program's documenation
for details.

14
docs/user/bugs.rst
View File

@@ -1,35 +1,21 @@
.. highlight:: perl
****
BUGS
****
Please report bugs at `https://bugs.launchpad.net/percona-toolkit <https://bugs.launchpad.net/percona-toolkit>`_.
Include the following information in your bug report:
\* Complete command-line used to run the tool
\* Tool \ ``--version``\
\* MySQL version of all servers involved
\* Output from the tool including STDERR
\* Input files (log/dump/config files, etc.)
If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ;
see "ENVIRONMENT".

23
docs/user/configuration_files.rst
View File

@@ -1,11 +1,8 @@
.. highlight:: perl
*******************
CONFIGURATION FILES
*******************
Percona Toolkit tools can read options from configuration files. The
configuration file syntax is simple and direct, and bears some resemblances
to the MySQL command-line client tools. The configuration files all follow
@@ -18,29 +15,24 @@ think of the configuration files as a way to write your command lines.
SYNTAX
======
The syntax of the configuration files is as follows:
\*
Whitespace followed by a hash (#) sign signifies that the rest of the line is a
comment. This is deleted.
\*
Whitespace is stripped from the beginning and end of all lines.
\*
Empty lines are ignored.
\*
Each line is permitted to be in either of the following formats:
@@ -55,13 +47,11 @@ The syntax of the configuration files is as follows:
Whitespace around the equals sign is deleted during processing.
\*
Only long options are recognized.
\*
A line containing only two hyphens signals the end of option parsing. Any
@@ -69,15 +59,11 @@ The syntax of the configuration files is as follows:
program.
READ ORDER
==========
The tools read several configuration files in order:
1.
The global Percona Toolkit configuration file,
@@ -85,7 +71,6 @@ The tools read several configuration files in order:
so you should only add options to it that you want to apply to all tools.
2.
The global tool-specific configuration file, \ */etc/percona-toolkit/TOOL.conf*\ ,
@@ -94,7 +79,6 @@ The tools read several configuration files in order:
only to that tool.
3.
The user's own Percona Toolkit configuration file,
@@ -102,7 +86,6 @@ The tools read several configuration files in order:
add options to it that you want to apply to all tools.
4.
The user's tool-specific configuration file, \ *$HOME/.TOOL.conf*\ ,
@@ -111,12 +94,9 @@ The tools read several configuration files in order:
only to that tool.
SPECIFYING
==========
There is a special \ ``--config``\ option, which lets you specify which
configuration files Percona Toolkit should read. You specify a
comma-separated list of files. However, its behavior is not like other
@@ -126,13 +106,10 @@ cause an error. Also, you cannot specify \ ``--config=/path/to/file``\ ;
you must specify the option and the path to the file separated by whitespace
\ *without an equal sign*\ between them, like:
.. code-block:: perl
--config /path/to/file
If you don't want any configuration files at all, specify \ ``--config ''``\ to
provide an empty list of files.

3
docs/user/copyright_license_and_warranty.rst
View File

@@ -1,11 +1,8 @@
.. highlight:: perl
********************************
COPYRIGHT, LICENSE, AND WARRANTY
********************************
Percona Toolkit is copyright 2011 Percona Inc. and others.
See each program's documentation for complete copyright notices.

5
docs/user/environment.rst
View File

@@ -1,20 +1,15 @@
.. highlight:: perl
***********
ENVIRONMENT
***********
The environment variable \ ``PTDEBUG``\ enables verbose debugging output to STDERR.
To enable debugging and capture all output to a file, run the tool like:
.. code-block:: perl
PTDEBUG=1 pt-table-checksum ... > FILE 2>&1
Be careful: debugging output is voluminous and can generate several megabytes
of output.

9
docs/user/index.rst
View File

@@ -1,10 +1,7 @@
.. highlight:: perl
***********
DESCRIPTION
***********
*****************************
Percona Toolkit Documentation
*****************************
Percona Toolkit is a collection of advanced command-line tools used by
Percona (`http://www.percona.com/ <http://www.percona.com/>`_) support staff to perform a variety of

15
docs/user/system_requirements.rst
View File

@@ -1,37 +1,22 @@
.. highlight:: perl
*******************
SYSTEM REQUIREMENTS
*******************
Most tools require:
\* Perl v5.8 or newer
\* Bash v3 or newer
\* Core Perl modules like Time::HiRes
Tools that connect to MySQL require:
\* Perl modules DBI and DBD::mysql
\* MySQL 5.0 or newer
Percona Toolkit is only tested on UNIX systems, primarily Debian and
Red Hat derivatives; other operating systems are not supported.

37
docs/user/tools.rst
View File

@@ -1,212 +1,175 @@
.. highlight:: perl
*****
TOOLS
*****
This release of Percona Toolkit includes the following tools:
:doc:`pt-archiver`
Archive rows from a MySQL table into another table or a file.
:doc:`pt-collect`
Collect information from a server for some period of time.
:doc:`pt-config-diff`
Diff MySQL configuration files and server variables.
:doc:`pt-deadlock-logger`
Extract and log MySQL deadlock information.
:doc:`pt-diskstats`
Aggregate and summarize \ */proc/diskstats*\ .
:doc:`pt-duplicate-key-checker`
Find duplicate indexes and foreign keys on MySQL tables.
:doc:`pt-fifo-split`
Split files and pipe lines to a fifo without really splitting.
:doc:`pt-find`
Find MySQL tables and execute actions, like GNU find.
:doc:`pt-fk-error-logger`
Extract and log MySQL foreign key errors.
:doc:`pt-heartbeat`
Monitor MySQL replication delay.
:doc:`pt-index-usage`
Read queries from a log and analyze how they use indexes.
:doc:`pt-kill`
Kill MySQL queries that match certain criteria.
:doc:`pt-log-player`
Replay MySQL query logs.
:doc:`pt-mext`
Look at many samples of MySQL \ ``SHOW GLOBAL STATUS``\ side-by-side.
:doc:`pt-mysql-summary`
Summarize MySQL information in a nice way.
:doc:`pt-online-schema-change`
Perform online, non-blocking table schema changes.
:doc:`pt-pmp`
Aggregate GDB stack traces for a selected program.
:doc:`pt-query-advisor`
Analyze queries and advise on possible problems.
:doc:`pt-query-digest`
Analyze query execution logs and generate a query report, filter, replay, or transform queries for MySQL, PostgreSQL, memcached, and more.
:doc:`pt-show-grants`
Canonicalize and print MySQL grants so you can effectively replicate, compare and version-control them.
:doc:`pt-sift`
Browses files created by pt-collect.
:doc:`pt-slave-delay`
Make a MySQL slave server lag behind its master.
:doc:`pt-slave-find`
Find and print replication hierarchy tree of MySQL slaves.
:doc:`pt-slave-restart`
Watch and restart MySQL replication after errors.
:doc:`pt-stalk`
Wait for a condition to occur then begin collecting data.
:doc:`pt-summary`
Summarize system information in a nice way.
:doc:`pt-table-checksum`
Perform an online replication consistency check, or checksum MySQL tables efficiently on one or many servers.
:doc:`pt-table-sync`
Synchronize MySQL table data efficiently.
:doc:`pt-tcp-model`
Transform tcpdump into metrics that permit performance and scalability modeling.
:doc:`pt-trend`
Compute statistics over a set of time-series data points.
:doc:`pt-upgrade`
Execute queries on multiple servers and check for differences.
:doc:`pt-variable-advisor`
Analyze MySQL variables and advise on possible problems.
:doc:`pt-visual-explain`
Format EXPLAIN output as a tree.
For more free, open-source software developed Percona, visit
`http://www.percona.com/software/ <http://www.percona.com/software/>`_.

3
docs/user/version.rst
View File

@@ -1,10 +1,7 @@
.. highlight:: perl
*******
VERSION
*******
Percona Toolkit v0.9.5 released 2011-08-04