[MXS-2712] maxctrl help does not explain meaning of the output columns of some commands Created: 2019-10-03  Updated: 2019-10-29  Resolved: 2019-10-10

Status: Closed
Project: MariaDB MaxScale
Component/s: maxctrl
Affects Version/s: 2.3.12
Fix Version/s: 2.3.13

Type: Bug Priority: Major
Reporter: Claudio Nanni Assignee: markus makela
Resolution: Fixed Votes: 0
Labels: None

Sprint: MXS-SPRINT-92

 Description   

When running commands with `maxctrl` , headings are not explained in some cases,e.g.:

 maxctrl show threads
┌────────────────────────┬────┐
│ Id                     │ 0
├────────────────────────┼────┤
│ Accepts                │ 0
├────────────────────────┼────┤
│ Reads                  │ 29
├────────────────────────┼────┤
│ Writes                 │ 0
├────────────────────────┼────┤
│ Hangups                │ 0
├────────────────────────┼────┤
│ Errors                 │ 0
├────────────────────────┼────┤
│ Blocking polls         │    │
├────────────────────────┼────┤
│ Avg event queue length │ 1
├────────────────────────┼────┤
│ Max event queue length │ 1
├────────────────────────┼────┤
│ Max exec time          │ 0
├────────────────────────┼────┤
│ Max queue time         │ 0
├────────────────────────┼────┤
│ Current FDs            │ 2
├────────────────────────┼────┤
│ Total FDs              │ 2
├────────────────────────┼────┤
│ Load (1s)              │ 0
├────────────────────────┼────┤
│ Load (1m)              │ 0
├────────────────────────┼────┤
│ Load (1h)              │ 0
├────────────────────────┼────┤
│ QC cache size          │ 0
├────────────────────────┼────┤
│ QC cache inserts       │ 0
├────────────────────────┼────┤
│ QC cache hits          │ 0
├────────────────────────┼────┤
│ QC cache misses        │ 0
├────────────────────────┼────┤
│ QC cache evictions     │ 0
└────────────────────────┴────┘

maxctrl show threads help
Usage: show threads
 
Options:
  --version                     Show version number                    [boolean]
  -u, --user                    Username to use      [string] [default: "admin"]
  -p, --password                Password for the user. To input the password
                                manually, give -p as the last argument or use
                                --password=''      [string] [default: "mariadb"]
  -h, --hosts                   List of MaxScale hosts. The hosts must be in
                                HOST:PORT format and each value must be
                                separated by a comma.
                                            [string] [default: "localhost:8989"]
  -t, --timeout                 Request timeout in milliseconds
                                                       [number] [default: 10000]
  -q, --quiet                   Silence all output    [boolean] [default: false]
  --tsv                         Print tab separated output
                                                      [boolean] [default: false]
  -s, --secure                  Enable HTTPS requests [boolean] [default: false]
  --tls-key                     Path to TLS private key                 [string]
  --tls-cert                    Path to TLS public certificate          [string]
  --tls-passphrase              Password for the TLS private key        [string]
  --tls-ca-cert                 Path to TLS CA certificate              [string]
  -n, --tls-verify-server-cert  Whether to verify server TLS certificates
                                                       [boolean] [default: true]
  --help                        Show help                              [boolean]

And manual doesn't help either:

https://mariadb.com/kb/en/mariadb-maxscale-23-maxctrl/#show-threads



 Comments   
Comment by markus makela [ 2019-10-10 ]

Added field descriptions into the help output.

Generated at Thu Feb 08 04:16:08 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.