From fd9d09d9ae01eb10ea62d3d5aa090446665c3b5f Mon Sep 17 00:00:00 2001 From: Yoann La Cancellera Date: Tue, 21 Nov 2023 16:16:18 +0100 Subject: [PATCH] Fix: README with -vvv, --grep-args, regex-list --- docs/pt-galera-log-explainer.rst | 16 +++++----------- src/go/pt-galera-log-explainer/README.rst | 16 +++++----------- 2 files changed, 10 insertions(+), 22 deletions(-) diff --git a/docs/pt-galera-log-explainer.rst b/docs/pt-galera-log-explainer.rst index 7514fda7..daa3b824 100644 --- a/docs/pt-galera-log-explainer.rst +++ b/docs/pt-galera-log-explainer.rst @@ -12,7 +12,7 @@ Usage .. code-block:: bash - pt-galera-log-explainer [--since=] [--until=] [-vvv] [--merge-by-directory] [--pxc-operator] + pt-galera-log-explainer [--since=] [--until=] [-vv] [--merge-by-directory] [--pxc-operator] Commands available @@ -131,13 +131,11 @@ Available flags ``--merge-by-directory`` Instead of relying on extracted information, logs will be merged by their base directory - It is useful when logs are very sparsed and already organized by nodes. + It is useful when logs are very sparse and already organized by nodes. ``-v``, ``--verbosity`` - ``-v``: Detailed - ``-vv``: DebugMySQL, add every mysql info the tool used - ``-vvv``: internal tool debug - Default: ``-v`` + ``-v``: display in the timeline every mysql info the tool used + ``-vv``: internal tool debug ``--pxc-operator`` Analyze logs from Percona PXC operator. @@ -145,16 +143,12 @@ Available flags Off by default because it negatively impacts performance for non-k8s setups. ``--exclude-regexes`` - Remove regexes from analysis. Use 'pt-galera-log-explainer regex-list' to have the list + Remove regexes from analysis. Use 'pt-galera-log-explainer regex-list | jq .' to have the list ``--grep-cmd`` grep v3 binary command path. For Darwin systems, it could need to be set to 'ggrep' Default: ``grep`` -``--grep-args`` - grep arguments. perl regexp (-P) is necessary. -o will break the tool - Default: ``-P`` - ``--version`` Show version and exit. diff --git a/src/go/pt-galera-log-explainer/README.rst b/src/go/pt-galera-log-explainer/README.rst index 7514fda7..daa3b824 100644 --- a/src/go/pt-galera-log-explainer/README.rst +++ b/src/go/pt-galera-log-explainer/README.rst @@ -12,7 +12,7 @@ Usage .. code-block:: bash - pt-galera-log-explainer [--since=] [--until=] [-vvv] [--merge-by-directory] [--pxc-operator] + pt-galera-log-explainer [--since=] [--until=] [-vv] [--merge-by-directory] [--pxc-operator] Commands available @@ -131,13 +131,11 @@ Available flags ``--merge-by-directory`` Instead of relying on extracted information, logs will be merged by their base directory - It is useful when logs are very sparsed and already organized by nodes. + It is useful when logs are very sparse and already organized by nodes. ``-v``, ``--verbosity`` - ``-v``: Detailed - ``-vv``: DebugMySQL, add every mysql info the tool used - ``-vvv``: internal tool debug - Default: ``-v`` + ``-v``: display in the timeline every mysql info the tool used + ``-vv``: internal tool debug ``--pxc-operator`` Analyze logs from Percona PXC operator. @@ -145,16 +143,12 @@ Available flags Off by default because it negatively impacts performance for non-k8s setups. ``--exclude-regexes`` - Remove regexes from analysis. Use 'pt-galera-log-explainer regex-list' to have the list + Remove regexes from analysis. Use 'pt-galera-log-explainer regex-list | jq .' to have the list ``--grep-cmd`` grep v3 binary command path. For Darwin systems, it could need to be set to 'ggrep' Default: ``grep`` -``--grep-args`` - grep arguments. perl regexp (-P) is necessary. -o will break the tool - Default: ``-P`` - ``--version`` Show version and exit.