Skip to content

Commit a14e0b3

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 40ef8ac commit a14e0b3

3 files changed

Lines changed: 68 additions & 21 deletions

File tree

‎docs/dev/configuration.html‎

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.2-dev16-30 - Configuration Manual</title>
5+
<title>HAProxy version 3.2-dev17 - Configuration Manual</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -4239,6 +4239,8 @@
42394239

42404240
<a class="list-group-item" href="#tune.fd.edge-triggered">tune.fd.edge-triggered</a>
42414241

4242+
<a class="list-group-item" href="#tune.glitches.kill.cpu-usage">tune.glitches.kill.cpu-usage</a>
4243+
42424244
<a class="list-group-item" href="#tune.h1.zero-copy-fwd-recv">tune.h1.zero-copy-fwd-recv</a>
42434245

42444246
<a class="list-group-item" href="#tune.h1.zero-copy-fwd-send">tune.h1.zero-copy-fwd-send</a>
@@ -4604,7 +4606,7 @@
46044606
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
46054607
</p>
46064608
<p class="text-right">
4607-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/05/20</b></small>
4609+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/05/21</b></small>
46084610
</p>
46094611
</div>
46104612
<!-- /.sidebar -->
@@ -4615,9 +4617,9 @@
46154617
<div class="text-center">
46164618
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
46174619
<h2>Configuration Manual</h2>
4618-
<p><strong>version 3.2-dev16-30</strong></p>
4620+
<p><strong>version 3.2-dev17</strong></p>
46194621
<p>
4620-
2025/05/14<br>
4622+
2025/05/21<br>
46214623

