Skip to content

Commit c9f646f

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent d029e6c commit c9f646f

File tree

3 files changed

+238
-167
lines changed

3 files changed

+238
-167
lines changed

docs/dev/configuration.html

Lines changed: 80 additions & 23 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.1-dev8-59 - Configuration Manual</title>
5+
<title>HAProxy version 3.1-dev8-67 - 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" />
@@ -303,6 +303,19 @@
303303

304304

305305

306+
<tr>
307+
<td><small>3.3.1.</small></td>
308+
<td>
309+
<div class="tab">
310+
<div class="tab">
311+
<a href="#3.3.1">Traces</a>
312+
</div>
313+
</div>
314+
<td>
315+
</tr>
316+
317+
318+
306319
<tr>
307320
<td><small>3.4.</small></td>
308321
<td>
@@ -4008,6 +4021,8 @@
40084021

40094022
<a class="list-group-item" href="#trace">trace</a>
40104023

4024+
<a class="list-group-item" href="#traces">traces</a>
4025+
40114026
<a class="list-group-item" href="#track">track</a>
40124027

40134028
<a class="list-group-item" href="#track-sc0">track-sc0</a>
@@ -4373,7 +4388,7 @@
43734388
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
43744389
</p>
43754390
<p class="text-right">
4376-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/09/30</b></small>
4391+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/02</b></small>
43774392
</p>
43784393
</div>
43794394
<!-- /.sidebar -->
@@ -4384,7 +4399,7 @@
43844399
<div class="text-center">
43854400
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
43864401
<h2>Configuration Manual</h2>
4387-
<p><strong>version 3.1-dev8-59</strong></p>
4402+
<p><strong>version 3.1-dev8-67</strong></p>
43884403
<p>
43894404
2024/09/18<br>
43904405

@@ -4672,6 +4687,19 @@ <h1 id="chapter-summary" data-target="summary">Summary</h1>
46724687

46734688

46744689

