Skip to content

Commit 86fee1b

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent d9b8de3 commit 86fee1b

File tree

3 files changed

+48
-37
lines changed

3 files changed

+48
-37
lines changed

docs/dev/configuration.html

+6-6
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-dev6-68 - Configuration Manual</title>
5+
<title>HAProxy version 3.2-dev7 - 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" />
@@ -4468,7 +4468,7 @@
44684468
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44694469
</p>
44704470
<p class="text-right">
4471-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/03/06</b></small>
4471+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/03/07</b></small>
44724472
</p>
44734473
</div>
44744474
<!-- /.sidebar -->
@@ -4479,9 +4479,9 @@
44794479
<div class="text-center">
44804480
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44814481
<h2>Configuration Manual</h2>
4482-
<p><strong>version 3.2-dev6-68</strong></p>
4482+
<p><strong>version 3.2-dev7</strong></p>
44834483
<p>
4484-
2025/02/19<br>
4484+
2025/03/07<br>
44854485

44864486
</p>
44874487
</div>
@@ -31958,8 +31958,8 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3195831958
<br>
3195931959
<hr>
3196031960
<div class="text-right">
31961-
HAProxy 3.2-dev6-68 &ndash; Configuration Manual<br>
31962-
<small>, 2025/02/19</small>
31961+
HAProxy 3.2-dev7 &ndash; Configuration Manual<br>
31962+
<small>, 2025/03/07</small>
3196331963
</div>
3196431964
</div>
3196531965
<!-- /.col-lg-12 -->

docs/dev/intro.html

+4-4
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-dev6-68 - Starter Guide</title>
5+
<title>HAProxy version 3.2-dev7 - 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/03/06</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/03/07</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-dev6-68</strong></p>
498+
<p><strong>version 3.2-dev7</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-dev6-68 &ndash; Starter Guide<br>
2518+
HAProxy 3.2-dev7 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/dev/management.html

+38-27
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-dev6-68 - Management Guide</title>
5+
<title>HAProxy version 3.2-dev7 - 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" />
@@ -654,7 +654,7 @@
654654
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
655655
</p>
656656
<p class="text-right">
657-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/03/06</b></small>
657+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/03/07</b></small>
658658
</p>
659659
</div>
660660
<!-- /.sidebar -->
@@ -665,7 +665,7 @@
665665
<div class="text-center">
666666
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
667667
<h2>Management Guide</h2>
668-
<p><strong>version 3.2-dev6-68</strong></p>
668+
<p><strong>version 3.2-dev7</strong></p>
669669
<p>
670670
<br>
671671

