percona/percona-toolkit
1
0
Fork 0
mirror of https://github.com/percona/percona-toolkit.git synced 2026-04-06 01:06:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

correct tables and list

Browse Source
This commit is contained in:
Dima
2018-12-13 14:21:21 +03:00
parent eff5d89e76
commit 2c35d90f9f
1 changed files with 81 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

326
docs/pt-secure-collect.rst
View File

@@ -21,9 +21,9 @@ Usage
By default, :program:`pt-secure-collect` will collect the output of:
- ``pt-stalk --no-stalk --iterations=2 --sleep=30 --host=$mysql-host --dest=$temp-dir --port=$mysql-port --user=$mysql-user --password=$mysql-pass``
- ``pt-stalk``
- ``pt-summary``
- ``pt-mysql-summary --host=$mysql-host --port=$mysql-port --user=$mysql-user --password=$mysql-pass``
- ``pt-mysql-summary``
Internal variables placeholders will be replaced with the corresponding
flag values. For example, ``$mysql-host`` will be replaced with the
@@ -32,13 +32,13 @@ values specified in the ``--mysql-host`` flag.
Global flags
------------
+-----------+----------------------------------------------------------------------+
| Flag | Description |
+===========+======================================================================+
| --help | Show context-sensitive help (also try --help-long and --help-man). |
+-----------+----------------------------------------------------------------------+
| --debug | Enable debug log level. |
+-----------+----------------------------------------------------------------------+
+---------+-------------------------------------------------------------------+
| Flag | Description |
+---------+-------------------------------------------------------------------+
| --help | Show context-sensitive help (also try --help-long and --help-man).|
+---------+-------------------------------------------------------------------+
| --debug | Enable debug log level. |
+---------+-------------------------------------------------------------------+
COMMANDS
========
@@ -55,175 +55,51 @@ COMMANDS
pt-secure-collect collect <flags>
+--------+--------+
| Flag | Descri |
| | ption |
+========+========+
| --bin- | Direct |
| dir | ory |
| | having |
| | the |
| | Percon |
| | a |
| | Toolki |
| | t |
| | binari |
| | es |
| | (if |
| | they |
| | are |
| | not in |
| | PATH). |
+--------+--------+
| --temp | Tempor |
| -dir | ary |
| | direct |
| | ory |
| | used |
| | for |
| | the |
| | data |
| | collec |
| | tion. |
| | Defaul |
| | t: |
| | ${HOME |
| | }/data |
| | \_coll |
| | ection |
| | \_{tim |
| | estamp |
| | } |
+--------+--------+
| --incl | Includ |
| ude-di | e |
| r | this |
| | dir |
| | into |
| | the |
| | saniti |
| | zed |
| | tar |
| | file |
+--------+--------+
| --conf | Path |
| ig-fil | to the |
| e | config |
| | file. |
| | Defaul |
| | t: |
| | ``~/.m |
| | y.cnf` |
| | ` |
+--------+--------+
| --mysq | MySQL |
| l-host | host. |
| | Defaul |
| | t: |
| | ``127. |
| | 0.0.1` |
| | ` |
+--------+--------+
| --mysq | MySQL |
| l-port | port. |
| | Defaul |
| | t: |
| | ``3306 |
| | `` |
+--------+--------+
| --mysq | MySQL |
| l-user | user |
| | name. |
+--------+--------+
| --mysq | MySQL |
| l-pass | passwo |
| word | rd. |
+--------+--------+
| --ask- | Ask |
| mysql- | MySQL |
| pass | passwo |
| | rd. |
+--------+--------+
| --extr | Also |
| a-cmd | run |
| | this |
| | comman |
| | d |
| | as |
| | part |
| | of the |
| | data |
| | collec |
| | tion. |
| | This |
| | parame |
| | ter |
| | can be |
| | used |
| | more |
| | than |
| | once. |
+--------+--------+
| --encr | Encryp |
| ypt-pa | t |
| ssword | the |
| | output |
| | file |
| | using |
| | this |
| | passwo |
| | rd.If |
| | ommite |
| | d, |
| | it |
| | will |
| | be |
| | asked |
| | in the |
| | comman |
| | d |
| | line. |
+--------+--------+
| --no-c | Do not |
| ollect | collec |
| | t |
| | data |
+--------+--------+
| --no-s | Do not |
| anitiz | saniti |
| e | ze |
| | data |
+--------+--------+
| --no-e | Do not |
| ncrypt | encryp |
| | t |
| | the |
| | output |
| | file. |
+--------+--------+
| --no-s | Do not |
| anitiz | saniti |
| e-host | ze |
| names | host |
| | names. |
+--------+--------+
| --no-s | Do not |
| anitiz | replac |
| e-quer | e |
| ies | querie |
| | s |
| | by |
| | their |
| | finger |
| | prints |
| | . |
+--------+--------+
| --no-r | Do not |
| emove- | remove |
| temp-f | tempor |
| iles | ary |
| | files. |
+--------+--------+
+------------------------+--------------------------------------------------+
| Flag | Description |
+------------------------+--------------------------------------------------+
| --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 | 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 |
| | ommited, 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**
@@ -234,34 +110,13 @@ COMMANDS
pt-secure-collect decrypt [flags] <input file>
+--------+---------+
| Flag | Descrip |
| | tion |
+========+=========+
| --outf | Write |
| ile | the |
| | output |
| | to this |
| | file.If |
| | ommited |
| | , |
| | the |
| | output |
| | file |
| | name |
| | will be |
| | the |
| | same as |
| | the |
| | input |
| | file, |
| | adding |
| | the |
| | ``.aes` |
| | ` |
| | extensi |
| | on |
+--------+---------+
+-----------+---------------------------------------------------------------+
| Flag | Description |
+------------------------+--------------------------------------------------+
| --outfile | Write the output to this file. If ommited, the output file |
| | name will be the same as the input file, adding the ``.aes`` |
| | extension |
+-----------+---------------------------------------------------------------+
* **Encrypt command**
@@ -271,34 +126,13 @@ COMMANDS
pt-secure-collect encrypt [flags] <input file>
+--------+---------+
| Flag | Descrip |
| | tion |
+========+=========+
| --outf | Write |
| ile | the |
| | output |
| | to this |
| | file.If |
| | ommited |
| | , |
| | the |
| | output |
| | file |
| | name |
| | will be |
| | the |
| | same as |
| | the |
| | input |
| | file, |
| | without |
| | the |
| | ``.aes` |
| | ` |
| | extensi |
| | on |
+--------+---------+
+-----------+---------------------------------------------------------------+
| Flag | Description |
+------------------------+--------------------------------------------------+
| --outfile | Write the output to this file. If ommited, the output file |
| | name will be the same as the input file, without the ``.aes`` |
| | extension |
+-----------+---------------------------------------------------------------+
* **Sanitize command**
@@ -309,14 +143,16 @@ COMMANDS
pt-secure-collect sanitize [flags]
+---------------------------+------------------------------------------------------------+
| Flag | Description |
+===========================+============================================================+
| --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. |
+---------------------------+------------------------------------------------------------+
+---------------------------+-----------------------------------------------+
| Flag | Description |
+------------------------+--------------------------------------------------+
| --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. |
+---------------------------+-----------------------------------------------+