4690+
<tr>
4691+
<td><small>3.3.1.</small></td>
4692+
<td>
4693+
<div class="tab">
4694+
<div class="tab">
4695+
<a href="#3.3.1">Traces</a>
4696+
</div>
4697+
</div>
4698+
<td>
4699+
</tr>
4700+
4701+
4702+
46754703
<tr>
46764704
<td><small>3.4.</small></td>
46774705
<td>
@@ -8164,23 +8192,6 @@ <h2 id="chapter-3.1" data-target="3.1"><small><a class="small" href="#3.1">3.1.<
81648192
values. If &quot;<a href="#nbthread">nbthread</a>&quot; is forced to a higher value, thread-hard-limit wins,
81658193
and a warning is emitted in so that the configuration anomaly can be
81668194
fixed. By default there is no limit. See also &quot;<a href="#nbthread">nbthread</a>&quot;.
8167-
</pre><a class="anchor" name="trace"></a><a class="anchor" name="3-trace"></a><a class="anchor" name="3.1-trace"></a><a class="anchor" name="trace (Global parameters)"></a><a class="anchor" name="trace (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="trace"></a><a href="#3.1-trace">trace</a></b> <span style="color: #080">&lt;args...&gt;</span></div><pre class="text">This command configures one &quot;<a href="#trace">trace</a>&quot; subsystem statement. Each of them can be
8168-
found in the management manual, and follow the exact same syntax. Only one
8169-
statement per line is permitted (i.e. if some long trace configurations using
8170-
semi-colons are to be imported, they must be placed one per line). Any output
8171-
that the &quot;<a href="#trace">trace</a>&quot; command would produce will be emitted during the parsing
8172-
step of the section. Most of the time these will be errors and warnings, but
8173-
certain incomplete commands might list permissible choices. This command is
8174-
not meant for regular use, it will generally only be suggested by developers
8175-
along complex debugging sessions. For this reason it is internally marked as
8176-
experimental, meaning that &quot;<a href="#expose-experimental-directives">expose-experimental-directives</a>&quot; must appear on a
8177-
line before any &quot;<a href="#trace">trace</a>&quot; statement. Note that these directives are parsed on
8178-
the fly, so referencing a ring buffer that is only declared further will not
8179-
work. For such use cases it is suggested to place another &quot;global&quot; section
8180-
with only the &quot;<a href="#trace">trace</a>&quot; statements after the declaration of that ring. It is
8181-
important to keep in mind that depending on the trace level and details,
8182-
enabling traces can severely degrade the global performance. Please refer to
8183-
the management manual for the statements syntax.
81848195
</pre><a class="anchor" name="uid"></a><a class="anchor" name="3-uid"></a><a class="anchor" name="3.1-uid"></a><a class="anchor" name="uid (Global parameters)"></a><a class="anchor" name="uid (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="uid"></a><a href="#3.1-uid">uid</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Changes the process's user ID to &lt;number&gt;. It is recommended that the user ID
81858196
is dedicated to HAProxy or to a small set of similar daemons. HAProxy must
81868197
be started with superuser privileges in order to be able to switch to another
@@ -9337,6 +9348,49 @@ <h2 id="chapter-3.3" data-target="3.3"><small><a class="small" href="#3.3">3.3.<
93379348
report errors in such a case. This option is equivalent to command line
93389349
argument &quot;-dW&quot;.
93399350
</pre></div>
9351+
<a class="anchor" id="3.3.1" name="3.3.1"></a>
9352+
<h3 id="chapter-3.3.1" data-target="3.3.1"><small><a class="small" href="#3.3.1">3.3.1.</a></small> Traces</h3>
9353+
<div><pre class="text">For debugging purpose, it is possible to activate traces on an HAProxy's
9354+
subsystem. This will dump debug messages about a specific subsystem. It is a
9355+
very powerful tool to diagnose issues. Traces can be dynamically configured via
9356+
the CLI. It is also possible to predefined some settings in the configuration
9357+
file, in dedicated &quot;<a href="#traces">traces</a>&quot; sections. More details about traces can be found in
9358+
the management guide. It remains a developper tools used during complex
9359+
debugging sessions. It is pretty verbose and have a cost, so use it with
9360+
caution. And because it is a developper tool, there is no warranty about the
9361+
backward compatibility of this section.
9362+
</pre><a class="anchor" name="traces"></a><a class="anchor" name="3-traces"></a><a class="anchor" name="3.3.1-traces"></a><a class="anchor" name="traces (Global parameters)"></a><a class="anchor" name="traces (Traces)"></a><div class="keyword"><b><a class="anchor" name="traces"></a><a href="#3.3.1-traces">traces</a></b></div><pre class="text">Starts a new traces section. One or multiple &quot;<a href="#traces">traces</a>&quot; section may be
9363+
used. All direcitives are evaluated in the declararion order, the last ones
9364+
overriding previous ones.
9365+
</pre><a class="anchor" name="trace"></a><a class="anchor" name="3-trace"></a><a class="anchor" name="3.3.1-trace"></a><a class="anchor" name="trace (Global parameters)"></a><a class="anchor" name="trace (Traces)"></a><div class="keyword"><b><a class="anchor" name="trace"></a><a href="#3.3.1-trace">trace</a></b> <span style="color: #080">&lt;source&gt;</span> <span style="color: #080">&lt;args...&gt;</span></div><pre class="text">Configures on &quot;<a href="#trace">trace</a>&quot; subsystem. Each of them can be found in the management
9366+
manual, and follow the exact same syntax. Any output that the &quot;<a href="#trace">trace</a>&quot;
9367+
command would produce will be emitted during the parsing step of the
9368+
section. Most of the time these will be errors and warnings, but certain
9369+
incomplete commands might list permissible choices. This command is not meant
9370+
for regular use, it will generally only be suggested by developers along
9371+
complex debugging sessions. Note that these directives are parsed on the fly,
9372+
so referencing a ring buffer that is only declared further will not work. It
9373+
is important to keep in mind that depending on the trace level and details,
9374+
enabling traces can severely degrade the global performance. Please refer to
9375+
the management manual for the statements syntax.
9376+
</pre><div class="separator">
9377+
<span class="label label-success">Example:</span>
9378+
<pre class="prettyprint">
9379+
<code>ring buf1
9380+
size 10485760 <span class="comment"># 10MB</span>
9381+
format timed
9382+
backing-file /tmp/h1.traces
9383+
9384+
ring buf2
9385+
size 10485760 <span class="comment"># 10MB</span>
9386+
format timed
9387+
backing-file /tmp/h2.traces
9388+
9389+
traces
9390+
trace h1 sink buf1 level developer verbosity complete start now
9391+
trace h2 sink buf1 level developer verbosity complete start now
9392+
</code></pre>
9393+
</div></div>
93409394
<a class="anchor" id="3.4" name="3.4"></a>
93419395
<h2 id="chapter-3.4" data-target="3.4"><small><a class="small" href="#3.4">3.4.</a></small> Userlists</h2>
93429396
<div><pre class="text">It is possible to control access to frontend/backend/listen sections or to
@@ -14388,7 +14442,7 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1438814442