@@ -3952,29 +3952,40 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
39523952
existing streams up to the last one that was created before the command was
39533953
entered; those which die in the mean time will not appear.
39543954
For supported opitons, see below.
3955-
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.3-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Unix Socket commands)"></a><a class="anchor" name="show sess"></a><a class="anchor" name="9-show sess"></a><a class="anchor" name="9.3-show sess"></a><a class="anchor" name="show sess (Statistics and monitoring)"></a><a class="anchor" name="show sess (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show sess"></a><a href="#9.3-show%20sess">show sess</a></b> <span style="color: #008">[<span style="color: #080">&lt;id&gt;</span> | older <span style="color: #080">&lt;age&gt;</span> | susp | all]</span> <span style="color: #008">[<span style="color: #080">&lt;options&gt;</span>*]</span></div><pre class="text">Display a lot of internal information about the matching streams. In the
3956-
first form, only the stream matching the specified stream identifier will
3957-
be shown. This identifier is the first field at the beginning of the lines in
3958-
the dumps of &quot;<a href="#show%20sess">show sess</a>&quot; (it corresponds to the stream pointer). In the
3959-
second form, only streams older than &lt;age&gt; (in seconds by default) will be
3960-
shown. Passing &quot;susp&quot; instead will only report entries that are considered as
3961-
suspicious by the developers based on criteria that may in time or vary along
3962-
versions. If &quot;all&quot; is used instead, then all streams will be dumped. Dumping
3963-
many streams can produce a huge output, take a lot of time and be CPU
3964-
intensive, so it's always better to only dump the minimum needed. Those
3965-
information are useless to most users but may be used by haproxy developers
3966-
to troubleshoot a complex bug. The output format is intentionally not
3967-
documented so that it can freely evolve depending on demands. This output
3968-
is meant to be interpreted while checking function strm_dump_to_buffer() in
3969-
src/stream.c to figure the exact meaning of certain fields.
3970-
3971-
It is possible to set some options to customize the dump. Here are the
3972-
supported options:
3973-
3974-
- show-uri: Dump the transaction URI, as captured during the request
3975-
analysis. It is only displayed if it was captured.
3976-
3977-
- help: dump a more detailed help message instead
3955+
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.3-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Unix Socket commands)"></a><a class="anchor" name="show sess"></a><a class="anchor" name="9-show sess"></a><a class="anchor" name="9.3-show sess"></a><a class="anchor" name="show sess (Statistics and monitoring)"></a><a class="anchor" name="show sess (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show sess"></a><a href="#9.3-show%20sess">show sess</a></b> <span style="color: #008">[<span style="color: #080">&lt;id&gt;</span> | all | help]</span> <span style="color: #008">[<span style="color: #080">&lt;options&gt;</span>*]</span></div><pre class="text">Display a lot of internal information about the matching streams. The command
3956+
knows two output formats: a short one, which is the default when not asking
3957+
for a specific stream identifier, and an extended one when listing designated
3958+
streams. The short format, used by default with &quot;<a href="#show%20sess">show sess</a>&quot;, only dumps one
3959+
stream per line with a few info, and the stream identifier at the beginning
3960+
of the line in hexadecimal (it corresponds to the pointer to the stream).
3961+
3962+
In the extended form, used by &quot;show sess &lt;id&gt;&quot; or &quot;show sess all&quot;, streams
3963+
are dumped with a huge amount of debugging details over multiple lines
3964+
(around 20 each), and still start with their identifier. The delimiter
3965+
between streams here is the identifier at the beginning of the line; extra
3966+
lines belonging to the same stream start with one or multiple spaces (the
3967+
stream is dumped indented). Dumping many streams can produce a huge output,
3968+
take a lot of time and be CPU intensive, so it's always better to only dump
3969+
the minimum needed. Those information are useless to most users but may be
3970+
used by HAProxy developers to troubleshoot a complex bug. The exact output
3971+
format is intentionally not documented so that it can freely evolve depending
3972+
on requirements, including in stable branches. This output is meant to be
3973+
interpreted while checking function strm_dump_to_buffer() in src/stream.c to
3974+
figure the exact meaning of certain fields.
3975+
3976+
The &quot;<a href="#help">help</a>&quot; argument will show the detailed usage of the command instead of
3977+
dumping streams.
3978+
3979+
It is possible to set some options to customize the dump or apply some
3980+
filters. Here are the supported options:
3981+
- backend &lt;b&gt; only display streams attached to this backend
3982+
- frontend &lt;f&gt; only display streams attached to this frontend
3983+
- older &lt;age&gt; only display streams older than &lt;age&gt; seconds
3984+
- server &lt;b/s&gt; only show streams attached to this backend+server
3985+
- show-uri dump the transaction URI, as captured during the request
3986+
analysis. It is only displayed if it was captured.
3987+
- susp only show streams considered as suspicious by the developers
3988+
based on criteria that may in time or vary along versions.
39783989
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.3-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Unix Socket commands)"></a><a class="anchor" name="show stat"></a><a class="anchor" name="9-show stat"></a><a class="anchor" name="9.3-show stat"></a><a class="anchor" name="show stat (Statistics and monitoring)"></a><a class="anchor" name="show stat (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show stat"></a><a href="#9.3-show%20stat">show stat</a></b> <span style="color: #008">[domain <span style="color: #080">&lt;resolvers|proxy&gt;</span>]</span> <span style="color: #008">[<span style="color: #800">{<span style="color: #080">&lt;iid&gt;</span>|<span style="color: #080">&lt;proxy&gt;</span>}</span> <span style="color: #080">&lt;type&gt;</span> <span style="color: #080">&lt;sid&gt;</span>]</span> \
39793990
<span style="color: #008">[typed|json]</span> <span style="color: #008">[desc]</span> <span style="color: #008">[up|no-maint]</span></div><pre class="text">Dump statistics. The domain is used to select which statistics to print; dns
39803991
and proxy are available for now. By default, the CSV format is used; you can
@@ -5455,7 +5466,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
54555466
<br>
54565467
<hr>
54575468
<div class="text-right">
5458-
HAProxy 3.2-dev6-68 &ndash; Management Guide<br>
5469+
HAProxy 3.2-dev7 &ndash; Management Guide<br>
54595470
<small>, </small>
54605471
</div>
54615472
</div>

0 commit comments

Comments
 (0)