PT-MYSQL-SUMMARY(1)

okay bestie, welcome to PT-MYSQL-SUMMARY(1) β€” the manual for pt-mysql-summary, and it's giving β€œI summarize MySQL so you can understand it at a glance” energy. no cap, it's a whole little report generator. πŸ’…

🌸 NAME 🌸

pt-mysql-summary β€” Summarize MySQL information nicely. literally the whole point. ✨

πŸ¦‹ SYNOPSIS πŸ¦‹

Usage: pt-mysql-summary [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.

πŸ’€ RISKS πŸ’€

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:

  • Read the tool's documentation
  • Review the tool's known "BUGS"
  • Test the tool on a non-production server
  • Backup your production server and verify the backups

✨ DESCRIPTION ✨

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 a temporary directory, and then formats them neatly with awk and other scripting languages.

To use, simply execute it. Optionally add a double dash and then the same command-line options you would use to connect to MySQL, such as the following:

pt-mysql-summary --user=root

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: 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 connect to a MySQL database server running on another server. 🫢

πŸŽ€ OUTPUT πŸŽ€

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 does not 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.

The following is a sample of the report that the tool produces:

         # Percona Toolkit MySQL Summary Report #######################
                       System time | 2012-03-30 18:46:05 UTC
                                     (local TZ: EDT -0400)
         # Instances ##################################################
           Port  Data Directory             Nice OOM Socket
           ===== ========================== ==== === ======
           12345 /tmp/12345/data            0    0   /tmp/12345.sock
           12346 /tmp/12346/data            0    0   /tmp/12346.sock
           12347 /tmp/12347/data            0    0   /tmp/12347.sock

The first two sections show which server the report was generated on and which MySQL instances are running on the server. This is detected from the output of ps and does not always detect all instances and parameters, but often works well. From this point forward, the report will be focused on a single MySQL instance, although several instances may appear in the above paragraph.

         # Report On Port 12345 #######################################
                              User | msandbox@%
                              Time | 2012-03-30 14:46:05 (EDT)
                          Hostname | localhost.localdomain
                           Version | 5.5.20-log MySQL Community Server (GPL)
                          Built On | linux2.6 i686
                           Started | 2012-03-28 23:33 (up 1+15:12:09)
                         Databases | 4
                           Datadir | /tmp/12345/data/
                         Processes | 2 connected, 2 running
                       Replication | Is not a slave, has 1 slaves connected
                           Pidfile | /tmp/12345/data/12345.pid (exists)

This section is a quick summary of the MySQL instance: version, uptime, and other very basic parameters. The Time output is generated from the MySQL server, unlike the system date and time printed earlier, so you can see whether the database and operating system times match.

         # Processlist ################################################

           Command                        COUNT(*) Working SUM(Time) MAX(Time)
           ------------------------------ -------- ------- --------- ---------
           Binlog Dump                           1       1    150000    150000
           Query                                 1       1         0         0

           User                           COUNT(*) Working SUM(Time) MAX(Time)
           ------------------------------ -------- ------- --------- ---------
           msandbox                              2       2    150000    150000

           Host                           COUNT(*) Working SUM(Time) MAX(Time)
           ------------------------------ -------- ------- --------- ---------
           localhost                             2       2    150000    150000

           db                             COUNT(*) Working SUM(Time) MAX(Time)
           ------------------------------ -------- ------- --------- ---------
           NULL                                  2       2    150000    150000

           State                          COUNT(*) Working SUM(Time) MAX(Time)
           ------------------------------ -------- ------- --------- ---------
           Master has sent all binlog to         1       1    150000    150000
           NULL                                  1       1         0         0

This section is a summary of the output from SHOW PROCESSLIST. Each sub-section is aggregated by a different item, which is shown as the first column heading. When summarized by Command, every row in SHOW PROCESSLIST is included, but otherwise, rows whose Command is Sleep are excluded from the SUM and MAX columns, so they do not skew the numbers too much. In the example shown, the server is idle except for this tool itself, and one connected replica, which is executing Binlog Dump.

The columns are the number of rows included, the number that are not in Sleep status, the sum of the Time column, and the maximum Time column. The numbers are fuzzy-rounded.

         # Status Counters (Wait 10 Seconds) ##########################
         Variable                            Per day  Per second     10 secs
         Binlog_cache_disk_use                     4
         Binlog_cache_use                         80
         Bytes_received                     15000000         175         200
         Bytes_sent                         15000000         175        2000
         Com_admin_commands                        1
         ...................(many lines omitted)............................
         Threads_created                          40                       1
         Uptime                                90000           1           1

This section shows selected counters from two snapshots of SHOW GLOBAL STATUS, gathered approximately 10 seconds apart and fuzzy-rounded. It includes only items that are incrementing counters; it does not include absolute numbers such as the Threads_running status variable, which represents a current value, rather than an accumulated number over time.

The first column is the variable name, and the second column is the counter from the first snapshot divided by 86400 (the number of seconds in a day), so you can see the magnitude of the counter's change per day. 86400 fuzzy-rounds to 90000, so the Uptime counter should always be about 90000.

The third column is the value from the first snapshot, divided by Uptime and then fuzzy-rounded, so it represents approximately how quickly the counter is growing per-second over the uptime of the server.

The fourth column is the incremental difference from the first and second snapshot, divided by the difference in uptime and then fuzzy-rounded. Therefore, it shows how quickly the counter is growing per second at the time the report was generated.

         # Table cache ################################################
                              Size | 400
                             Usage | 15%

This section shows the size of the table cache, followed by the percentage of the table cache in use. The usage is fuzzy-rounded.

         # Key Percona Server features ################################
               Table & Index Stats | Not Supported
              Multiple I/O Threads | Enabled
              Corruption Resilient | Not Supported
               Durable Replication | Not Supported
              Import InnoDB Tables | Not Supported
              Fast Server Restarts | Not Supported
                  Enhanced Logging | Not Supported
              Replica Perf Logging | Not Supported
               Response Time Hist. | Not Supported
                   Smooth Flushing | Not Supported
               HandlerSocket NoSQL | Not Supported
                    Fast Hash UDFs | Unknown

This section shows features that are available in Percona Server and whether they are enabled or not. In the example shown, the server is standard MySQL, not Percona Server, so the features are generally not supported.

         # Plugins ####################################################
                InnoDB compression | ACTIVE

This feature shows specific plugins and whether they are enabled.

         # Query cache ################################################
                  query_cache_type | ON
                              Size | 0.0
                             Usage | 0%
                  HitToInsertRatio | 0%

This section shows whether the query cache is enabled and its size, followed by the percentage of the cache in use and the hit-to-insert ratio. The latter two are fuzzy-rounded.

         # Schema #####################################################

           Database           Tables Views SPs Trigs Funcs   FKs Partn
           mysql                  24
           performance_schema     17
           sakila                 16     7   3     6     3    22

           Database           MyISAM CSV PERFORMANCE_SCHEMA InnoDB
           mysql                  22   2
           performance_schema                            17
           sakila                  8                            15

           Database           BTREE FULLTEXT
           mysql                 31
           performance_schema
           sakila                63        1

ok so when you pass --databases or --all-databases, this whole table shows up and it is giving organized:

                                c   t   s   e   l   d   i   t   m   v   s
                                h   i   e   n   o   a   n   i   e   a   m
                                a   m   t   u   n   t   t   n   d   r   a
                                r   e       m   g   e       y   i   c   l
                                    s           b   t       i   u   h   l
                                    t           l   i       n   m   a   i
                                    a           o   m       t   t   r   n
                                    m           b   e           e       t
                                    p                           x
                                                                t
           Database           === === === === === === === === === === ===
           mysql               61  10   6  78   5   4  26   3   4   5   3
           performance_schema               5          16          33
           sakila               1  15   1   3       4   3  19      42  26

This lil' beauty is a summary of how many and what type of objects live in your databases. And bestie, it's generated by running mysqldump --no-data, not by querying the INFORMATION_SCHEMA β€” because that can literally freeze a busy server. 😭 No cap, we're being polite to your server.

The first sub-report counts objects by type in each database: tables, views, and so on. The second one shows how many tables use the various storage engines in each database. The third sub-report shows the number of each type of index in each database.

The last section shows the number of columns of various data types in each database. For compact display the column headers are formatted vertically, so you gotta read downwards from the top, iykyk. In this example the first column is char and the second column is timestamp. This example is truncated so it doesn't wrap on a terminal.

All of the numbers in this portion of the output are exact, not fuzzy-rounded. Periodt. πŸ’…

✨ Noteworthy Technologies ✨

         # Noteworthy Technologies ####################################
                Full Text Indexing | Yes
                  Geospatial Types | No
                      Foreign Keys | Yes
                      Partitioning | No
                InnoDB Compression | Yes
                               SSL | No
              Explicit LOCK TABLES | No
                    Delayed Insert | No
                   XA Transactions | No
                       NDB Cluster | No
               Prepared Statements | No
          Prepared statement count | 0

This section is the vibe check for specific technologies your server is using. Some of them get detected from the schema dump we did for the previous sections; others we can suss out by looking at SHOW GLOBAL STATUS. Slay.


πŸ¦‹ InnoDB πŸ¦‹

         # InnoDB #####################################################
                           Version | 1.1.8
                  Buffer Pool Size | 16.0M
                  Buffer Pool Fill | 100%
                 Buffer Pool Dirty | 0%
                    File Per Table | OFF
                         Page Size | 16k
                     Log File Size | 2 * 5.0M = 10.0M
                   Log Buffer Size | 8M
                      Flush Method |
               Flush Log At Commit | 1
                        XA Support | ON
                         Checksums | ON
                       Doublewrite | ON
                   R/W I/O Threads | 4 4
                      I/O Capacity | 200
                Thread Concurrency | 0
               Concurrency Tickets | 500
                Commit Concurrency | 0
               Txn Isolation Level | REPEATABLE-READ
                 Adaptive Flushing | ON
               Adaptive Checkpoint |
                    Checkpoint Age | 0
                      InnoDB Queue | 0 queries inside InnoDB, 0 queries in queue
                Oldest Transaction | 0 Seconds
                  History List Len | 209
                        Read Views | 1
                  Undo Log Entries | 1 transactions, 1 total undo, 1 max undo
                 Pending I/O Reads | 0 buf pool reads, 0 normal AIO,
                                     0 ibuf AIO, 0 preads
                Pending I/O Writes | 0 buf pool (0 LRU, 0 flush list, 0 page);
                                     0 AIO, 0 sync, 0 log IO (0 log, 0 chkp);
                                     0 pwrites
               Pending I/O Flushes | 0 buf pool, 0 log
                Transaction States | 1xnot started

This one's all about the important config variables for the InnoDB storage engine. Heads up: the buffer pool fill percent and dirty percent are fuzzy-rounded (the rest of the numbers up there, exact). The last few lines are derived from the output of SHOW INNODB STATUS. And fr fr, it's likely this output will change in the future to become more useful β€” so don't get too attached. πŸ™ˆ


🌸 MyISAM 🌸

         # MyISAM #####################################################
                         Key Cache | 16.0M
                          Pct Used | 10%
                         Unflushed | 0%

Size of the MyISAM key cache, then the percentage of the cache in use and the percentage unflushed (both fuzzy-rounded, bestie).


πŸ” Security πŸ”

         # Security ###################################################
                             Users | 2 users, 0 anon, 0 w/o pw, 0 old pw
                     Old Passwords | OFF

Generated from queries to tables in the mysql system database. It tells you how many users exist plus the various potential security risks β€” like old-style passwords and users with no password at all. Be nosy about this one. πŸ‘€


πŸŽ€ Binary Logging πŸŽ€

         # Binary Logging #############################################
                           Binlogs | 1
                        Zero-Sized | 0
                        Total Size | 21.8M
                     binlog_format | STATEMENT
                  expire_logs_days | 0
                       sync_binlog | 0
                         server_id | 12345
                      binlog_do_db |
                  binlog_ignore_db |

Config and status of the binary logs. And listen β€” if there are zero-sized binary logs, then it is possible that the binlog index is out of sync with the binary logs that actually exist on disk. So like, keep an eye on that. πŸ’€


⭐ Noteworthy Variables ⭐

         # Noteworthy Variables #######################################
              Auto-Inc Incr/Offset | 1/1
            default_storage_engine | InnoDB
                        flush_time | 0
                      init_connect |
                         init_file |
                          sql_mode |
                  join_buffer_size | 128k
                  sort_buffer_size | 2M
                  read_buffer_size | 128k
              read_rnd_buffer_size | 256k
                bulk_insert_buffer | 0.00
               max_heap_table_size | 16M
                    tmp_table_size | 16M
                max_allowed_packet | 1M
                      thread_stack | 192k
                               log | OFF
                         log_error | /tmp/12345/data/mysqld.log
                      log_warnings | 1
                  log_slow_queries | ON
         log_queries_not_using_indexes | OFF
                 log_slave_updates | ON

Several noteworthy server config variables that might be important to know about when you're working with this server. Lowkey the greatest-hits album of settings.


🧚 Configuration File 🧚

         # Configuration File #########################################
                       Config File | /tmp/12345/my.sandbox.cnf
         [client]
         user                                = msandbox
         password                            = msandbox
         port                                = 12345
         socket                              = /tmp/12345/mysql_sandbox12345.sock
         [mysqld]
         port                                = 12345
         socket                              = /tmp/12345/mysql_sandbox12345.sock
         pid-file                            = /tmp/12345/data/mysql_sandbox12345.pid
         basedir                             = /home/baron/5.5.20
         datadir                             = /tmp/12345/data
         key_buffer_size                     = 16M
         innodb_buffer_pool_size             = 16M
         innodb_data_home_dir                = /tmp/12345/data
         innodb_log_group_home_dir           = /tmp/12345/data
         innodb_data_file_path               = ibdata1:10M:autoextend
         innodb_log_file_size                = 5M
         log-bin                             = mysql-bin
         relay_log                           = mysql-relay-bin
         log_slave_updates
         server-id                           = 12345
         report-host                         = 127.0.0.1
         report-port                         = 12345
         log-error                           = mysqld.log
         innodb_lock_wait_timeout            = 3
         # The End ####################################################

A pretty-printed version of your my.cnf file β€” comments removed, whitespace added so everything lines up and reads all cute and tidy. 🫢

The tool tries to detect the my.cnf file by peeking at the output of ps, and if it can't find the location of the file there, it tries common locations until it finds a file.

⚠️ Note that this file might not actually correspond with the server from which the report was generated. This can happen when the tool isn't run on the same server it's reporting on, or when detecting the location of the config file fails. So like… context, bestie.

✨ OPTIONS ✨

All options after -- are passed to mysql.

  • --all-databases β€” mysqldump and summarize all databases. See --databases.
  • --ask-pass β€” prompt for a password when connecting to MySQL.
  • --config β€” type: string. Read this comma-separated list of config files. If you specify it, it must be the first option on the command line (no pressure).
  • --databases β€” type: string. mysqldump and summarize this comma-separated list of databases. Specify --all-databases instead if you want to dump and summarize all databases.
  • --defaults-file β€” short form: -F; type: string. Only read mysql options from the given file. You must give an absolute pathname.
  • --help β€” print help and exit. Our fave.
  • --host β€” short form: -h; type: string. Host to connect to.
  • --list-encrypted-tables β€” default: false. Include a list of the encrypted tables in all databases. This can cause slowdowns since querying Information Schema tables can be slow.
  • --password β€” short form: -p; type: string. Password to use when connecting. If the password contains commas they must be escaped with a backslash: exam\,ple.
  • --port β€” short form: -P; type: int. Port number to use for connection.
  • --read-samples β€” type: string. Create a report from the files found in this directory.
  • --save-samples β€” type: string. Save the data files used to generate the summary in this directory.
  • --sleep β€” type: int; default: 10. Seconds to sleep when gathering status counters. Go take a lil nap. 😴
  • --socket β€” short form: -S; type: string. Socket file to use for connection.
  • --user β€” short form: -u; type: string. User for login if not current user.
  • --version β€” print the tool's version and exit.

🌈 ENVIRONMENT 🌈

This tool does not use any environment variables.

Like, zero. None. Nothing to set up. Iconic behavior, honestly.

🧰 SYSTEM REQUIREMENTS 🧰

Okay bestie, before we go anywhere: this tool requires Bash v3 or newer, Perl 5.8 or newer, and binutils. ✨ These are generally already provided by most distributions, so odds are you’re chilling. 🫢 On BSD systems, it may require a mounted procfs β€” noted! πŸ’…


πŸ› BUGS πŸ›

For a list of known bugs, see https://jira.percona.com/projects/PT/issues. 🫢

Please report bugs at https://jira.percona.com/projects/PT. Include the following information in your bug report, fr fr:

  • 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. πŸ’–


🚨 ATTENTION 🚨

⚠️ Using PTDEBUG might expose passwords. When debug is enabled, all command line parameters are shown in the output. πŸ’€ Keep that in mind, bestie β€” no leaking creds on main. πŸ™ˆ

πŸ“₯ 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, iconic behavior:

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:

wget percona.com/get/TOOL

Replace TOOL with the name of any tool. Slay. πŸ’…


✍️ AUTHORS ✍️

Baron Schwartz, Brian Fraser, and Daniel Nichter. πŸ‘‘


🌈 ABOUT PERCONA TOOLKIT 🌈

This tool is part of Percona Toolkit, a collection of advanced command-line tools for MySQL developed by Percona. ✨ Percona Toolkit was forked from two projects in June, 2011: Maatkit and Aspersa. Those projects were created by Baron Schwartz and primarily developed by him and Daniel Nichter. Visit http://www.percona.com/software/ to learn about other free, open-source software from Percona. πŸ’–


This program is copyright 2011-2026 Percona LLC and/or its affiliates, 2010-2011 Baron Schwartz. 🫢

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, version 2 along with this program; if not, see https://www.gnu.org/licenses/. πŸ’œ


🏷️ VERSION 🏷️

pt-mysql-summary 3.7.1-4 β€” periodt. πŸ’…


πŸŽ€ And that’s the wrap on PT-MYSQL-SUMMARY(1) β€” rendered by perl v5.42.2, dated 2026-09-01. Bye bestie, go summarize those MySQL servers! πŸ¦‹πŸ’–

πŸ“¦ where this page comes from