DOC: Explanation of be_name and be_id fetches

The be_name and be_id fetches contain data related to the current
backend and can be used in frontend responses. Yet, in cases where
no backend is used due to a local response or backend selection
failure, these fetches retain details of the current frontend.

This patch enhances the clarity of the values provided by these
fetches.

Signed-off-by: Sbastien Gross <sgross@haproxy.com>
This commit is contained in:
Sbastien Gross 2023-08-23 05:49:11 -04:00 committed by Willy Tarreau
parent 0a20be8915
commit f20f85f4d7

View File

@ -19959,13 +19959,16 @@ bc_src_port : integer
be_id : integer be_id : integer
Returns an integer containing the current backend's id. It can be used in Returns an integer containing the current backend's id. It can be used in
frontends with responses to check which backend processed the request. It can frontends with responses to check which backend processed the request. If
also be used in a tcp-check or an http-check ruleset. used in a frontend and no backend was used, it returns the current
frontend's id. It can also be used in a tcp-check or an http-check ruleset.
be_name : string be_name : string
Returns a string containing the current backend's name. It can be used in Returns a string containing the current backend's name. It can be used in
frontends with responses to check which backend processed the request. It can frontends with responses to check which backend processed the request. If
also be used in a tcp-check or an http-check ruleset. used in a frontend and no backend was used, it returns the current
frontend's name. It can also be used in a tcp-check or an http-check
ruleset.
bc_rtt(<unit>) : integer bc_rtt(<unit>) : integer
Returns the Round Trip Time (RTT) measured by the kernel for the backend Returns the Round Trip Time (RTT) measured by the kernel for the backend
@ -23663,7 +23666,8 @@ Please refer to the table below for currently defined variables :
| | %ac | actconn | | | | %ac | actconn | |
| | | %[act_conn] | numeric | | | | %[act_conn] | numeric |
+---+------+------------------------------------------------------+---------+ +---+------+------------------------------------------------------+---------+
| | %b | backend_name | string | | | %b | backend_name | |
| | | %[be_name] | string |
+---+------+------------------------------------------------------+---------+ +---+------+------------------------------------------------------+---------+
| | %bc | beconn (backend concurrent connections) | numeric | | | %bc | beconn (backend concurrent connections) | numeric |
+---+------+------------------------------------------------------+---------+ +---+------+------------------------------------------------------+---------+