Skip to content

Commit e68c685

Browse files
committed
DOC: config: Move fs.* and bs.* in section about L5 samples
These sample fetch functions were added in the wrong section. Move them in the section about sample fetch functions at L5 layer.
1 parent 4ccc3f4 commit e68c685

File tree

1 file changed

+81
-81
lines changed

1 file changed

+81
-81
lines changed

doc/configuration.txt

Lines changed: 81 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -23708,6 +23708,14 @@ Summary of sample fetch methods in this section and their respective types:
2370823708
keyword output type
2370923709
-------------------------------------------------+-------------
2371023710
51d.all(<prop>[,<prop>*]) string
23711+
bs.aborted boolean
23712+
bs.debug_str([<bitmap>]) string
23713+
bs.id integer
23714+
bs.rst_code integer
23715+
fs.aborted boolean
23716+
fs.debug_str([<bitmap>]) string
23717+
fs.id integer
23718+
fs.rst_code integer
2371123719
ssl_bc boolean
2371223720
ssl_bc_alg_keysize integer
2371323721
ssl_bc_alpn string
@@ -23829,12 +23837,85 @@ Detailed list:
2382923837
http-request set-header X-51D-DeviceTypeMobileTablet \
2383023838
%[51d.all(DeviceType,IsMobile,IsTablet)]
2383123839

23840+
bs.aborted : boolean
23841+
Returns true is an abort was received from the server for the current
23842+
stream. Otherwise false is returned.
23843+
23844+
bs.debug_str([<bitmap>]) : string
23845+
This function is meant to be used by developers during certain complex
23846+
troubleshooting sessions. It extracts some internal states from the lower
23847+
layers of the backend stream and connection, and arranges them as a string,
23848+
generally in the form of a series of "name=value" delimited with spaces. The
23849+
<bitmap> optional argument indicates what layer(s) to extract information
23850+
from, and is an arithmetic OR (or a sum) of the following values:
23851+
- socket layer: 16
23852+
- connection layer: 8
23853+
- transport layer (e.g. SSL): 4
23854+
- mux connection: 2
23855+
- mux stream: 1
23856+
23857+
These values might change across versions. The default value of zero is
23858+
special and enables all layers. Please do not rely on the output of this
23859+
function for long-term production monitoring. It is meant to evolve even
23860+
within a stable branch, as the needs for increased details arise. One use
23861+
typical use case is to concatenate these information at the very end of a
23862+
log-format, along with fs.debug_str(). Example:
23863+
23864+
log-format "$HAPROXY_HTTP_LOG_FMT fs=<%[fs.debug_str]> bs=<%[bs.debug_str]>"
23865+
23866+
bs.id : integer
23867+
Returns the multiplexer's stream ID on the server side. It is the
23868+
multiplexer's responsibility to return the appropriate information.
23869+
23870+
bs.rst_code : integer
23871+
Returns the reset code received from the server for the current stream. The
23872+
code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
23873+
the server is returned. The sample fetch fails if no abort was received or if
23874+
the server stream is not an H2/QUIC stream.
23875+
2383223876
ssl_bc : boolean
2383323877
Returns true when the back connection was made via an SSL/TLS transport
2383423878
layer and is locally deciphered. This means the outgoing connection was made
2383523879
to a server with the "ssl" option. It can be used in a tcp-check or an
2383623880
http-check ruleset.
2383723881

23882+
fs.aborted : boolean
23883+
Returns true is an abort was received from the client for the current
23884+
stream. Otherwise false is returned.
23885+
23886+
fs.debug_str([<bitmap>]) : string
23887+
This function is meant to be used by developers during certain complex
23888+
troubleshooting sessions. It extracts some internal states from the lower
23889+
layers of the frontend stream and connection, and arranges them as a string,
23890+
generally in the form of a series of "name=value" delimited with spaces. The
23891+
<bitmap> optional argument indicates what layer(s) to extract information
23892+
from, and is an arithmetic OR (or a sum) of the following values:
23893+
- socket layer: 16
23894+
- connection layer: 8
23895+
- transport layer (e.g. SSL): 4
23896+
- mux connection: 2
23897+
- mux stream: 1
23898+
23899+
These values might change across versions. The default value of zero is
23900+
special and enables all layers. Please do not rely on the output of this
23901+
function for long-term production monitoring. It is meant to evolve even
23902+
within a stable branch, as the needs for increased details arise. One use
23903+
typical use case is to concatenate these information at the very end of a
23904+
log-format, along with bs.debug_str(). Example:
23905+
23906+
log-format "$HAPROXY_HTTP_LOG_FMT fs=<%[fs.debug_str]> bs=<%[bs.debug_str]>"
23907+
23908+
fs.id : integer
23909+
Returns the multiplexer's stream ID on the client side. It is the
23910+
multiplexer's responsibility to return the appropriate information. For
23911+
instance, on a raw TCP, 0 is always returned because there is no stream.
23912+
23913+
fs.rst_code : integer
23914+
Returns the reset code received from the client for the current stream. The
23915+
code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
23916+
the client is returned. The sample fetch fails if no abort was received or
23917+
if the client stream is not an H2/QUIC stream.
23918+
2383823919
ssl_bc_alg_keysize : integer
2383923920
Returns the symmetric cipher key size supported in bits when the outgoing
2384023921
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:
2467024751

