percona/percona-toolkit
1
0
Fork 0
mirror of https://github.com/percona/percona-toolkit.git synced 2025-09-17 08:57:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

PT-1662 fix pt-secure-collect doc styles

Browse Source
This commit is contained in:
Dima
2018-12-03 15:52:02 +03:00
parent d6b8863a3a
commit eff5d89e76
1 changed files with 276 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,8 +1,25 @@
pt-secure-collect .. program:: pt-secure-collect
=================
Collect, sanitize, pack and encrypt data. By default, this program will ============================
collect the output of: :program:`pt-secure-collect`
============================
NAME
====
:program:`pt-secure-collect` - collect, sanitize, pack and encrypt data.
SYNOPSIS
========
Usage
-----
::
pt-secure-data [<flags>] <command> [<args> ...]
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 --no-stalk --iterations=2 --sleep=30 --host=$mysql-host --dest=$temp-dir --port=$mysql-port --user=$mysql-user --password=$mysql-pass``
- ``pt-summary`` - ``pt-summary``
@@ -12,14 +29,8 @@ Internal variables placeholders will be replaced with the corresponding
flag values. For example, ``$mysql-host`` will be replaced with the flag values. For example, ``$mysql-host`` will be replaced with the
values specified in the ``--mysql-host`` flag. values specified in the ``--mysql-host`` flag.
Usage:
::
pt-secure-data [<flags>] <command> [<args> ...]
Global flags Global flags
~~~~~~~~~~~~ ------------
+-----------+----------------------------------------------------------------------+ +-----------+----------------------------------------------------------------------+
| Flag | Description | | Flag | Description |
@@ -29,291 +40,283 @@ Global flags
| --debug | Enable debug log level. | | --debug | Enable debug log level. |
+-----------+----------------------------------------------------------------------+ +-----------+----------------------------------------------------------------------+
**Commands** COMMANDS
~~~~~~~~~~~~ ========
**Help command** * **Help command**
^^^^^^^^^^^^^^^^
Show help Show help
**Collect command** * **Collect command**
^^^^^^^^^^^^^^^^^^^
Collect, sanitize, pack and encrypt data from pt-tools. Usage: Collect, sanitize, pack and encrypt data from pt-tools. Usage:
:: ::
pt-secure-collect collect <flags> pt-secure-collect collect <flags>
+--------+--------+ +--------+--------+
| Flag | Descri | | Flag | Descri |
| | ption | | | ption |
+========+========+ +========+========+
| --bin- | Direct | | --bin- | Direct |
| dir | ory | | dir | ory |
| | having | | | having |
| | the | | | the |
| | Percon | | | Percon |
| | a | | | a |
| | Toolki | | | Toolki |
| | t | | | t |
| | binari | | | binari |
| | es | | | es |
| | (if | | | (if |
| | they | | | they |
| | are | | | are |
| | not in | | | not in |
| | PATH). | | | PATH). |
+--------+--------+ +--------+--------+
| --temp | Tempor | | --temp | Tempor |
| -dir | ary | | -dir | ary |
| | direct | | | direct |
| | ory | | | ory |
| | used | | | used |
| | for | | | for |
| | the | | | the |
| | data | | | data |
| | collec | | | collec |
| | tion. | | | tion. |
| | Defaul | | | Defaul |
| | t: | | | t: |
| | ${HOME | | | ${HOME |
| | }/data | | | }/data |
| | \_coll | | | \_coll |
| | ection | | | ection |
| | \_{tim | | | \_{tim |
| | estamp | | | estamp |
| | } | | | } |
+--------+--------+ +--------+--------+
| --incl | Includ | | --incl | Includ |
| ude-di | e | | ude-di | e |
| r | this | | r | this |
| | dir | | | dir |
| | into | | | into |
| | the | | | the |
| | saniti | | | saniti |
| | zed | | | zed |
| | tar | | | tar |
| | file | | | file |
+--------+--------+ +--------+--------+
| --conf | Path | | --conf | Path |
| ig-fil | to the | | ig-fil | to the |
| e | config | | e | config |
| | file. | | | file. |
| | Defaul | | | Defaul |
| | t: | | | t: |
| | ``~/.m | | | ``~/.m |
| | y.cnf` | | | y.cnf` |
| | ` | | | ` |
+--------+--------+ +--------+--------+
| --mysq | MySQL | | --mysq | MySQL |
| l-host | host. | | l-host | host. |
| | Defaul | | | Defaul |
| | t: | | | t: |
| | ``127. | | | ``127. |
| | 0.0.1` | | | 0.0.1` |
| | ` | | | ` |
+--------+--------+ +--------+--------+
| --mysq | MySQL | | --mysq | MySQL |
| l-port | port. | | l-port | port. |
| | Defaul | | | Defaul |
| | t: | | | t: |
| | ``3306 | | | ``3306 |
| | `` | | | `` |
+--------+--------+ +--------+--------+
| --mysq | MySQL | | --mysq | MySQL |
| l-user | user | | l-user | user |
| | name. | | | name. |
+--------+--------+ +--------+--------+
| --mysq | MySQL | | --mysq | MySQL |
| l-pass | passwo | | l-pass | passwo |
| word | rd. | | word | rd. |
+--------+--------+ +--------+--------+
| --ask- | Ask | | --ask- | Ask |
| mysql- | MySQL | | mysql- | MySQL |
| pass | passwo | | pass | passwo |
| | rd. | | | rd. |
+--------+--------+ +--------+--------+
| --extr | Also | | --extr | Also |
| a-cmd | run | | a-cmd | run |
| | this | | | this |
| | comman | | | comman |
| | d | | | d |
| | as | | | as |
| | part | | | part |
| | of the | | | of the |
| | data | | | data |
| | collec | | | collec |
| | tion. | | | tion. |
| | This | | | This |
| | parame | | | parame |
| | ter | | | ter |
| | can be | | | can be |
| | used | | | used |
| | more | | | more |
| | than | | | than |
| | once. | | | once. |
+--------+--------+ +--------+--------+
| --encr | Encryp | | --encr | Encryp |
| ypt-pa | t | | ypt-pa | t |
| ssword | the | | ssword | the |
| | output | | | output |
| | file | | | file |
| | using | | | using |
| | this | | | this |
| | passwo | | | passwo |
| | rd.If | | | rd.If |
| | ommite | | | ommite |
| | d, | | | d, |
| | it | | | it |
| | will | | | will |
| | be | | | be |
| | asked | | | asked |
| | in the | | | in the |
| | comman | | | comman |
| | d | | | d |
| | line. | | | line. |
+--------+--------+ +--------+--------+
| --no-c | Do not | | --no-c | Do not |
| ollect | collec | | ollect | collec |
| | t | | | t |
| | data | | | data |
+--------+--------+ +--------+--------+
| --no-s | Do not | | --no-s | Do not |
| anitiz | saniti | | anitiz | saniti |
| e | ze | | e | ze |
| | data | | | data |
+--------+--------+ +--------+--------+
| --no-e | Do not | | --no-e | Do not |
| ncrypt | encryp | | ncrypt | encryp |
| | t | | | t |
| | the | | | the |
| | output | | | output |
| | file. | | | file. |
+--------+--------+ +--------+--------+
| --no-s | Do not | | --no-s | Do not |
| anitiz | saniti | | anitiz | saniti |
| e-host | ze | | e-host | ze |
| names | host | | names | host |
| | names. | | | names. |
+--------+--------+ +--------+--------+
| --no-s | Do not | | --no-s | Do not |
| anitiz | replac | | anitiz | replac |
| e-quer | e | | e-quer | e |
| ies | querie | | ies | querie |
| | s | | | s |
| | by | | | by |
| | their | | | their |
| | finger | | | finger |
| | prints | | | prints |
| | . | | | . |
+--------+--------+ +--------+--------+
| --no-r | Do not | | --no-r | Do not |
| emove- | remove | | emove- | remove |
| temp-f | tempor | | temp-f | tempor |
| iles | ary | | iles | ary |
| | files. | | | files. |
+--------+--------+ +--------+--------+
**Decrypt command** * **Decrypt command**
^^^^^^^^^^^^^^^^^^^
| Decrypt an encrypted file. The password will be requested from the Decrypt an encrypted file. The password will be requested from the
terminal. terminal. Usage:
| Usage:
:: ::
pt-secure-collect decrypt [flags] <input file> pt-secure-collect decrypt [flags] <input file>
+--------+---------+ +--------+---------+
| Flag | Descrip | | Flag | Descrip |
| | tion | | | tion |
+========+=========+ +========+=========+
| --outf | Write | | --outf | Write |
| ile | the | | ile | the |
| | output | | | output |
| | to this | | | to this |
| | file.If | | | file.If |
| | ommited | | | ommited |
| | , | | | , |
| | the | | | the |
| | output | | | output |
| | file | | | file |
| | name | | | name |
| | will be | | | will be |
| | the | | | the |
| | same as | | | same as |
| | the | | | the |
| | input | | | input |
| | file, | | | file, |
| | adding | | | adding |
| | the | | | the |
| | ``.aes` | | | ``.aes` |
| | ` | | | ` |
| | extensi | | | extensi |
| | on | | | on |
+--------+---------+ +--------+---------+
**Encrypt command** * **Encrypt command**
^^^^^^^^^^^^^^^^^^^
| Encrypt a file. The password will be requested from the terminal. Encrypt a file. The password will be requested from the terminal. Usage:
| Usage:
:: ::
pt-secure-collect encrypt [flags] <input file> pt-secure-collect encrypt [flags] <input file>
+--------+---------+ +--------+---------+
| Flag | Descrip | | Flag | Descrip |
| | tion | | | tion |
+========+=========+ +========+=========+
| --outf | Write | | --outf | Write |
| ile | the | | ile | the |
| | output | | | output |
| | to this | | | to this |
| | file.If | | | file.If |
| | ommited | | | ommited |
| | , | | | , |
| | the | | | the |
| | output | | | output |
| | file | | | file |
| | name | | | name |
| | will be | | | will be |
| | the | | | the |
| | same as | | | same as |
| | the | | | the |
| | input | | | input |
| | file, | | | file, |
| | without | | | without |
| | the | | | the |
| | ``.aes` | | | ``.aes` |
| | ` | | | ` |
| | extensi | | | extensi |
| | on | | | on |
+--------+---------+ +--------+---------+
**Sanitize command** * **Sanitize command**
^^^^^^^^^^^^^^^^^^^^
| Replace queries in a file by their fingerprints and obfuscate Replace queries in a file by their fingerprints and obfuscate hostnames.
hostnames. Usage:
| Usage:
:: ::
pt-secure-collect sanitize [flags] pt-secure-collect sanitize [flags]
+---------------------------+------------------------------------------------------------+ +---------------------------+------------------------------------------------------------+
| Flag | Description | | Flag | Description |
+===========================+============================================================+ +===========================+============================================================+
| --input-file | Input file. If not specified, the input will be Stdin. | | --input-file | Input file. If not specified, the input will be Stdin. |
+---------------------------+------------------------------------------------------------+ +---------------------------+------------------------------------------------------------+
| --output-file | Output file. If not specified, the input will be Stdout. | | --output-file | Output file. If not specified, the input will be Stdout. |
+---------------------------+------------------------------------------------------------+ +---------------------------+------------------------------------------------------------+
| --no-sanitize-hostnames | Do not sanitize host names. | | --no-sanitize-hostnames | Do not sanitize host names. |
+---------------------------+------------------------------------------------------------+ +---------------------------+------------------------------------------------------------+
| --no-sanitize-queries | Do not replace queries by their fingerprints. | | --no-sanitize-queries | Do not replace queries by their fingerprints. |
+---------------------------+------------------------------------------------------------+ +---------------------------+------------------------------------------------------------+