46224624
</p>
46234625
</div>
@@ -9441,6 +9443,23 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
94419443
reduce the number of epoll_ctl() calls and slightly improve performance in
94429444
certain scenarios. This is still experimental, it may result in frozen
94439445
connections if bugs are still present, and is disabled by default.
9446+
</pre><a class="anchor" name="tune.glitches.kill.cpu-usage"></a><a class="anchor" name="3-tune.glitches.kill.cpu-usage"></a><a class="anchor" name="3.2-tune.glitches.kill.cpu-usage"></a><a class="anchor" name="tune.glitches.kill.cpu-usage (Global section)"></a><a class="anchor" name="tune.glitches.kill.cpu-usage (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.glitches.kill.cpu-usage"></a><a href="#3.2-tune.glitches.kill.cpu-usage">tune.glitches.kill.cpu-usage</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the minimum CPU usage between 0 and 100, at which connections showing
9447+
too many glitches will be killed. This applies to connections that have
9448+
reached their glitches-threshold limit. In environments where very long
9449+
connections often behave badly without causing any performance impact, it
9450+
might be desirable to keep them regardless of their misbehavior as long as
9451+
they do not hurt, and to only start to kill such connections when the CPU is
9452+
getting busy. This parameters allows to specify that a connection reaching
9453+
its glitches threshold will be actively killed when the CPU usage is at this
9454+
level or above, but never when it's below. Note that the CPU usage is
9455+
measured per thread, so a single misbehaving connection might be killed. The
9456+
default is zero, meaning that a connection reaching its glitches-threshold
9457+
will automatically get killed. A rule of thumb would be to set this value to
9458+
twice the usually observed CPU usage, or the commonly observed CPU usage plus
9459+
half the idle one (i.e. if CPU commonly reaches 60%, setting 80 here can make
9460+
sense). This parameter has no effect without tune.h2.fe.glitches-threshold or
9461+
tune.quic.frontend.glitches-threshold. See also the global parameters
9462+
&quot;<a href="#tune.h2.fe.glitches-threshold">tune.h2.fe.glitches-threshold</a>&quot; and &quot;<a href="#tune.quic.frontend.glitches-threshold">tune.quic.frontend.glitches-threshold</a>&quot;.
94449463
</pre><a class="anchor" name="tune.h1.zero-copy-fwd-recv"></a><a class="anchor" name="3-tune.h1.zero-copy-fwd-recv"></a><a class="anchor" name="3.2-tune.h1.zero-copy-fwd-recv"></a><a class="anchor" name="tune.h1.zero-copy-fwd-recv (Global section)"></a><a class="anchor" name="tune.h1.zero-copy-fwd-recv (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.h1.zero-copy-fwd-recv"></a><a href="#3.2-tune.h1.zero-copy-fwd-recv">tune.h1.zero-copy-fwd-recv</a></b> <span style="color: #800">{ on | off }</span></div><pre class="text">Enables ('on') of disabled ('off') the zero-copy receives of data for the H1
94459464
multiplexer. It is enabled by default.
94469465
</pre><div class="page-header"><b>See also:</b> tune.disable-zero-copy-forwarding, tune.h1.zero-copy-fwd-send</div>
@@ -9454,8 +9473,10 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
94549473
event will cause a connection to be closed. Beware that some H2 servers may
94559474
occasionally cause a few glitches over long lasting connection, so any non-
94569475
zero value here should probably be in the hundreds or thousands to be
9457-
effective without affecting slightly bogus servers.
9458-
</pre><div class="page-header"><b>See also:</b> tune.h2.fe.glitches-threshold, bc_glitches</div>
9476+
effective without affecting slightly bogus servers. It is also possible to
9477+
only kill connections when the CPU usage crosses a certain level, by using
9478+
&quot;<a href="#tune.glitches.kill.cpu-usage">tune.glitches.kill.cpu-usage</a>&quot;.
9479+
</pre><div class="page-header"><b>See also:</b> tune.h2.fe.glitches-threshold, bc_glitches, and tune.glitches.kill.cpu-usage</div>
94599480
<a class="anchor" name="tune.h2.be.initial-window-size"></a><a class="anchor" name="3-tune.h2.be.initial-window-size"></a><a class="anchor" name="3.2-tune.h2.be.initial-window-size"></a><a class="anchor" name="tune.h2.be.initial-window-size (Global section)"></a><a class="anchor" name="tune.h2.be.initial-window-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.h2.be.initial-window-size"></a><a href="#3.2-tune.h2.be.initial-window-size">tune.h2.be.initial-window-size</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the HTTP/2 initial window size for outgoing connections, which is the
94609481
number of bytes the server can respond before waiting for an acknowledgment
94619482
from HAProxy. This setting only affects payload contents, not headers. When
@@ -9497,8 +9518,10 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
94979518
event will cause a connection to be closed. Beware that some H2 clientss may
94989519
occasionally cause a few glitches over long lasting connection, so any non-
94999520
zero value here should probably be in the hundreds or thousands to be
9500-
effective without affecting slightly bogus clients.
9501-
</pre><div class="page-header"><b>See also:</b> tune.h2.be.glitches-threshold, fc_glitches</div>
9521+
effective without affecting slightly bogus clients. It is also possible to
9522+
only kill connections when the CPU usage crosses a certain level, by using
9523+
&quot;<a href="#tune.glitches.kill.cpu-usage">tune.glitches.kill.cpu-usage</a>&quot;.
9524+
</pre><div class="page-header"><b>See also:</b> tune.h2.be.glitches-threshold, fc_glitches, and tune.glitches.kill.cpu-usage</div>
95029525
<a class="anchor" name="tune.h2.fe.initial-window-size"></a><a class="anchor" name="3-tune.h2.fe.initial-window-size"></a><a class="anchor" name="3.2-tune.h2.fe.initial-window-size"></a><a class="anchor" name="tune.h2.fe.initial-window-size (Global section)"></a><a class="anchor" name="tune.h2.fe.initial-window-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.h2.fe.initial-window-size"></a><a href="#3.2-tune.h2.fe.initial-window-size">tune.h2.fe.initial-window-size</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the HTTP/2 initial window size for incoming connections, which is the
95039526
number of bytes the client can upload before waiting for an acknowledgment
95049527
from HAProxy. This setting only affects payload contents (i.e. the body of
@@ -9977,8 +10000,10 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
997710000
event will cause a connection to be closed. Beware that some QUIC clients may
997810001
occasionally cause a few glitches over long lasting connection, so any non-
997910002
zero value here should probably be in the hundreds or thousands to be
9980-
effective without affecting slightly bogus clients.
9981-
</pre><div class="page-header"><b>See also:</b> fc_glitches</div>
10003+
effective without affecting slightly bogus clients. It is also possible to
10004+
only kill connections when the CPU usage crosses a certain level, by using
10005+
&quot;<a href="#tune.glitches.kill.cpu-usage">tune.glitches.kill.cpu-usage</a>&quot;.
10006+
</pre><div class="page-header"><b>See also:</b> fc_glitches, tune.glitches.kill.cpu-usage</div>
998210007
<a class="anchor" name="tune.quic.frontend.max-data-size"></a><a class="anchor" name="3-tune.quic.frontend.max-data-size"></a><a class="anchor" name="3.2-tune.quic.frontend.max-data-size"></a><a class="anchor" name="tune.quic.frontend.max-data-size (Global section)"></a><a class="anchor" name="tune.quic.frontend.max-data-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.quic.frontend.max-data-size"></a><a href="#3.2-tune.quic.frontend.max-data-size">tune.quic.frontend.max-data-size</a></b> <span style="color: #080">&lt;size&gt;</span></div><pre class="text">This setting is the hard limit for the number of data bytes in flight over a
998310008
QUIC frontend connection. It is reused as the value for the initial_max_data
998410009
transport parameter. It directly impacts the upload bandwidth for the peer
@@ -32962,8 +32987,8 @@ <h2 id="chapter-12.9" data-target="12.9"><small><a class="small" href="#12.9">12
3296232987
<br>
3296332988
<hr>
3296432989
<div class="text-right">
32965-
HAProxy 3.2-dev16-30 &ndash; Configuration Manual<br>
32966-
<small>, 2025/05/14</small>
32990+
HAProxy 3.2-dev17 &ndash; Configuration Manual<br>
32991+
<small>, 2025/05/21</small>
3296732992
</div>
3296832993
</div>
3296932994
<!-- /.col-lg-12 -->

‎docs/dev/intro.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.2-dev16-30 - Starter Guide</title>
5+
<title>HAProxy version 3.2-dev17 - Starter Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -484,7 +484,7 @@
484484
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
485485
</p>
486486
<p class="text-right">
487-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/05/20</b></small>
487+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/05/21</b></small>
488488
</p>
489489
</div>
490490
<!-- /.sidebar -->
@@ -495,7 +495,7 @@
495495
<div class="text-center">
496496
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
497497
<h2>Starter Guide</h2>
498-
<p><strong>version 3.2-dev16-30</strong></p>
498+
<p><strong>version 3.2-dev17</strong></p>
499499
<p>
500500
<br>
501501

@@ -2515,7 +2515,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
25152515
<br>
25162516
<hr>
25172517
<div class="text-right">
2518-
HAProxy 3.2-dev16-30 &ndash; Starter Guide<br>
2518+
HAProxy 3.2-dev17 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

‎docs/dev/management.html‎

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.2-dev16-30 - Management Guide</title>
5+
<title>HAProxy version 3.2-dev17 - Management Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -660,7 +660,7 @@
660660
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
661661
</p>
662662
<p class="text-right">
663-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/05/20</b></small>
663+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/05/21</b></small>
664664
</p>
665665
</div>
666666
<!-- /.sidebar -->
@@ -671,7 +671,7 @@
671671
<div class="text-center">
672672
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
673673
<h2>Management Guide</h2>
674-
<p><strong>version 3.2-dev16-30</strong></p>
674+
<p><strong>version 3.2-dev17</strong></p>
675675
<p>
676676
<br>
677677

@@ -3918,7 +3918,29 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
39183918
The output consists in a header line showing the fields titles, then one
39193919
server per line with for each, the backend name and ID, server name and ID,
39203920
the address, port and a series or values. The number of fields varies
3921-
depending on thread count.
3921+
depending on thread count. The exact format of the output may vary slightly
3922+
across versions and depending on the number of threads. One needs to pay
3923+
attention to the header line to match columns when extracting output values,
3924+
and to the number of threads as the last columns are per-thread:
3925+
3926+
bkname/svname Backend name '/' server name
3927+
bkid/svid Backend ID '/' server ID
3928+
addr Server's IP address
3929+
port Server's port (or zero if none)
3930+
- Unused field, serves as a visual delimiter
3931+
purge_delay Interval between connection purges, in milliseconds
3932+
used_cur Number of connections currently in use
3933+
used_max Highest value of used_cur since the process started
3934+
need_est Floating estimate of total needed connections
3935+
unsafe_nb Number of idle connections considered as &quot;unsafe&quot;
3936+
safe_nb Number of idle connections considered as &quot;safe&quot;
3937+
idle_lim Configured maximum number of idle connections
3938+
idle_cur Total of the per-thread currently idle connections
3939+
idle_per_thr[NB] Idle conns per thread for each one of the NB threads
3940+
3941+
HAProxy will kill a portion of &lt;idle_cur&gt; every &lt;purge_delay&gt; when the total
3942+
of &lt;idle_cur&gt; + &lt;used_cur&gt; exceeds the estimate &lt;need_est&gt;. This estimate
3943+
varies based on connection activity.
39223944

39233945
Given the threaded nature of idle connections, it's important to understand
39243946
that some values may change once read, and that as such, consistency within a
@@ -5606,7 +5628,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
56065628
<br>
56075629
<hr>
56085630
<div class="text-right">
5609-
HAProxy 3.2-dev16-30 &ndash; Management Guide<br>
5631+
HAProxy 3.2-dev17 &ndash; Management Guide<br>
56105632
<small>, </small>
56115633
</div>
56125634
</div>

0 commit comments

Comments
 (0)