DOC: config: mention in bytes_in and bytes_out that they're read on input

Issue #2267 suggests that it's unclear what exactly the byte counts mean
(particularly when compression is involved). Let's clarify that the counts
are read on data input and that they also cover headers and a bit of
internal overhead.
This commit is contained in:
Willy Tarreau 2025-05-26 15:51:14 +02:00
parent e70c23e517
commit ef9511be90

View File

@ -22751,10 +22751,16 @@ be_tunnel_timeout : integer
also the "cur_tunnel_timeout".
bytes_in : integer
This returns the number of bytes uploaded from the client to the server.
This returns the number of bytes uploaded from the client to the server. The
value corresponds to what was received by HAProxy, including some headers and
some internal encoding overhead. Request compression does not affect the
value reported here.
bytes_out : integer
This is the number of bytes transmitted from the server to the client.
This is the number of bytes transmitted from the server to the client. The
value corresponds to what was received by HAProxy, including some headers and
some internal encoding overhead. Response compression does not affect the
value reported here.
cur_client_timeout : integer
Returns the currently applied client timeout in millisecond for the stream.
@ -29090,7 +29096,8 @@ Arguments:
integer which counts the cumulative number of bytes received from
clients which matched this entry. Headers are included in the
count. This may be used to limit abuse of upload features on photo
or video servers.
or video servers. Note that the values are measured when the data
enter haproxy, thus the counts are not affected by compression.
- bytes_in_rate(<period>) [12 bytes]
This is a rate counter on bytes from the client to the server.
@ -29110,7 +29117,8 @@ Arguments:
integer which counts the cumulative number of bytes sent to
clients which matched this entry. Headers are included in the
count. This may be used to limit abuse of bots sucking the whole
site.
site. Note that the values are measured when the data enter
haproxy, thus the counts are not affected by compression.
- bytes_out_rate(<period>) [12 bytes]
This is a rate counter on bytes from the server to the client.