mirrors/haproxy
1
0
Fork 0
mirror of https://git.haproxy.org/git/haproxy.git/ synced 2025-08-07 07:37:02 +02:00
Code Issues Projects Releases Wiki Activity

DOC: Be more explicit about configurable check ok/error/timeout status

Browse Source 
It is possible to configure the check status on success, on error and on
timeout, for http-check and tcp-check expect rules. But the documentation relies
on internal names. These names are reported on the stats and are describe in the
management guide. But it is probably a good idea to be more explicit too in the
doc describing these options.
This commit is contained in:
Christopher Faulet 2020-05-07 07:40:17 +02:00
parent 574e7bd7f3
commit d888f0fc6e
1 changed files with 33 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
doc/configuration.txt
View File

@ -4530,23 +4530,29 @@ http-check expect [min-recv <int>] [comment <msg>]
ok-status <st> is optional and can be used to set the check status if ok-status <st> is optional and can be used to set the check status if
the expect rule is successfully evaluated and if it is the expect rule is successfully evaluated and if it is
the last rule in the tcp-check ruleset. "L7OK", "L7OKC", the last rule in the tcp-check ruleset. "L7OK", "L7OKC",
"L6OK" and "L4OK" are supported and may be used to set, "L6OK" and "L4OK" are supported :
respectively, HCHK_STATUS_L7OK, HCHK_STATUS_L7OKCD, - L7OK : check passed on layer 7
HCHK_STATUS_L6OK or HCHK_STATUS_L4OK success status. - L7OKC : check conditionally passed on layer 7, for
By default "L7OK" is used. example 404 with disable-on-404
- L6OK : check passed on layer 6
- L4OK : check passed on layer 4
By default "L7OK" is used.
error-status <st> is optional and can be used to set the check status if error-status <st> is optional and can be used to set the check status if
an error occurred during the expect rule evaluation. an error occurred during the expect rule evaluation.
"L7RSP", "L7STS", "L6RSP" and "L4CON" are supported and "L7RSP", "L7STS", "L6RSP" and "L4CON" are supported :
may be used to set, respectively, HCHK_STATUS_L7RSP, - L7RSP : layer 7 invalid response - protocol error
HCHK_STATUS_L7STS, HCHK_STATUS_L6RSP or HCHK_STATUS_L4CON - L7STS : layer 7 response error, for example HTTP 5xx
error status. By default "L7RSP" is used. - L6RSP : layer 6 invalid response - protocol error
- L4CON : layer 1-4 connection problem
By default "L7RSP" is used.
tout-status <st> is optional and can be used to set the check status if tout-status <st> is optional and can be used to set the check status if
a timeout occurred during the expect rule evaluation. a timeout occurred during the expect rule evaluation.
"L7TOUT", "L6TOUT", and "L4TOUT" are supported and may "L7TOUT", "L6TOUT", and "L4TOUT" are supported :
be used to set, respectively, HCHK_STATUS_L7TOUT, - L7TOUT : layer 7 (HTTP/SMTP) timeout
HCHK_STATUS_L6TOUT or HCHK_STATUS_L4TOUT timeout status. - L6TOUT : layer 6 (SSL) timeout
- L4TOUT : layer 1-4 timeout
By default "L7TOUT" is used. By default "L7TOUT" is used.
on-success <fmt> is optional and can be used to customize the on-success <fmt> is optional and can be used to customize the
@ -10209,23 +10215,29 @@ tcp-check expect [min-recv <int>] [comment <msg>]
ok-status <st> is optional and can be used to set the check status if ok-status <st> is optional and can be used to set the check status if
the expect rule is successfully evaluated and if it is the expect rule is successfully evaluated and if it is
the last rule in the tcp-check ruleset. "L7OK", "L7OKC", the last rule in the tcp-check ruleset. "L7OK", "L7OKC",
"L6OK" and "L4OK" are supported and may be used to set, "L6OK" and "L4OK" are supported :
respectively, HCHK_STATUS_L7OK, HCHK_STATUS_L7OKCD, - L7OK : check passed on layer 7
HCHK_STATUS_L6OK or HCHK_STATUS_L4OK success status. - L7OKC : check conditionally passed on layer 7, for
example 404 with disable-on-404
- L6OK : check passed on layer 6
- L4OK : check passed on layer 4
By default "L7OK" is used. By default "L7OK" is used.
error-status <st> is optional and can be used to set the check status if error-status <st> is optional and can be used to set the check status if
an error occurred during the expect rule evaluation. an error occurred during the expect rule evaluation.
"L7RSP", "L7STS", "L6RSP" and "L4CON" are supported and "L7RSP", "L7STS", "L6RSP" and "L4CON" are supported :
may be used to set, respectively, HCHK_STATUS_L7RSP, - L7RSP : layer 7 invalid response - protocol error
HCHK_STATUS_L7STS, HCHK_STATUS_L6RSP or HCHK_STATUS_L4CON - L7STS : layer 7 response error, for example HTTP 5xx
error status. By default "L7RSP" is used. - L6RSP : layer 6 invalid response - protocol error
- L4CON : layer 1-4 connection problem
By default "L7RSP" is used.
tout-status <st> is optional and can be used to set the check status if tout-status <st> is optional and can be used to set the check status if
a timeout occurred during the expect rule evaluation. a timeout occurred during the expect rule evaluation.
"L7TOUT", "L6TOUT", and "L4TOUT" are supported and may "L7TOUT", "L6TOUT", and "L4TOUT" are supported :
be used to set, respectively, HCHK_STATUS_L7TOUT, - L7TOUT : layer 7 (HTTP/SMTP) timeout
HCHK_STATUS_L6TOUT or HCHK_STATUS_L4TOUT timeout status. - L6TOUT : layer 6 (SSL) timeout
- L4TOUT : layer 1-4 timeout
By default "L7TOUT" is used. By default "L7TOUT" is used.
on-success <fmt> is optional and can be used to customize the on-success <fmt> is optional and can be used to customize the