2467124752
keyword output type
2467224753
----------------------------------------------------+-------------
24673-
bs.aborted boolean
24674-
bs.debug_str([<bitmap>]) string
24675-
bs.id integer
24676-
bs.rst_code integer
2467724754
distcc_body(<token>[,<occ>]) binary
2467824755
distcc_param(<token>[,<occ>]) integer
24679-
fs.aborted boolean
24680-
fs.debug_str([<bitmap>]) string
24681-
fs.id integer
24682-
fs.rst_code integer
2468324756
payload(<offset>,<length>) binary
2468424757
payload_lv(<offset1>,<length>[,<offset2>]) binary
2468524758
req.len integer
@@ -24710,42 +24783,6 @@ rep_ssl_hello_type integer
2471024783

2471124784
Detailed list:
2471224785

24713-
bs.aborted : boolean
24714-
Returns true is an abort was received from the server for the current
24715-
stream. Otherwise false is returned.
24716-
24717-
bs.debug_str([<bitmap>]) : string
24718-
This function is meant to be used by developers during certain complex
24719-
troubleshooting sessions. It extracts some internal states from the lower
24720-
layers of the backend stream and connection, and arranges them as a string,
24721-
generally in the form of a series of "name=value" delimited with spaces. The
24722-
<bitmap> optional argument indicates what layer(s) to extract information
24723-
from, and is an arithmetic OR (or a sum) of the following values:
24724-
- socket layer: 16
24725-
- connection layer: 8
24726-
- transport layer (e.g. SSL): 4
24727-
- mux connection: 2
24728-
- mux stream: 1
24729-
24730-
These values might change across versions. The default value of zero is
24731-
special and enables all layers. Please do not rely on the output of this
24732-
function for long-term production monitoring. It is meant to evolve even
24733-
within a stable branch, as the needs for increased details arise. One use
24734-
typical use case is to concatenate these information at the very end of a
24735-
log-format, along with fs.debug_str(). Example:
24736-
24737-
log-format "$HAPROXY_HTTP_LOG_FMT fs=<%[fs.debug_str]> bs=<%[bs.debug_str]>"
24738-
24739-
bs.id : integer
24740-
Returns the multiplexer's stream ID on the server side. It is the
24741-
multiplexer's responsibility to return the appropriate information.
24742-
24743-
bs.rst_code : integer
24744-
Returns the reset code received from the server for the current stream. The
24745-
code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
24746-
the server is returned. The sample fetch fails if no abort was received or if
24747-
the server stream is not an H2/QUIC stream.
24748-
2474924786
distcc_body(<token>[,<occ>]) : binary
2475024787
Parses a distcc message and returns the body associated to occurrence #<occ>
2475124788
of the token <token>. Occurrences start at 1, and when unspecified, any may
@@ -24772,43 +24809,6 @@ distcc_param(<token>[,<occ>]) : integer
2477224809
# send large files to the big farm
2477324810
use_backend big_farm if { distcc_param(DOTI) gt 1000000 }
2477424811

24775-
fs.aborted : boolean
24776-
Returns true is an abort was received from the client for the current
24777-
stream. Otherwise false is returned.
24778-
24779-
fs.debug_str([<bitmap>]) : string
24780-
This function is meant to be used by developers during certain complex
24781-
troubleshooting sessions. It extracts some internal states from the lower
24782-
layers of the frontend stream and connection, and arranges them as a string,
24783-
generally in the form of a series of "name=value" delimited with spaces. The
24784-
<bitmap> optional argument indicates what layer(s) to extract information
24785-
from, and is an arithmetic OR (or a sum) of the following values:
24786-
- socket layer: 16
24787-
- connection layer: 8
24788-
- transport layer (e.g. SSL): 4
24789-
- mux connection: 2
24790-
- mux stream: 1
24791-
24792-
These values might change across versions. The default value of zero is
24793-
special and enables all layers. Please do not rely on the output of this
24794-
function for long-term production monitoring. It is meant to evolve even
24795-
within a stable branch, as the needs for increased details arise. One use
24796-
typical use case is to concatenate these information at the very end of a
24797-
log-format, along with bs.debug_str(). Example:
24798-
24799-
log-format "$HAPROXY_HTTP_LOG_FMT fs=<%[fs.debug_str]> bs=<%[bs.debug_str]>"
24800-
24801-
fs.id : integer
24802-
Returns the multiplexer's stream ID on the client side. It is the
24803-
multiplexer's responsibility to return the appropriate information. For
24804-
instance, on a raw TCP, 0 is always returned because there is no stream.
24805-
24806-
fs.rst_code : integer
24807-
Returns the reset code received from the client for the current stream. The
24808-
code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
24809-
the client is returned. The sample fetch fails if no abort was received or
24810-
if the client stream is not an H2/QUIC stream.
24811-
2481224812
payload(<offset>,<length>) : binary (deprecated)
2481324813
This is an alias for "req.payload" when used in the context of a request (e.g.
2481424814
"stick on", "stick match"), and for "res.payload" when used in the context of

0 commit comments

Comments
 (0)