diff --git a/docs/user/pt-align.rst b/docs/user/pt-align.rst index d604a7af..84ae356e 100644 --- a/docs/user/pt-align.rst +++ b/docs/user/pt-align.rst @@ -19,7 +19,10 @@ SYNOPSIS ******** -Usage: pt-align [OPTION...] +Usage: pt-align [FILES] + +pt-align reads lines in files and splits them into words. This is useful for +things like aligning the output of vmstat or iostat so it is easier to read. *********** @@ -27,42 +30,27 @@ DESCRIPTION *********** -This program reads in lines and splits them into words. It counts how many -words each line has, and if there is one number that predominates, it assumes -this is the number of words in each line. Then it discards all lines that -don't have that many words, and looks at the 2nd line that DOES. It assumes -this is the first non-header line. Based on whether each word looks numeric -or not, it decides on column alignment. Finally, it goes through and decides -how wide each column should be, and then prints them out. +pt-align counts how many words each line has, and if there is one number that +predominates, it assumes this is the number of words in each line. Then it +discards all lines that don't have that many words, and looks at the 2nd line +that does. It assumes this is the first non-header line. Based on whether +each word looks numeric or not, it decides on column alignment. Finally, it +goes through and decides how wide each column should be, and then prints them +out. -This is useful for things like aligning the output of vmstat or iostat so it -is easier to read. +The tool's behavior has some important consequences. Reading the entire input +before formatting means that you can't use it for aligning data as it is +generated incrementally, and you probably don't want to use this tool on very +large files. Discarding lines with the wrong number of words means that some +lines won't be printed. -*********** -DOWNLOADING -*********** +******* +OPTIONS +******* -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG - - -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL - - -Replace \ ``TOOL``\ with the name of any tool. +This tool does not have any command-line options. *********** @@ -70,17 +58,7 @@ 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-align ... > FILE 2>&1 - - -Be careful: debugging output is voluminous and can generate several megabytes -of output. +This tool does not use any environment variables. ******************* @@ -88,8 +66,7 @@ SYSTEM REQUIREMENTS ******************* -You need Perl, DBI, DBD::mysql, and some core packages that ought to be -installed in any reasonably new version of Perl. +This tool requires Perl v5.8 or newer built with core modules. **** @@ -127,6 +104,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-archiver.rst b/docs/user/pt-archiver.rst index ce680e84..e7b79db8 100644 --- a/docs/user/pt-archiver.rst +++ b/docs/user/pt-archiver.rst @@ -1408,22 +1408,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-checksum-filter.rst b/docs/user/pt-checksum-filter.rst index cd6941c8..bc6c411f 100644 --- a/docs/user/pt-checksum-filter.rst +++ b/docs/user/pt-checksum-filter.rst @@ -178,22 +178,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-collect.rst b/docs/user/pt-collect.rst index a5459599..6e4ce4a2 100644 --- a/docs/user/pt-collect.rst +++ b/docs/user/pt-collect.rst @@ -19,7 +19,12 @@ SYNOPSIS ******** -Usage: pt-collect [OPTION...] +Usage: pt-collect -d -g -i -o -s [OPTIONS] [-- MYSQL-OPTIONS] + +pt-collect tool gathers a variety of information about a system for a period +of time. It is typically executed when the stalk tool detects a condition +and wants to collect information to assist in diagnosis. Four options +must be specified on the command line: -dgios. *********** @@ -27,34 +32,75 @@ DESCRIPTION *********** -pt-collect focuses on gathering diagnostic data during a MySQL performance -problem. It is typically executed by \ ``stalk``\ . +pt-collect creates a lock to ensure that only one instance runs at a time, +and then saves a variety of performance and status data into files in the +configured directory. Files are named with a timestamp so they can be +grouped together. The tool is MySQL-centric by default, and gathers quite +a bit of diagnostic data that's useful for understanding the behavior of +a MySQL database server. + +Options after \ ``--``\ are passed to \ ``mysql``\ and \ ``mysqladmin``\ . -*********** -DOWNLOADING -*********** +******* +OPTIONS +******* -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: + +-d (required) + + DESTINATION Where to store the resulting data; must already exist. + -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG +-g (required) + + Collect GDB stack traces. + -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +-i INTERVAL (required) + + How many seconds to collect data. + -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL +-o (required) + + Collect oprofile data; disables -s. + -Replace \ ``TOOL``\ with the name of any tool. +-s (required) + + Collect strace data. + + + +-f PERCENT + + Exit if the disk is more than this percent full. + + + +-m MEGABYTES + + Exit unless there are this many megabytes free disk space. + + + +-p PREFIX + + Store the data into files with this prefix (optional). + + + +-t + + Collect tcpdump data. + + *********** @@ -62,17 +108,7 @@ 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-collect ... > FILE 2>&1 - - -Be careful: debugging output is voluminous and can generate several megabytes -of output. +This tool does not use any environment variables. ******************* @@ -80,7 +116,11 @@ SYSTEM REQUIREMENTS ******************* -You need Bash. +This tool requires Bash v3 or newer and assumes that these programs +are installed, in the PATH, and executable: sysctl, top, vmstat, iostat, +mpstat, lsof, mysql, mysqladmin, df, netstat, pidof, flock, and others +depending on what command-line options are specified. If some of those +programs are not available, the tool will still run but may print warnings. **** @@ -118,6 +158,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-config-diff.rst b/docs/user/pt-config-diff.rst index 4bd1e1b6..9f0bec1e 100644 --- a/docs/user/pt-config-diff.rst +++ b/docs/user/pt-config-diff.rst @@ -378,22 +378,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-deadlock-logger.rst b/docs/user/pt-deadlock-logger.rst index 6be6f650..c95e8b64 100644 --- a/docs/user/pt-deadlock-logger.rst +++ b/docs/user/pt-deadlock-logger.rst @@ -620,22 +620,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-diskstats.rst b/docs/user/pt-diskstats.rst index 45e63d01..35b65063 100644 --- a/docs/user/pt-diskstats.rst +++ b/docs/user/pt-diskstats.rst @@ -11,7 +11,7 @@ NAME **** -pt-diskstats - Read a file generated from /proc/diskstats and summarize it. +pt-diskstats - Aggregate and summarize \ */proc/diskstats*\ . ******** @@ -19,7 +19,10 @@ SYNOPSIS ******** -Usage: pt-diskstats [OPTION...] +Usage: pt-diskstats [OPTIONS] [FILES] + +pt-diskstats reads \ */proc/diskstats*\ periodically, or files with the +contents of \ */proc/diskstats*\ , aggregates the data, and prints it nicely. *********** @@ -27,7 +30,26 @@ DESCRIPTION *********** -The file read should look like this: +pt-diskstats tool is similar to iostat, but has some advantages. It separates +reads and writes, for example, and computes some things that iostat does in +either incorrect or confusing ways. It is also menu-driven and interactive +with several different ways to aggregate the data, and integrates well with +the pt-collect tool. These properties make it very convenient for quickly +drilling down into I/O performance at the desired level of granularity. + +This program works in two main modes. One way is to process a file with saved +disk statistics, which you specify on the command line. The other way is to +start a background process gathering samples at intervals and saving them into +a file, and process this file in the foreground. In both cases, the tool is +interactively controlled by keystrokes, so you can redisplay and slice the +data flexibly and easily. If the tool is not attached to a terminal, it +doesn't run interactively; it just processes and prints its output, then exits. +Otherwise it loops until you exit with the 'q' key. + +If you press the '?' key, you will bring up the interactive help menu that +shows which keys control the program. + +Files should have this format: .. code-block:: perl @@ -39,31 +61,175 @@ The file read should look like this: TS <-- must end with a TS line. - -*********** -DOWNLOADING -*********** +See `http://aspersa.googlecode.com/svn/html/diskstats.html `_ for a detailed +example of using the tool. -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +****** +OUTPUT +****** -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG +The columns are as follows: -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +#ts + + The number of seconds of samples in the line. If there is only one, then + the timestamp itself is shown, without the {curly braces}. + -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL +device + + The device name. If there is more than one device, then instead the number + of devices aggregated into the line is shown, in {curly braces}. + -Replace \ ``TOOL``\ with the name of any tool. +rd_mb_s + + The number of megabytes read per second, average, during the sampled interval. + + + +rd_cnc + + The average concurrency of the read operations, as computed by Little's Law + (a.k.a. queueing theory). + + + +rd_rt + + The average response time of the read operations, in milliseconds. + + + +wr_mb_s + + Megabytes written per second, average. + + + +wr_cnc + + Write concurrency, similar to read concurrency. + + + +wr_rt + + Write response time, similar to read response time. + + + +busy + + The fraction of time that the device had at least one request in progress; + this is what iostat calls %util (which is a misleading name). + + + +in_prg + + The number of requests that were in progress. Unlike the read and write + concurrencies, which are averages that are generated from reliable numbers, + this number is an instantaneous sample, and you can see that it might + represent a spike of requests, rather than the true long-term average. + + + +In addition to the above columns, there are a few columns that are hidden by +default. If you press the 'c' key, and then press Enter, you will blank out +the regular expression pattern that selects columns to display, and you will +then see the extra columns: + + +rd_s + + The number of reads per second. + + + +rd_avkb + + The average size of the reads, in kilobytes. + + + +rd_mrg + + The percentage of read requests that were merged together in the disk + scheduler before reaching the device. + + + +wr_s, wr_avgkb, and wr_mrg + + These are analogous to their rd_\* cousins. + + + + +******* +OPTIONS +******* + + +Options must precede files on the command line. + + +-c COLS + + Awk regex of which columns to include (default cnc|rt|mb|busy|prg). + + + +-d DEVICES + + Awk regex of which devices to include. + + + +-g GROUPBY + + Group-by mode (default disk); specify one of the following: + + + .. code-block:: perl + + disk - Each line of output shows one disk device. + sample - Each line of output shows one sample of statistics. + all - Each line of output shows one sample and one disk device. + + + + +-i INTERVAL + + In -g sample mode, include INTERVAL seconds per sample. + + + +-k KEEPFILE + + File to save diskstats samples in (default /tmp/diskstats-samples). + If a non-default filename is used, it will be saved for later analysis. + + + +-n SAMPLES + + When in interactive mode, stop after N samples. + + + +-s INTERVAL + + Sample /proc/diskstats every N seconds (default 1). + + *********** @@ -71,17 +237,7 @@ 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-diskstats ... > FILE 2>&1 - - -Be careful: debugging output is voluminous and can generate several megabytes -of output. +This tool does not use any environment variables. ******************* @@ -89,8 +245,8 @@ SYSTEM REQUIREMENTS ******************* -You need Perl, DBI, DBD::mysql, and some core packages that ought to be -installed in any reasonably new version of Perl. +This tool requires Bash v3 or newer and the \ */proc*\ filesystem unless +reading from files. **** @@ -128,6 +284,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-duplicate-key-checker.rst b/docs/user/pt-duplicate-key-checker.rst index 1e3fe2f5..3280a3ee 100644 --- a/docs/user/pt-duplicate-key-checker.rst +++ b/docs/user/pt-duplicate-key-checker.rst @@ -423,22 +423,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-fifo-split.rst b/docs/user/pt-fifo-split.rst index dc5360ad..3b69d30e 100644 --- a/docs/user/pt-fifo-split.rst +++ b/docs/user/pt-fifo-split.rst @@ -165,22 +165,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-find.rst b/docs/user/pt-find.rst index 6c8f18ca..52d5a43a 100644 --- a/docs/user/pt-find.rst +++ b/docs/user/pt-find.rst @@ -837,22 +837,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-fk-error-logger.rst b/docs/user/pt-fk-error-logger.rst index b6c0913c..0ae606c8 100644 --- a/docs/user/pt-fk-error-logger.rst +++ b/docs/user/pt-fk-error-logger.rst @@ -353,22 +353,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-heartbeat.rst b/docs/user/pt-heartbeat.rst index e9d281d1..f1627147 100644 --- a/docs/user/pt-heartbeat.rst +++ b/docs/user/pt-heartbeat.rst @@ -731,22 +731,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-index-usage.rst b/docs/user/pt-index-usage.rst index c7b5fbd5..43c65adc 100644 --- a/docs/user/pt-index-usage.rst +++ b/docs/user/pt-index-usage.rst @@ -700,22 +700,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-kill.rst b/docs/user/pt-kill.rst index b45fe5f4..44b965e4 100644 --- a/docs/user/pt-kill.rst +++ b/docs/user/pt-kill.rst @@ -334,14 +334,6 @@ This tool accepts additional command-line arguments. Refer to the ---[no]strip-comments - - default: yes - - Remove SQL comments from queries in the Info column of the PROCESSLIST. - - - --run-time type: time @@ -392,6 +384,14 @@ This tool accepts additional command-line arguments. Refer to the +--[no]strip-comments + + default: yes + + Remove SQL comments from queries in the Info column of the PROCESSLIST. + + + --user short form: -u; type: string @@ -478,25 +478,6 @@ a regex pattern like \ ``(?i-xsm:select)``\ . See also "GROUP, MATCH AND KILL". ---match-all - - group: Query Matches - - Match all queries that are not ignored. If no ignore options are specified, - then every query matches (except replication threads, unless - "--replication-threads" is also specified). This option allows you to - specify negative matches, i.e. "match every query \ *except*\ ..." where the - exceptions are defined by specifying various \ ``--ignore``\ options. - - This option is \ *not*\ the same as "--victims" \ ``all``\ . This option matches - all queries within a class, whereas "--victims" \ ``all``\ specifies that all - matching queries in a class (however they matched) will be killed. Normally, - however, the two are used together because if, for example, you specify - "--victims" \ ``oldest``\ , then although all queries may match, only the oldest - will be killed. - - - --busy-time type: time; group: Query Matches @@ -586,6 +567,25 @@ See also "GROUP, MATCH AND KILL". +--match-all + + group: Query Matches + + Match all queries that are not ignored. If no ignore options are specified, + then every query matches (except replication threads, unless + "--replication-threads" is also specified). This option allows you to + specify negative matches, i.e. "match every query \ *except*\ ..." where the + exceptions are defined by specifying various \ ``--ignore``\ options. + + This option is \ *not*\ the same as "--victims" \ ``all``\ . This option matches + all queries within a class, whereas "--victims" \ ``all``\ specifies that all + matching queries in a class (however they matched) will be killed. Normally, + however, the two are used together because if, for example, you specify + "--victims" \ ``oldest``\ , then although all queries may match, only the oldest + will be killed. + + + --match-command type: string; group: Query Matches @@ -913,22 +913,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-log-player.rst b/docs/user/pt-log-player.rst index e78841ae..5b835411 100644 --- a/docs/user/pt-log-player.rst +++ b/docs/user/pt-log-player.rst @@ -669,22 +669,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-mext.rst b/docs/user/pt-mext.rst index 41ccc6ae..cabd9ee7 100644 --- a/docs/user/pt-mext.rst +++ b/docs/user/pt-mext.rst @@ -11,7 +11,7 @@ NAME **** -pt-mext - Aggregate and summarize mysqladmin extended output. +pt-mext - Look at many samples of MySQL \ ``SHOW GLOBAL STATUS``\ side-by-side. ******** @@ -19,7 +19,25 @@ SYNOPSIS ******** -Usage: pt-mext [OPTION...] +Usage: pt-mext [OPTIONS] -- COMMAND + +pt-mext columnizes repeated output from a program like mysqladmin extended. + +Get output from \ ``mysqladmin``\ : + + +.. code-block:: perl + + mext -r -- mysqladmin ext -i10 -c3" + + +Get output from a file: + + +.. code-block:: perl + + mext -r -- cat mysqladmin-output.txt + *********** @@ -27,33 +45,26 @@ DESCRIPTION *********** -pt-mext aggregates and summarizes mysqladmin extended output. +pt-mext executes the \ ``COMMAND``\ you specify, and reads through the result one +line at a time. It places each line into a temporary file. When it finds a +blank line, it assumes that a new sample of SHOW GLOBAL STATUS is starting, +and it creates a new temporary file. At the end of this process, it has a +number of temporary files. It joins the temporary files together side-by-side +and prints the result. If the "-r" option is given, it first subtracts +each sample from the one after it before printing results. -*********** -DOWNLOADING -*********** +******* +OPTIONS +******* -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +-r + + Relative: subtract each column from the previous column. + -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG - - -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL - - -Replace \ ``TOOL``\ with the name of any tool. *********** @@ -61,17 +72,7 @@ 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-mext ... > FILE 2>&1 - - -Be careful: debugging output is voluminous and can generate several megabytes -of output. +This tool does not use any environment variables. ******************* @@ -79,7 +80,7 @@ SYSTEM REQUIREMENTS ******************* -You need Bash. +This tool requires the Bourne shell (\ */bin/sh*\ ). **** @@ -117,6 +118,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-mysql-summary.rst b/docs/user/pt-mysql-summary.rst index a79c98e2..a8b32bf0 100644 --- a/docs/user/pt-mysql-summary.rst +++ b/docs/user/pt-mysql-summary.rst @@ -19,7 +19,13 @@ SYNOPSIS ******** -Usage: pt-mysql-summary [OPTION...] +Usage: pt-mysql-summary [MYSQL-OPTIONS] + +pt-mysql-summary conveniently summarizes the status and configuration of a +MySQL database server so that you can learn about it at a glance. It is not +a tuning tool or diagnosis tool. It produces a report that is easy to diff +and can be pasted into emails without losing the formatting. It should work +well on any modern UNIX systems. *********** @@ -27,49 +33,47 @@ DESCRIPTION *********** -Goals: work well on all UNIXes; create a compact diff-able report that is -easy to paste into a wiki or email, and easy to scan and compare too. +pt-mysql-summary works by connecting to a MySQL database server and querying +it for status and configuration information. It saves these bits of data +into files in /tmp, and then formats them neatly with awk and other scripting +languages. To use, simply execute it. Optionally add the same command-line options -you would use to connect to MySQL, such as "./mysql-summary --user=foo" +you would use to connect to MySQL, like \ ``pt-mysql-summary --user=foo``\ . + +The tool interacts minimally with the server upon which it runs. It assumes +that you'll run it on the same server you're inspecting, and therefore it +assumes that it will be able to find the my.cnf configuration file, for +example. However, it should degrade gracefully if this is not the case. +Note, however, that its output does not indicate which information comes from +the MySQL database and which comes from the host operating system, so it is +possible for confusing output to be generated if you run the tool on one +server and direct it to connect to a MySQL database server running on another +server. -**** -TODO -**** +************** +Fuzzy-Rounding +************** - -.. code-block:: perl - - * Parse queries out of processlist and aggregate them. +Many of the outputs from this tool are deliberately rounded to show their +magnitude but not the exact detail. This is called fuzzy-rounding. The idea +is that it doesn't matter whether a server is running 918 queries per second +or 921 queries per second; such a small variation is insignificant, and only +makes the output hard to compare to other servers. Fuzzy-rounding rounds in +larger increments as the input grows. It begins by rounding to the nearest 5, +then the nearest 10, nearest 25, and then repeats by a factor of 10 larger +(50, 100, 250), and so on, as the input grows. - -*********** -DOWNLOADING -*********** +******* +OPTIONS +******* -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG - - -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL - - -Replace \ ``TOOL``\ with the name of any tool. +This tool does not have any command-line options of its own. All options +are passed to \ ``mysql``\ . *********** @@ -77,17 +81,7 @@ 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-mysql-summary ... > FILE 2>&1 - - -Be careful: debugging output is voluminous and can generate several megabytes -of output. +This tool does not use any environment variables. ******************* @@ -95,8 +89,7 @@ SYSTEM REQUIREMENTS ******************* -You need Perl, DBI, DBD::mysql, and some core packages that ought to be -installed in any reasonably new version of Perl. +This tool requires Bash v3 or newer. **** @@ -134,6 +127,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-online-schema-change.rst b/docs/user/pt-online-schema-change.rst index 96b3c834..b89cd881 100644 --- a/docs/user/pt-online-schema-change.rst +++ b/docs/user/pt-online-schema-change.rst @@ -644,22 +644,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-pmp.rst b/docs/user/pt-pmp.rst index cb8f87de..f6b73b8d 100644 --- a/docs/user/pt-pmp.rst +++ b/docs/user/pt-pmp.rst @@ -19,7 +19,12 @@ SYNOPSIS ******** -Usage: pt-pmp [OPTION...] +Usage: pt-pmp [OPTIONS] [FILES] + +pt-pmp is a poor man's profiler, inspired by `http://poormansprofiler.org `_. +It can create and summarize full stack traces of processes on Linux. +Summaries of stack traces can be an invaluable tool for diagnosing what +a process is waiting for. *********** @@ -27,33 +32,59 @@ DESCRIPTION *********** -pt-pmp aggregates stack traces. +pt-pmp performs two tasks: it gets a stack trace, and it summarizes the stack +trace. If a file is given on the command line, the tool skips the first step +and just aggregates the file. + +To summarize the stack trace, the tool extracts the function name (symbol) +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. -*********** -DOWNLOADING -*********** +******* +OPTIONS +******* -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Options must precede files on the command line. -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG +-b BINARY + + Which binary to trace (default mysqld) + -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +-i ITERATIONS + + How many traces to gather and aggregate (default 1) + -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL +-k KEEPFILE + + Keep the raw traces in this file after aggregation + -Replace \ ``TOOL``\ with the name of any tool. +-l NUMBER + + Aggregate only first NUMBER functions; 0=infinity (default 0) + + + +-p PID + + Process ID of the process to trace; overrides -b + + + +-s SLEEPTIME + + Number of seconds to sleep between iterations (default 0) + + *********** @@ -61,17 +92,7 @@ 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-pmp ... > FILE 2>&1 - - -Be careful: debugging output is voluminous and can generate several megabytes -of output. +This tool does not use any environment variables. ******************* @@ -79,8 +100,7 @@ SYSTEM REQUIREMENTS ******************* -You need Perl, DBI, DBD::mysql, and some core packages that ought to be -installed in any reasonably new version of Perl. +This tool requires Bash v3 or newer. **** @@ -118,6 +138,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-profile-compact.rst b/docs/user/pt-profile-compact.rst index a8301fce..17c4fa88 100644 --- a/docs/user/pt-profile-compact.rst +++ b/docs/user/pt-profile-compact.rst @@ -147,22 +147,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-query-advisor.rst b/docs/user/pt-query-advisor.rst index 2f908626..69f99b66 100644 --- a/docs/user/pt-query-advisor.rst +++ b/docs/user/pt-query-advisor.rst @@ -697,22 +697,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-query-digest.rst b/docs/user/pt-query-digest.rst index ab37fb67..e33a2533 100644 --- a/docs/user/pt-query-digest.rst +++ b/docs/user/pt-query-digest.rst @@ -11,8 +11,7 @@ NAME **** -pt-query-digest - Analyze query execution logs and generate a query report, -filter, replay, or transform queries for MySQL, PostgreSQL, memcached, and more. +pt-query-digest - Analyze query execution logs and generate a query report, filter, replay, or transform queries for MySQL, PostgreSQL, memcached, and more. ******** @@ -2441,22 +2440,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-query-profiler.rst b/docs/user/pt-query-profiler.rst index 233b87ba..ca3777f2 100644 --- a/docs/user/pt-query-profiler.rst +++ b/docs/user/pt-query-profiler.rst @@ -11,8 +11,7 @@ NAME **** -pt-query-profiler - Execute SQL statements and print statistics, or measure -activity caused by other processes. +pt-query-profiler - Execute SQL statements and print statistics, or measure activity caused by other processes. ******** @@ -623,22 +622,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-rel.rst b/docs/user/pt-rel.rst index 540ca3bc..96e7934e 100644 --- a/docs/user/pt-rel.rst +++ b/docs/user/pt-rel.rst @@ -11,7 +11,7 @@ NAME **** -rel - Make each number in a line of text relative to the previous matching line. +pt-rel - Relativize values to previous matching lines. ******** @@ -19,13 +19,16 @@ SYNOPSIS ******** -Given a file with some lines of text that follow a repeated pattern, including -numbers, +Usage: pt-rel [FILES] + +pt-rel matches lines and subtracts the value of the previous line's values +from the current line's values. The lines must be text with numeric values +that repeat, varying only the values. -.. code-block:: perl - - rel /path/to/file.txt +*********** +DESCRIPTION +*********** For example, if the text is this: @@ -39,7 +42,7 @@ For example, if the text is this: RW-shared spins 834352175, OS waits 20259032; RW-excl spins 1769762980 -The output will be +Then the output will be: .. code-block:: perl @@ -50,31 +53,17 @@ The output will be RW-shared spins 14648, OS waits 882; RW-excl spins 13146 - -*********** -DOWNLOADING -*********** +The first values (line 1) for "Mutex spin waits", "rounds", and "OS waits" +were subtracted from the second values (line 3); the same happened for values +from lines 2 and 4. -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +******* +OPTIONS +******* -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG - - -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL - - -Replace \ ``TOOL``\ with the name of any tool. +This tool does not have any command-line options. *********** @@ -100,7 +89,7 @@ SYSTEM REQUIREMENTS ******************* -You need Bash. +This tool requires Perl v5.8 or newer. **** @@ -138,6 +127,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-show-grants.rst b/docs/user/pt-show-grants.rst index 096ebc02..eb530e9b 100644 --- a/docs/user/pt-show-grants.rst +++ b/docs/user/pt-show-grants.rst @@ -11,8 +11,7 @@ NAME **** -pt-show-grants - Canonicalize and print MySQL grants so you can effectively -replicate, compare and version-control them. +pt-show-grants - Canonicalize and print MySQL grants so you can effectively replicate, compare and version-control them. ******** @@ -395,22 +394,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-sift.rst b/docs/user/pt-sift.rst index 298e23ef..f180dfb8 100644 --- a/docs/user/pt-sift.rst +++ b/docs/user/pt-sift.rst @@ -11,7 +11,7 @@ NAME **** -pt-sift - Browses the files created by the collect tool. +pt-sift - Browses files created by pt-collect. ******** @@ -19,7 +19,11 @@ SYNOPSIS ******** -Usage: pt-sift [OPTION...] +Usage: pt-sift FILE|PREFIX|DIRECTORY + +pt-sift browses the files created by pt-collect. If you specify a +FILE or PREFIX, it browses only files with that prefix. If you specify a +DIRECTORY, then it browses all files within that directory. *********** @@ -27,33 +31,87 @@ DESCRIPTION *********** -pt-sift browses the files created by the collect tool. +pt-sift downloads other tools that it might need, such as pt-diskstats, +and then makes a list of the unique timestamp prefixes of all the files in +the directory, as written by the pt-collect tool. If the user specified +a timestamp on the command line, then it begins with that sample of data; +otherwise it begins by showing a list of the timestamps and prompting for +a selection. Thereafter, it displays a summary of the selected sample, and +the user can navigate and inspect with keystrokes. The keystroke commands +you can use are as follows: -*********** -DOWNLOADING -*********** +d + + Sets the action to start the pt-diskstats tool on the sample's disk + performance statistics. + -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +i + + Sets the action to view the first INNODB STATUS sample in less. + -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG +m + + Displays the first 4 samples of SHOW STATUS counters side by side with the + pt-mext tool. + -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +n + + Summarizes the first sample of netstat data in two ways: by originating host, + and by connection state. + -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL +j + + Select the next timestamp as the active sample. + -Replace \ ``TOOL``\ with the name of any tool. +k + + Select the previous timestamp as the active sample. + + + +q + + Quit the program. + + + +1 + + Sets the action for each sample to the default, which is to view a summary + of the sample. + + + +0 + + Sets the action to just list the files in the sample. + + + +\* + + Sets the action to view all of the samples's files in the less program. + + + + +******* +OPTIONS +******* + + +This tool does not have any command-line options. *********** @@ -61,17 +119,7 @@ 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-sift ... > FILE 2>&1 - - -Be careful: debugging output is voluminous and can generate several megabytes -of output. +This tool does not use any environment variables. ******************* @@ -79,7 +127,7 @@ SYSTEM REQUIREMENTS ******************* -You need Bash. +This tool requires Bash v3 or newer. **** @@ -117,6 +165,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-slave-delay.rst b/docs/user/pt-slave-delay.rst index 9de72baf..4f3001ed 100644 --- a/docs/user/pt-slave-delay.rst +++ b/docs/user/pt-slave-delay.rst @@ -391,22 +391,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-slave-find.rst b/docs/user/pt-slave-find.rst index 8e790f45..194ce521 100644 --- a/docs/user/pt-slave-find.rst +++ b/docs/user/pt-slave-find.rst @@ -403,22 +403,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-slave-restart.rst b/docs/user/pt-slave-restart.rst index bec25e2d..cccef6a5 100644 --- a/docs/user/pt-slave-restart.rst +++ b/docs/user/pt-slave-restart.rst @@ -615,22 +615,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-stalk.rst b/docs/user/pt-stalk.rst index 1c1d4164..dba94c68 100644 --- a/docs/user/pt-stalk.rst +++ b/docs/user/pt-stalk.rst @@ -11,8 +11,7 @@ NAME **** -pt-stalk - Watch MySQL and run the 'collect' program when some condition -becomes true. +pt-stalk - Wait for a condition to occur then begin collecting data. ******** @@ -20,7 +19,12 @@ SYNOPSIS ******** -Usage: pt-stalk [OPTION...] +Usage: pt-stalk + +pt-stalk watches for a condition to become true, and when it does, executes +a script. By default it executes pt-collect, but that can be customized. +This tool is useful for gathering diagnostic data when an infrequent event +occurs, so an expert person can review the data later. *********** @@ -28,38 +32,68 @@ DESCRIPTION *********** -By default, it watches for a too-many-connections condition. -This is a good script to run in a screen session. It's separate from the -'collect' script because that lets you change 'collect' without stopping -and restarting this one. +Although pt-stalk comes pre-configured to do a specific thing, in general +this tool is just a skeleton script for the following flow of actions: + + +1. + + Loop infinitely, sleeping between iterations. + + + +2. + + In each iteration, run some command and get the output. + + + +3. + + If the command fails or the output is larger than the threshold, + execute the collection script; but do not execute if the destination disk + is too full. + + + +By default, the tool is configured to execute mysqladmin extended-status and +extract the value of the Threads_connected variable; if this is greater than +100, it runs the collection script. This is really just placeholder code, +and almost certainly needs to be customized! + +If the tool does execute the collection script, it will wait for a while +before checking and executing again. This is to prevent a continuous +condition from causing a huge number of executions to fire off. The name 'stalk' is because 'watch' is already taken, and 'stalk' is fun. *********** -DOWNLOADING +CONFIGURING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +If the file \ *pt-stalk.conf*\ exists in the current working directory, then +"ENVIRONMENT" variables are imported from it. For example, the config +file has the format: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + INTERVAL=10 + GDB=yes -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +See "ENVIRONMENT". -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL +******* +OPTIONS +******* -Replace \ ``TOOL``\ with the name of any tool. +This tool does not have any command-line options, but see +"ENVIRONMENT" and "CONFIGURING". *********** @@ -67,17 +101,121 @@ 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: +The following environment variables configure how, what, and when the tool +runs. They are all optional and can be specified either on the command line +or in the \ *pt-stalk.conf*\ config file (see "CONFIGURING"). -.. code-block:: perl - - PTDEBUG=1 pt-stalk ... > FILE 2>&1 +THRESHOLD (default 100) + + This is the max number of we want to tolerate. + -Be careful: debugging output is voluminous and can generate several megabytes -of output. +VARIABLE (default Threads_connected} + + This is the thing to check for. + + + +CYCLES (default 1) + + How many times must the condition be met before the script will fire? + + + +GDB (default no) + + Collect GDB stacktraces? + + + +OPROFILE (default yes) + + Collect oprofile data? + + + +STRACE (default no) + + Collect strace data? + + + +TCPDUMP (default yes) + + Collect tcpdump data? + + + +EMAIL + + Send mail to this list of addresses when the script triggers. + + + +MYSQLOPTIONS + + Any options to pass to mysql/mysqladmin, such as -u, -p, etc + + + +INTERVAL (default 30) + + This is the interval between checks. + + + +MAYBE_EMPTY (default no) + + If the command you're running to detect the condition is allowed to return + nothing (e.g. a grep line that might not even exist if there's no problem), + then set this to "yes". + + + +COLLECT (default ${HOME}/bin/pt-collect) + + This is the location of the 'collect' script. + + + +DEST (default ${HOME}/collected/) + + This is where to store the collected data. + + + +DURATION (default 30) + + How long to collect statistics data for? Make sure that this isn't longer + than SLEEP. + + + +SLEEP (default DURATION \* 10) + + How long to sleep after collecting? + + + +PCT_THRESHOLD (default 95) + + Bail out if the disk is more than this %full. + + + +MB_THRESHOLD (default 100) + + Bail out if the disk has less than this many MB free. + + + +PURGE (default 30) + + Remove samples after this many days. + + ******************* @@ -85,7 +223,7 @@ SYSTEM REQUIREMENTS ******************* -You need Bash. +This tool requires Bash v3 or newer. **** @@ -123,6 +261,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-summary.rst b/docs/user/pt-summary.rst index 52c0ec46..390a9b76 100644 --- a/docs/user/pt-summary.rst +++ b/docs/user/pt-summary.rst @@ -19,7 +19,29 @@ SYNOPSIS ******** -Usage: pt-collect [OPTION...] +Usage: pt-summary + +pt-summary conveniently summarizes the status and configuration of a server. +It is not a tuning tool or diagnosis tool. It produces a report that is easy +to diff and can be pasted into emails without losing the formatting. This +tool works well on Linux systems. + +Download and run: + + +.. code-block:: perl + + wget http://aspersa.googlecode.com/svn/trunk/summary + bash ./summary + + +Download and run in a single step: + + +.. code-block:: perl + + wget -O- http://aspersa.googlecode.com/svn/trunk/summary | bash + *********** @@ -27,43 +49,19 @@ DESCRIPTION *********** -Goals: work well on Linux; create a compact diff-able report that is -easy to paste into a wiki or email, and easy to scan and compare too. - -Usage: $ wget -O- http://aspersa.googlecode.com/svn/trunk/summary |bash -Options are set through the ASPERSA_SKIP environment variable. Set this -variable to a comma-separated list of things you want to omit. - -Options: - MOUNT: Don't print out mounted filesystems and disk fullness. - NETWORK: Don't print out information on network controllers & config. - PROCESS: Don't print out top processes and vmstat information. +pt-summary runs a large variety of commands to inspect system status and +configuration, saves the output into files in /tmp, and then runs Unix +commands on these results to format them nicely. It works best when +executed as a privileged user, but will also work without privileges, +although some output might not be possible to generate without root. -*********** -DOWNLOADING -*********** +******* +OPTIONS +******* -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG - - -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL - - -Replace \ ``TOOL``\ with the name of any tool. +This tool does not have any command-line options. *********** @@ -71,25 +69,24 @@ 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: +The ASPERSA_SKIP environment variable specifies a comma-separated list +of things to skip: .. code-block:: perl - PTDEBUG=1 pt-summary ... > FILE 2>&1 + MOUNT: Don't print out mounted filesystems and disk fullness. + NETWORK: Don't print out information on network controllers & config. + PROCESS: Don't print out top processes and vmstat information. -Be careful: debugging output is voluminous and can generate several megabytes -of output. - ******************* SYSTEM REQUIREMENTS ******************* -You need Bash. +This tool requires the Bourne shell (\ */bin/sh*\ ). **** @@ -127,6 +124,36 @@ If possible, include debugging output by running the tool with \ ``PTDEBUG``\ ; see "ENVIRONMENT". +*********** +DOWNLOADING +*********** + + +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: + + +.. code-block:: perl + + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb + + +You can also get individual tools from the latest release: + + +.. code-block:: perl + + wget percona.com/get/TOOL + + +Replace \ ``TOOL``\ with the name of any tool. + + ******* AUTHORS ******* diff --git a/docs/user/pt-table-checksum.rst b/docs/user/pt-table-checksum.rst index 076dc2cc..bbcebb73 100644 --- a/docs/user/pt-table-checksum.rst +++ b/docs/user/pt-table-checksum.rst @@ -11,8 +11,7 @@ NAME **** -pt-table-checksum - Perform an online replication consistency check, or -checksum MySQL tables efficiently on one or many servers. +pt-table-checksum - Perform an online replication consistency check, or checksum MySQL tables efficiently on one or many servers. ******** @@ -1907,22 +1906,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-table-sync.rst b/docs/user/pt-table-sync.rst index fa2e7d0f..a9b30e51 100644 --- a/docs/user/pt-table-sync.rst +++ b/docs/user/pt-table-sync.rst @@ -1431,22 +1431,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-tcp-model.rst b/docs/user/pt-tcp-model.rst index 90fe7697..3f26e9d2 100644 --- a/docs/user/pt-tcp-model.rst +++ b/docs/user/pt-tcp-model.rst @@ -11,8 +11,7 @@ NAME **** -pt-tcp-model - Transform tcpdump into metrics that permit performance and -scalability modeling. +pt-tcp-model - Transform tcpdump into metrics that permit performance and scalability modeling. ******** @@ -392,22 +391,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-trend.rst b/docs/user/pt-trend.rst index ee1b65f5..1a674943 100644 --- a/docs/user/pt-trend.rst +++ b/docs/user/pt-trend.rst @@ -126,22 +126,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-upgrade.rst b/docs/user/pt-upgrade.rst index 07849c7d..0b5579b3 100644 --- a/docs/user/pt-upgrade.rst +++ b/docs/user/pt-upgrade.rst @@ -692,22 +692,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-usl.rst b/docs/user/pt-usl.rst deleted file mode 100644 index 0a6b3d29..00000000 --- a/docs/user/pt-usl.rst +++ /dev/null @@ -1,189 +0,0 @@ - -###### -pt-usl -###### - -.. highlight:: perl - - -**** -NAME -**** - - -pt-usl - Model Universal Scalability Law. - - -******** -SYNOPSIS -******** - - -Usage: pt-usl [OPTION...] - - -*********** -DESCRIPTION -*********** - - -This tool is based on Neil Gunther's book Guerrilla Capacity Planning. - - -**** -TODO -**** - - - -.. code-block:: perl - - * Need to make it optionally make logarithmic X axis graph. Also, apply - -i and -n and so on in the main body, not in the converter itself, - so that I can convert a file and then manipulate it separately. - - * I want it to entirely skip samples that have too-large concurrency, as - defined by -m. I don't want it to just average the concurrency across the - other samples; it will introduce skew into the throughput for that sample, - too. - - - -*********** -DOWNLOADING -*********** - - -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/PKG - - -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: - - -.. code-block:: perl - - wget percona.com/latest/percona-toolkit/TOOL - - -Replace \ ``TOOL``\ with the name of any tool. - - -*********** -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-usl ... > FILE 2>&1 - - -Be careful: debugging output is voluminous and can generate several megabytes -of output. - - -******************* -SYSTEM REQUIREMENTS -******************* - - -You need Bash. - - -**** -BUGS -**** - - -For a list of known bugs, see `http://www.percona.com/bugs/pt-usl `_. - -Please report bugs at `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". - - -******* -AUTHORS -******* - - -Baron Schwartz - - -********************* -ABOUT PERCONA TOOLKIT -********************* - - -This tool is part of Percona Toolkit, a collection of advanced command-line -tools developed by Percona for MySQL support and consulting. Percona Toolkit -was forked from two projects in June, 2011: Maatkit and Aspersa. Those -projects were created by Baron Schwartz and developed primarily by him and -Daniel Nichter, both of whom are employed by Percona. Visit -`http://www.percona.com/software/ `_ for more software developed by Percona. - - -******************************** -COPYRIGHT, LICENSE, AND WARRANTY -******************************** - - -This program is copyright 2010-2011 Baron Schwartz, 2011 Percona Inc. -Feedback and improvements are welcome. - -THIS PROGRAM IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED -WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. - -This program is free software; you can redistribute it and/or modify it under -the terms of the GNU General Public License as published by the Free Software -Foundation, version 2; OR the Perl Artistic License. On UNIX and similar -systems, you can issue \`man perlgpl' or \`man perlartistic' to read these -licenses. - -You should have received a copy of the GNU General Public License along with -this program; if not, write to the Free Software Foundation, Inc., 59 Temple -Place, Suite 330, Boston, MA 02111-1307 USA. - - -******* -VERSION -******* - - -Percona Toolkit v1.0.0 released 2011-08-01 - diff --git a/docs/user/pt-variable-advisor.rst b/docs/user/pt-variable-advisor.rst index 8d8d3620..b92225d4 100644 --- a/docs/user/pt-variable-advisor.rst +++ b/docs/user/pt-variable-advisor.rst @@ -968,22 +968,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/pt-visual-explain.rst b/docs/user/pt-visual-explain.rst index 2d3da846..6a1c20c5 100644 --- a/docs/user/pt-visual-explain.rst +++ b/docs/user/pt-visual-explain.rst @@ -823,22 +823,26 @@ DOWNLOADING *********** -Visit `http://www.percona.com/software/ `_ to download the latest release of -Percona Toolkit. Or, to get the latest release from the command line: +Visit `http://www.percona.com/software/percona-toolkit/ `_ to download the +latest release of Percona Toolkit. Or, get the latest release from the +command line: .. code-block:: perl - wget percona.com/latest/percona-toolkit/PKG + wget percona.com/get/percona-toolkit.tar.gz + + wget percona.com/get/percona-toolkit.rpm + + wget percona.com/get/percona-toolkit.deb -Replace \ ``PKG``\ with \ ``tar``\ , \ ``rpm``\ , or \ ``deb``\ to download the package in that -format. You can also get individual tools from the latest release: +You can also get individual tools from the latest release: .. code-block:: perl - wget percona.com/latest/percona-toolkit/TOOL + wget percona.com/get/TOOL Replace \ ``TOOL``\ with the name of any tool. diff --git a/docs/user/tools.rst b/docs/user/tools.rst index 448aa721..06ffa341 100644 --- a/docs/user/tools.rst +++ b/docs/user/tools.rst @@ -42,6 +42,5 @@ Contents: pt-tcp-model pt-trend pt-upgrade - pt-usl pt-variable-advisor pt-visual-explain