pt-secure-collect¶
NAME¶
pt-secure-collect - collect, sanitize, pack and encrypt data.
SYNOPSIS¶
Usage¶
pt-secure-collect [<flags>] <command> [<args> ...]
By default, pt-secure-collect will collect the output of:
pt-stalk --no-stalk --iterations=2 --sleep=30pt-summarypt-mysql-summary
Global flags¶
- --help¶
Show context-sensitive help (also try –help-long and –help-man).
- --debug¶
Enable debug log level.
COMMANDS¶
Help command
Show help
Collect command
Collect, sanitize, pack and encrypt data from pt-tools. Usage:
pt-secure-collect collect <flags>
- --bin-dir¶
Directory having the Percona Toolkit binaries (if they are not in PATH).
- --temp-dir¶
Temporary directory used for the data collection. Default:
${HOME}/data_collection_{timestamp}
- --include-dir¶
Include this dir into the sanitized tar file.
- --config-file¶
Path to the config file. Default:
~/.my.cnf
- --mysql-host¶
MySQL host. Default:
127.0.0.1
- --mysql-port¶
MySQL port. Default:
3306
- --mysql-user¶
MySQL user name.
- --mysql-password¶
MySQL password.
- --ask-mysql-pass¶
Ask MySQL password.
- --extra-cmd¶
Also run this command as part of the data collection. This parameter can be used more than once.
- --encrypt-password¶
Encrypt the output file using this password. If omitted, it will be asked in the command line.
- --no-collect¶
Do not collect data
- --no-sanitize¶
Do not sanitize data
- --no-encrypt¶
Do not encrypt the output file.
- --no-sanitize-hostnames¶
Do not sanitize hostnames.
- --no-sanitize-queries¶
Do not replace queries by their fingerprints.
- --no-remove-temp-files¶
Do not remove temporary files.
Decrypt command
Decrypt an encrypted file. The password will be requested from the terminal. Usage:
pt-secure-collect decrypt [flags] <input file>
- --outfile¶
Write the output to this file. If omitted, the output file name will be the same as the input file, adding the
.aesextension.
Encrypt command
Encrypt a file. The password will be requested from the terminal. Usage:
pt-secure-collect encrypt [flags] <input file>
- --outfile¶
Write the output to this file. If omitted, the output file name will be the same as the input file, without the
.aesextension.
Sanitize command
Replace queries in a file by their fingerprints and obfuscate hostnames. Usage:
pt-secure-collect sanitize [flags]
- --input-file¶
Input file. If not specified, the input will be Stdin.
- --output-file¶
Output file. If not specified, the input will be Stdout.
- --no-sanitize-hostnames¶
Do not sanitize host names.
- --no-sanitize-queries¶
Do not replace queries by their fingerprints.
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.
COPYRIGHT, LICENSE, AND WARRANTY¶
This program is copyright 2011-2026 Percona LLC and/or its affiliates.
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¶
pt-secure-collect 3.7.1