diff --git a/doc/configuration.txt b/doc/configuration.txt index 197d05968..1b33be7f2 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -23708,6 +23708,14 @@ Summary of sample fetch methods in this section and their respective types: keyword output type -------------------------------------------------+------------- 51d.all([,*]) string +bs.aborted boolean +bs.debug_str([]) string +bs.id integer +bs.rst_code integer +fs.aborted boolean +fs.debug_str([]) string +fs.id integer +fs.rst_code integer ssl_bc boolean ssl_bc_alg_keysize integer ssl_bc_alpn string @@ -23829,12 +23837,85 @@ Detailed list: http-request set-header X-51D-DeviceTypeMobileTablet \ %[51d.all(DeviceType,IsMobile,IsTablet)] +bs.aborted : boolean + Returns true is an abort was received from the server for the current + stream. Otherwise false is returned. + +bs.debug_str([]) : string + This function is meant to be used by developers during certain complex + troubleshooting sessions. It extracts some internal states from the lower + layers of the backend stream and connection, and arranges them as a string, + generally in the form of a series of "name=value" delimited with spaces. The + optional argument indicates what layer(s) to extract information + from, and is an arithmetic OR (or a sum) of the following values: + - socket layer: 16 + - connection layer: 8 + - transport layer (e.g. SSL): 4 + - mux connection: 2 + - mux stream: 1 + + These values might change across versions. The default value of zero is + special and enables all layers. Please do not rely on the output of this + function for long-term production monitoring. It is meant to evolve even + within a stable branch, as the needs for increased details arise. One use + typical use case is to concatenate these information at the very end of a + log-format, along with fs.debug_str(). Example: + + log-format "$HAPROXY_HTTP_LOG_FMT fs=<%[fs.debug_str]> bs=<%[bs.debug_str]>" + +bs.id : integer + Returns the multiplexer's stream ID on the server side. It is the + multiplexer's responsibility to return the appropriate information. + +bs.rst_code : integer + Returns the reset code received from the server for the current stream. The + code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from + the server is returned. The sample fetch fails if no abort was received or if + the server stream is not an H2/QUIC stream. + ssl_bc : boolean Returns true when the back connection was made via an SSL/TLS transport layer and is locally deciphered. This means the outgoing connection was made to a server with the "ssl" option. It can be used in a tcp-check or an http-check ruleset. +fs.aborted : boolean + Returns true is an abort was received from the client for the current + stream. Otherwise false is returned. + +fs.debug_str([]) : string + This function is meant to be used by developers during certain complex + troubleshooting sessions. It extracts some internal states from the lower + layers of the frontend stream and connection, and arranges them as a string, + generally in the form of a series of "name=value" delimited with spaces. The + optional argument indicates what layer(s) to extract information + from, and is an arithmetic OR (or a sum) of the following values: + - socket layer: 16 + - connection layer: 8 + - transport layer (e.g. SSL): 4 + - mux connection: 2 + - mux stream: 1 + + These values might change across versions. The default value of zero is + special and enables all layers. Please do not rely on the output of this + function for long-term production monitoring. It is meant to evolve even + within a stable branch, as the needs for increased details arise. One use + typical use case is to concatenate these information at the very end of a + log-format, along with bs.debug_str(). Example: + + log-format "$HAPROXY_HTTP_LOG_FMT fs=<%[fs.debug_str]> bs=<%[bs.debug_str]>" + +fs.id : integer + Returns the multiplexer's stream ID on the client side. It is the + multiplexer's responsibility to return the appropriate information. For + instance, on a raw TCP, 0 is always returned because there is no stream. + +fs.rst_code : integer + Returns the reset code received from the client for the current stream. The + code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from + the client is returned. The sample fetch fails if no abort was received or + if the client stream is not an H2/QUIC stream. + ssl_bc_alg_keysize : integer Returns the symmetric cipher key size supported in bits when the outgoing connection was made over an SSL/TLS transport layer. It can be used in a @@ -24670,16 +24751,8 @@ Summary of sample fetch methods in this section and their respective types: keyword output type ----------------------------------------------------+------------- -bs.aborted boolean -bs.debug_str([]) string -bs.id integer -bs.rst_code integer distcc_body([,]) binary distcc_param([,]) integer -fs.aborted boolean -fs.debug_str([]) string -fs.id integer -fs.rst_code integer payload(,) binary payload_lv(,[,]) binary req.len integer @@ -24710,42 +24783,6 @@ rep_ssl_hello_type integer Detailed list: -bs.aborted : boolean - Returns true is an abort was received from the server for the current - stream. Otherwise false is returned. - -bs.debug_str([]) : string - This function is meant to be used by developers during certain complex - troubleshooting sessions. It extracts some internal states from the lower - layers of the backend stream and connection, and arranges them as a string, - generally in the form of a series of "name=value" delimited with spaces. The - optional argument indicates what layer(s) to extract information - from, and is an arithmetic OR (or a sum) of the following values: - - socket layer: 16 - - connection layer: 8 - - transport layer (e.g. SSL): 4 - - mux connection: 2 - - mux stream: 1 - - These values might change across versions. The default value of zero is - special and enables all layers. Please do not rely on the output of this - function for long-term production monitoring. It is meant to evolve even - within a stable branch, as the needs for increased details arise. One use - typical use case is to concatenate these information at the very end of a - log-format, along with fs.debug_str(). Example: - - log-format "$HAPROXY_HTTP_LOG_FMT fs=<%[fs.debug_str]> bs=<%[bs.debug_str]>" - -bs.id : integer - Returns the multiplexer's stream ID on the server side. It is the - multiplexer's responsibility to return the appropriate information. - -bs.rst_code : integer - Returns the reset code received from the server for the current stream. The - code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from - the server is returned. The sample fetch fails if no abort was received or if - the server stream is not an H2/QUIC stream. - distcc_body([,]) : binary Parses a distcc message and returns the body associated to occurrence # of the token . Occurrences start at 1, and when unspecified, any may @@ -24772,43 +24809,6 @@ distcc_param([,]) : integer # send large files to the big farm use_backend big_farm if { distcc_param(DOTI) gt 1000000 } -fs.aborted : boolean - Returns true is an abort was received from the client for the current - stream. Otherwise false is returned. - -fs.debug_str([]) : string - This function is meant to be used by developers during certain complex - troubleshooting sessions. It extracts some internal states from the lower - layers of the frontend stream and connection, and arranges them as a string, - generally in the form of a series of "name=value" delimited with spaces. The - optional argument indicates what layer(s) to extract information - from, and is an arithmetic OR (or a sum) of the following values: - - socket layer: 16 - - connection layer: 8 - - transport layer (e.g. SSL): 4 - - mux connection: 2 - - mux stream: 1 - - These values might change across versions. The default value of zero is - special and enables all layers. Please do not rely on the output of this - function for long-term production monitoring. It is meant to evolve even - within a stable branch, as the needs for increased details arise. One use - typical use case is to concatenate these information at the very end of a - log-format, along with bs.debug_str(). Example: - - log-format "$HAPROXY_HTTP_LOG_FMT fs=<%[fs.debug_str]> bs=<%[bs.debug_str]>" - -fs.id : integer - Returns the multiplexer's stream ID on the client side. It is the - multiplexer's responsibility to return the appropriate information. For - instance, on a raw TCP, 0 is always returned because there is no stream. - -fs.rst_code : integer - Returns the reset code received from the client for the current stream. The - code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from - the client is returned. The sample fetch fails if no abort was received or - if the client stream is not an H2/QUIC stream. - payload(,) : binary (deprecated) This is an alias for "req.payload" when used in the context of a request (e.g. "stick on", "stick match"), and for "res.payload" when used in the context of