]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: Document the log-format parameter for tcp-check send/send-binary rules
authorChristopher Faulet <cfaulet@haproxy.com>
Thu, 30 Apr 2020 05:50:54 +0000 (07:50 +0200)
committerChristopher Faulet <cfaulet@haproxy.com>
Tue, 5 May 2020 09:06:43 +0000 (11:06 +0200)
The documentation was not updated when the parameter was added.

doc/configuration.txt

index 371fd8a446314634ee4f49620e98fc51c464ba62..0a320642340d41b7657c07fea4d14882ba3dbbe5 100644 (file)
@@ -10271,7 +10271,7 @@ tcp-check expect [min-recv <int>] [comment <msg>]
              "tcp-check send-binary", "http-check expect", tune.chksize
 
 
-tcp-check send <data> [comment <msg>]
+tcp-check send <data> [comment <msg>] [log-format]
   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
@@ -10279,6 +10279,8 @@ tcp-check send <data> [comment <msg>]
   Arguments :
     comment <msg>  defines a message to report if the rule evaluation fails.
 
+    log-format     specifies <data> must be evaluated a log-format string.
+
     <data>  the data to be sent as a question during a generic health check
             session. For now, <data> must be a string.
 
@@ -10292,7 +10294,7 @@ tcp-check send <data> [comment <msg>]
              "tcp-check send-binary", tune.chksize
 
 
-tcp-check send-binary <hexstring> [comment <msg>]
+tcp-check send-binary <hexstring> [comment <msg>] [log-format]
   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
@@ -10301,6 +10303,8 @@ tcp-check send-binary <hexstring> [comment <msg>]
   Arguments :
     comment <msg>  defines a message to report if the rule evaluation fails.
 
+    log-format     specifies <hexstring> must be evaluated a log-format string.
+
     <hexstring>  test the exact string in its hexadecimal form matches in the
                  response buffer. A health check response will be considered
                  valid if the response's buffer contains this exact hexadecimal