1438914443
This option should normally never be used, except in front of a proxy.
1439014444
</pre><div class="page-header"><b>See also :</b> &quot;<a href="#option%20httpclose">option httpclose</a>&quot;, and &quot;<a href="#option%20http-server-close">option http-server-close</a>&quot;.</div>
14391-
<a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b></div><a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b> <span style="color: #080">&lt;uri&gt;</span></div><a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b> <span style="color: #080">&lt;method&gt;</span> <span style="color: #080">&lt;uri&gt;</span></div><a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b> <span style="color: #080">&lt;method&gt;</span> <span style="color: #080">&lt;uri&gt;</span> <span style="color: #080">&lt;version&gt;</span></div><pre class="text">Enables HTTP protocol to check on the servers health
14445+
<a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b></div><a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b> <span style="color: #080">&lt;uri&gt;</span></div><a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b> <span style="color: #080">&lt;method&gt;</span> <span style="color: #080">&lt;uri&gt;</span></div><a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b> <span style="color: #080">&lt;method&gt;</span> <span style="color: #080">&lt;uri&gt;</span> <span style="color: #080">&lt;version&gt;</span></div><a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option httpchk"></a><a class="anchor" name="4-option httpchk"></a><a class="anchor" name="4.2-option httpchk"></a><a class="anchor" name="option httpchk (Proxies)"></a><a class="anchor" name="option httpchk (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option httpchk"></a><a href="#4.2-option%20httpchk">option httpchk</a></b> <span style="color: #080">&lt;method&gt;</span> <span style="color: #080">&lt;uri&gt;</span> <span style="color: #080">&lt;version&gt;</span> <span style="color: #080">&lt;host&gt;</span></div><pre class="text">Enables HTTP protocol to check on the servers health
1439214446

1439314447
May be used in the following contexts: tcp, http
1439414448
</pre><div><p> May be used in sections :</p><table class="table table-bordered" border="0" cellspacing="0" cellpadding="0">
@@ -14409,7 +14463,10 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1440914463
&lt;version&gt; is the optional HTTP version string. It defaults to &quot;HTTP/1.0&quot;
1441014464
but some servers might behave incorrectly in HTTP 1.0, so turning
1441114465
it to HTTP/1.1 may sometimes help. Note that the Host field is
14412-
mandatory in HTTP/1.1, use &quot;<a href="#http-check%20send">http-check send</a>&quot; directive to add it.</pre>
14466+
mandatory in HTTP/1.1.
14467+
14468+
&lt;host&gt; is the optional HTTP Host header value. It is not set by default.
14469+
It is a log-format string.</pre>
1441314470
</div>
1441414471
<pre class="text">By default, server health checks only consist in trying to establish a TCP
1441514472
connection. When &quot;<a href="#option%20httpchk">option httpchk</a>&quot; is specified, a complete HTTP request is
@@ -31013,7 +31070,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3101331070
<br>
3101431071
<hr>
3101531072
<div class="text-right">
31016-
HAProxy 3.1-dev8-59 &ndash; Configuration Manual<br>
31073+
HAProxy 3.1-dev8-67 &ndash; Configuration Manual<br>
3101731074
<small>, 2024/09/18</small>
3101831075
</div>
3101931076
</div>

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.1-dev8-59 - Starter Guide</title>
5+
<title>HAProxy version 3.1-dev8-67 - 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>2024/09/30</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>2024/10/02</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.1-dev8-59</strong></p>
498+
<p><strong>version 3.1-dev8-67</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.1-dev8-59 &ndash; Starter Guide<br>
2518+
HAProxy 3.1-dev8-67 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

0 commit comments

Comments
 (0)