konevsa/haproxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOC: management: apply the "show stat" modifiers to "show stat", not "show info"

Browse Source 
By mistake I added the "up" then "maint" output modifiers to the "show info"
block instead of the "show stat" one in the two previous commits 65141ffc4
("MINOR: stats: support the "up" output modifier for "show stat"") and
3e3203670 ("MINOR: stats: also support a "no-maint" show stat modifier").

No backport is needed.
This commit is contained in:
Willy Tarreau 2020-10-23 20:19:47 +02:00
parent 1ac17682e5
commit 698097b54c
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/management.txt
View File

@ -2123,7 +2123,7 @@ show fd [<fd>]
that the output format may evolve over time so this output must not be parsed
by tools designed to be durable.
show info [typed|json] [desc] [up|no-maint]
show info [typed|json] [desc]
Dump info about haproxy status on current process. If "typed" is passed as an
optional argument, field numbers, names and types are emitted as well so that
external monitoring products can easily retrieve, possibly aggregate, then
@ -2136,13 +2136,6 @@ show info [typed|json] [desc] [up|no-maint]
format, the dump for a single object is contiguous so that there is no
need for a consumer to store everything at once.
The "up" modifier will result in listing only servers which reportedly up or
not checked. Those down, unresolved, or in maintenance will not be listed.
This is analogous to the ";up" option on the HTTP stats. Similarly, the
"no-maint" modifier will act like the ";no-maint" HTTP modifier and will
result in disabled servers not to be listed. The difference is that those
which are enabled but down will not be evicted.
When using the typed output format, each line is made of 4 columns delimited
by colons (':'). The first column is a dot-delimited series of 3 elements. The
first element is the numeric position of the field in the list (starting at
@ -2444,7 +2437,8 @@ show sess <id>
The special id "all" dumps the states of all sessions, which must be avoided
as much as possible as it is highly CPU intensive and can take a lot of time.
show stat [domain <domain>] [{<iid>|<proxy>} <type> <sid>] [typed|json] [desc]
show stat [domain <domain>] [{<iid>|<proxy>} <type> <sid>] [typed|json] \
[desc] [up|no-maint]
Dump statistics. The domain is used to select which statistics to print; only
proxy is available for now. By default, the CSV format is used; you can
activate the extended typed output format described in the section above if
@ -2493,6 +2487,13 @@ show stat [domain <domain>] [{<iid>|<proxy>} <type> <sid>] [typed|json] [desc]
typed output format, the dump for a single object is contiguous so that there
is no need for a consumer to store everything at once.
The "up" modifier will result in listing only servers which reportedly up or
not checked. Those down, unresolved, or in maintenance will not be listed.
This is analogous to the ";up" option on the HTTP stats. Similarly, the
"no-maint" modifier will act like the ";no-maint" HTTP modifier and will
result in disabled servers not to be listed. The difference is that those
which are enabled but down will not be evicted.
When using the typed output format, each line is made of 4 columns delimited
by colons (':'). The first column is a dot-delimited series of 5 elements. The
first element is a letter indicating the type of the object being described.