diff --git a/doc/configuration.txt b/doc/configuration.txt index 5444c0a2c..64eeac068 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -2653,6 +2653,7 @@ fullconn X - X X grace X X X X hash-type X - X X http-after-response - X X X +http-check comment X - X X http-check connect X - X X http-check disable-on-404 X - X X http-check expect X - X X @@ -2759,6 +2760,7 @@ stick on - - X X stick store-request - - X X stick store-response - - X X stick-table - X X X +tcp-check comment X - X X tcp-check connect X - X X tcp-check expect X - X X tcp-check send X - X X @@ -4389,6 +4391,24 @@ http-after-response unset-var() [ { if | unless } ] Example: http-after-response unset-var(sess.last_redir) + +http-check comment + Defines a comment for the following the http-check rule, reported in logs if + it fails. + May be used in sections : defaults | frontend | listen | backend + yes | no | yes | yes + + It only works for connect, send and expect rules. It is useful to make + user-friendly error reporting. + + Arguments : + is the comment message to add in logs if the following http-check + rule fails. + + See also : "option httpchk", "http-check conncet", "http-check send" and + "http-check expect". + + http-check connect [params*] Opens a new connection to perform an HTTP health check May be used in sections : defaults | frontend | listen | backend @@ -4414,6 +4434,8 @@ http-check connect [params*] They are optional and can be used to describe how HAProxy should open and use the HTTP connection. + comment defines a message to report if the rule evaluation fails. + default Use default options of the server line to do the health checks. The server options are used only if not redifined. @@ -4477,7 +4499,7 @@ http-check disable-on-404 See also : "option httpchk", "http-check expect" -http-check expect [min-recv ] +http-check expect [min-recv ] [comment ] [ok-status ] [error-status ] [tout-status ] [on-success ] [on-error ] [status-code ] [!] @@ -4486,6 +4508,8 @@ http-check expect [min-recv ] yes | no | yes | yes Arguments : + comment defines a message to report if the rule evaluation fails. + min-recv is optional and can define the minimum amount of data required to evaluate the current expect rule. If the number of received bytes is under this limit, the check will wait for more data. This @@ -4613,13 +4637,15 @@ http-check expect [min-recv ] and "http-check send" -http-check send [meth ] [uri ] [vsn ] +http-check send [meth ] [uri ] [vsn ] [comment ] [hdr ]* [body ] Add a possible list of headers and/or a body to the request sent during HTTP health checks. May be used in sections : defaults | frontend | listen | backend yes | no | yes | yes Arguments : + comment defines a message to report if the rule evaluation fails. + meth is the optional HTTP method used with the requests. When not set, the "OPTIONS" method is used, as it generally requires low server processing and is easy to filter out from the @@ -9988,6 +10014,23 @@ stick store-response [table ] [{if | unless} ] extraction. +tcp-check comment + Defines a comment for the following the tcp-check rule, reported in logs if + it fails. + May be used in sections : defaults | frontend | listen | backend + yes | no | yes | yes + + It only works for connect, send and expect rules. It is useful to make + user-friendly error reporting. + + Arguments : + is the comment message to add in logs if the following tcp-check + rule fails. + + See also : "option tcp-check", "tcp-check connect", "tcp-check send" and + "tcp-check expect". + + tcp-check connect [params*] Opens a new connection May be used in sections: defaults | frontend | listen | backend @@ -10012,6 +10055,8 @@ tcp-check connect [params*] They are optional and can be used to describe how HAProxy should open and use the TCP connection. + comment defines a message to report if the rule evaluation fails. + default Use default options of the server line to do the health checks. The server options are used only if not redifined. @@ -10065,7 +10110,7 @@ tcp-check connect [params*] See also : "option tcp-check", "tcp-check send", "tcp-check expect" -tcp-check expect [min-recv ] +tcp-check expect [min-recv ] [comment ] [ok-status ] [error-status ] [tout-status ] [on-success ] [on-error ] [status-code ] [!] @@ -10074,6 +10119,8 @@ tcp-check expect [min-recv ] yes | no | yes | yes Arguments : + comment defines a message to report if the rule evaluation fails. + min-recv is optional and can define the minimum amount of data required to evaluate the current expect rule. If the number of received bytes is under this limit, the check will wait for more data. This @@ -10206,11 +10253,14 @@ tcp-check expect [min-recv ] "tcp-check send-binary", "http-check expect", tune.chksize -tcp-check send +tcp-check send [comment ] Specify a string to be sent as a question during a generic health check May be used in sections: defaults | frontend | listen | backend yes | no | yes | yes + Arguments : + comment defines a message to report if the rule evaluation fails. + : the data to be sent as a question during a generic health check session. For now, must be a string. @@ -10224,12 +10274,14 @@ tcp-check send "tcp-check send-binary", tune.chksize -tcp-check send-binary +tcp-check send-binary [comment ] Specify a hex digits string to be sent as a binary question during a raw tcp health check May be used in sections: defaults | frontend | listen | backend yes | no | yes | yes + Arguments : + comment defines a message to report if the rule evaluation fails. : the data to be sent as a question during a generic health check session. For now, must be a string. : test the exact string in its hexadecimal form matches in the