Skip to content

Commit 2928f7b

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 605573b commit 2928f7b

File tree

3 files changed

+88
-78
lines changed

3 files changed

+88
-78
lines changed

‎docs/dev/configuration.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.3-dev2-22 - Configuration Manual</title>
5+
<title>HAProxy version 3.3-dev2-30 - 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" />
@@ -4593,7 +4593,7 @@
45934593
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
45944594
</p>
45954595
<p class="text-right">
4596-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/06/30</b></small>
4596+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/07/01</b></small>
45974597
</p>
45984598
</div>
45994599
<!-- /.sidebar -->
@@ -4604,7 +4604,7 @@
46044604
<div class="text-center">
46054605
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
46064606
<h2>Configuration Manual</h2>
4607-
<p><strong>version 3.3-dev2-22</strong></p>
4607+
<p><strong>version 3.3-dev2-30</strong></p>
46084608
<p>
46094609
2025/06/26<br>
46104610

@@ -33074,7 +33074,7 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3307433074
<br>
3307533075
<hr>
3307633076
<div class="text-right">
33077-
HAProxy 3.3-dev2-22 &ndash; Configuration Manual<br>
33077+
HAProxy 3.3-dev2-30 &ndash; Configuration Manual<br>
3307833078
<small>, 2025/06/26</small>
3307933079
</div>
3308033080
</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.3-dev2-22 - Starter Guide</title>
5+
<title>HAProxy version 3.3-dev2-30 - 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/06/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>2025/07/01</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.3-dev2-22</strong></p>
498+
<p><strong>version 3.3-dev2-30</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.3-dev2-22 &ndash; Starter Guide<br>
2518+
HAProxy 3.3-dev2-30 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

‎docs/dev/management.html‎

Lines changed: 80 additions & 70 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.3-dev2-22 - Management Guide</title>
5+
<title>HAProxy version 3.3-dev2-30 - 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" />
@@ -662,7 +662,7 @@
662662
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
663663
</p>
664664
<p class="text-right">
665-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/06/30</b></small>
665+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/07/01</b></small>
666666
</p>
667667
</div>
668668
<!-- /.sidebar -->
@@ -673,7 +673,7 @@
673673
<div class="text-center">
674674
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
675675
<h2>Management Guide</h2>
676-
<p><strong>version 3.3-dev2-22</strong></p>
676+
<p><strong>version 3.3-dev2-30</strong></p>
677677
<p>
678678
<br>
679679

@@ -2179,9 +2179,10 @@ <h2 id="chapter-9.2" data-target="9.2"><small><a class="small" href="#9.2">9.2.<
21792179
specific to the command producing this output and will not be described in this
21802180
section. Usually it will consist in a series of identifiers and field names.
21812181

2182-
The second column contains 3 characters respectively indicating the origin, the
2183-
nature and the scope of the value being reported. The first character (the
2184-
origin) indicates where the value was extracted from. Possible characters are :
2182+
The second column contains 4 characters respectively indicating the origin, the
2183+
nature, the scope and the persistence state of the value being reported. The
2184+
first character (the origin) indicates where the value was extracted from.
2185+
Possible characters are :
21852186

21862187
M The value is a metric. It is valid at one instant any may change depending
21872188
on its nature .
@@ -2297,7 +2298,16 @@ <h2 id="chapter-9.2" data-target="9.2"><small><a class="small" href="#9.2">9.2.<
22972298
current date or resource usage. At the moment this scope is not used by
22982299
any metric.
22992300

2300-
Consumers of these information will generally have enough of these 3 characters
2301+
The fourth character (persistence state) indicates that the value (the metric)
2302+
is volatile or persistent across reloads. The following characters are expected :
2303+
2304+
V The metric is volatile because it is local to the current process so
2305+
the value will be lost when reloading.
2306+
2307+
P The metric is persistent because it may be shared with other co-processes
2308+
so that the value is preserved across reloads.
2309+
2310+
Consumers of these information will generally have enough of these 4 characters
23012311
to determine how to accurately report aggregated information across multiple
23022312
processes.
23032313

@@ -3044,13 +3054,16 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
30443054
</pre><a class="anchor" name="help"></a><a class="anchor" name="9-help"></a><a class="anchor" name="9.3-help"></a><a class="anchor" name="help (Statistics and monitoring)"></a><a class="anchor" name="help (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="help"></a><a href="#9.3-help">help</a></b> <span style="color: #008">[<span style="color: #080">&lt;command&gt;</span>]</span></div><pre class="text">Print the list of known keywords and their basic usage, or commands matching
30453055
the requested one. The same help screen is also displayed for unknown
30463056
commands.
3047-
</pre><a class="anchor" name="httpclient"></a><a class="anchor" name="9-httpclient"></a><a class="anchor" name="9.3-httpclient"></a><a class="anchor" name="httpclient (Statistics and monitoring)"></a><a class="anchor" name="httpclient (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="httpclient"></a><a href="#9.3-httpclient">httpclient</a></b> <span style="color: #080">&lt;method&gt;</span> <span style="color: #080">&lt;URI&gt;</span></div><pre class="text">Launch an HTTP client request and print the response on the CLI. Only
3057+
</pre><a class="anchor" name="httpclient"></a><a class="anchor" name="9-httpclient"></a><a class="anchor" name="9.3-httpclient"></a><a class="anchor" name="httpclient (Statistics and monitoring)"></a><a class="anchor" name="httpclient (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="httpclient"></a><a href="#9.3-httpclient">httpclient</a></b> <span style="color: #008">[--htx]</span> <span style="color: #080">&lt;method&gt;</span> <span style="color: #080">&lt;URI&gt;</span></div><pre class="text">Launch an HTTP client request and print the response on the CLI. Only
30483058
supported on a CLI connection running in expert mode (see &quot;expert-mode on&quot;).
30493059
It's only meant for debugging. The httpclient is able to resolve a server
30503060
name in the URL using the &quot;default&quot; resolvers section, which is populated
30513061
with the DNS servers of your /etc/resolv.conf by default. However it won't be
30523062
able to resolve an host from /etc/hosts if you don't use a local dns daemon
30533063
which can resolve those.
3064+
3065+
The --htx option allow to use the haproxy internal htx representation using
3066+
the htx_dump() function, mainly used for debugging.
30543067
</pre><a class="anchor" name="new"></a><a class="anchor" name="9-new"></a><a class="anchor" name="9.3-new"></a><a class="anchor" name="new (Statistics and monitoring)"></a><a class="anchor" name="new (Unix Socket commands)"></a><a class="anchor" name="new ssl"></a><a class="anchor" name="9-new ssl"></a><a class="anchor" name="9.3-new ssl"></a><a class="anchor" name="new ssl (Statistics and monitoring)"></a><a class="anchor" name="new ssl (Unix Socket commands)"></a><a class="anchor" name="new ssl ca-file"></a><a class="anchor" name="9-new ssl ca-file"></a><a class="anchor" name="9.3-new ssl ca-file"></a><a class="anchor" name="new ssl ca-file (Statistics and monitoring)"></a><a class="anchor" name="new ssl ca-file (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="new ssl ca-file"></a><a href="#9.3-new%20ssl%20ca-file">new ssl ca-file</a></b> <span style="color: #080">&lt;cafile&gt;</span></div><pre class="text">Create a new empty CA file tree entry to be filled with a set of CA
30553068
certificates and added to a crt-list. This command should be used in
30563069
combination with &quot;<a href="#set%20ssl%20ca-file">set ssl ca-file</a>&quot;, &quot;<a href="#add%20ssl%20ca-file">add ssl ca-file</a>&quot; and &quot;<a href="#add%20ssl%20crt-list">add ssl crt-list</a>&quot;.
@@ -3629,18 +3642,19 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
36293642
(...)
36303643

36313644
&gt; show info typed
3632-
0.Name.1:POS:str:HAProxy
3633-
1.Version.1:POS:str:1.7-dev1-de52ea-146
3634-
2.Release_date.1:POS:str:2016/03/11
3635-
3.Nbproc.1:CGS:u32:1
3636-
4.Process_num.1:KGP:u32:1
3637-
5.Pid.1:SGP:u32:28105
3638-
6.Uptime.1:MDP:str:0d 0h00m08s
3639-
7.Uptime_sec.1:MDP:u32:8
3640-
8.Memmax_MB.1:CLP:u32:0
3641-
9.PoolAlloc_MB.1:MGP:u32:0
3642-
10.PoolUsed_MB.1:MGP:u32:0
3643-
11.PoolFailed.1:MCP:u32:0
3645+
0.Name.1:POSV:str:HAProxy
3646+
1.Version.1:POSV:str:3.1-dev0-7c653d-2466
3647+
2.Release_date.1:POSV:str:2025/07/01
3648+
3.Nbthread.1:CGSV:u32:1
3649+
4.Nbproc.1:CGSV:u32:1
3650+
5.Process_num.1:KGPV:u32:1
3651+
6.Pid.1:SGPV:u32:638069
3652+
7.Uptime.1:MDPV:str:0d 0h00m07s
3653+
8.Uptime_sec.1:MDPV:u32:7
3654+
9.Memmax_MB.1:CLPV:u32:0
3655+
10.PoolAlloc_MB.1:MGPV:u32:0
3656+
11.PoolUsed_MB.1:MGPV:u32:0
3657+
12.PoolFailed.1:MCPV:u32:0
36443658
(...)
36453659
</code></pre>
36463660
</div><pre class="text">In the typed format, the presence of the process ID at the end of the
@@ -4099,10 +4113,11 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
40994113

41004114
The rest of the line starting after the first colon follows the &quot;typed output
41014115
format&quot; described in the section above. In short, the second column (after the
4102-
first ':') indicates the origin, nature and scope of the variable. The third
4103-
column indicates the field type, among &quot;s32&quot;, &quot;s64&quot;, &quot;u32&quot;, &quot;u64&quot;, &quot;flt' and
4104-
&quot;str&quot;. Then the fourth column is the value itself, which the consumer knows
4105-
how to parse thanks to column 3 and how to process thanks to column 2.
4116+
first ':') indicates the origin, nature, scope and persistence state of the
4117+
variable. The third column indicates the field type, among &quot;s32&quot;, &quot;s64&quot;,
4118+
&quot;u32&quot;, &quot;u64&quot;, &quot;flt' and &quot;str&quot;. Then the fourth column is the value itself,
4119+
which the consumer knows how to parse thanks to column 3 and how to process
4120+
thanks to column 2.
41064121

41074122
When &quot;desc&quot; is appended to the command, one extra colon followed by a quoted
41084123
string is appended with a description for the metric. At the time of writing,
@@ -4115,37 +4130,32 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
41154130
Here's an example of typed output format :
41164131

41174132
$ echo &quot;show stat typed&quot; | socat stdio unix-connect:/tmp/sock1
4118-
F.2.0.0.pxname.1:MGP:str:private-frontend
4119-
F.2.0.1.svname.1:MGP:str:FRONTEND
4120-
F.2.0.8.bin.1:MGP:u64:0
4121-
F.2.0.9.bout.1:MGP:u64:0
4122-
F.2.0.40.hrsp_2xx.1:MGP:u64:0
4123-
L.2.1.0.pxname.1:MGP:str:private-frontend
4124-
L.2.1.1.svname.1:MGP:str:sock-1
4125-
L.2.1.17.status.1:MGP:str:OPEN
4126-
L.2.1.73.addr.1:MGP:str:0.0.0.0:8001
4127-
S.3.13.60.rtime.1:MCP:u32:0
4128-
S.3.13.61.ttime.1:MCP:u32:0
4129-
S.3.13.62.agent_status.1:MGP:str:L4TOUT
4130-
S.3.13.64.agent_duration.1:MGP:u64:2001
4131-
S.3.13.65.check_desc.1:MCP:str:Layer4 timeout
4132-
S.3.13.66.agent_desc.1:MCP:str:Layer4 timeout
4133-
S.3.13.67.check_rise.1:MCP:u32:2
4134-
S.3.13.68.check_fall.1:MCP:u32:3
4135-
S.3.13.69.check_health.1:SGP:u32:0
4136-
S.3.13.70.agent_rise.1:MaP:u32:1
4137-
S.3.13.71.agent_fall.1:SGP:u32:1
4138-
S.3.13.72.agent_health.1:SGP:u32:1
4139-
S.3.13.73.addr.1:MCP:str:1.255.255.255:8888
4140-
S.3.13.75.mode.1:MAP:str:http
4141-
B.3.0.0.pxname.1:MGP:str:private-backend
4142-
B.3.0.1.svname.1:MGP:str:BACKEND
4143-
B.3.0.2.qcur.1:MGP:u32:0
4144-
B.3.0.3.qmax.1:MGP:u32:0
4145-
B.3.0.4.scur.1:MGP:u32:0
4146-
B.3.0.5.smax.1:MGP:u32:0
4147-
B.3.0.6.slim.1:MGP:u32:1000
4148-
B.3.0.55.lastsess.1:MMP:s32:-1
4133+
F.2.0.0.pxname.1:KNSV:str:dummy
4134+
F.2.0.1.svname.1:KNSV:str:FRONTEND
4135+
F.2.0.4.scur.1:MGPV:u32:0
4136+
F.2.0.5.smax.1:MMPV:u32:0
4137+
F.2.0.6.slim.1:CLPV:u32:524269
4138+
F.2.0.7.stot.1:MCPP:u64:0
4139+
F.2.0.8.bin.1:MCPP:u64:0
4140+
F.2.0.9.bout.1:MCPP:u64:0
4141+
F.2.0.10.dreq.1:MCPP:u64:0
4142+
F.2.0.11.dresp.1:MCPP:u64:0
4143+
F.2.0.12.ereq.1:MCPP:u64:0
4144+
F.2.0.17.status.1:SGPV:str:OPEN
4145+
F.2.0.26.pid.1:KGPV:u32:1
4146+
F.2.0.27.iid.1:KGSV:u32:2
4147+
F.2.0.28.sid.1:KGSV:u32:0
4148+
F.2.0.32.type.1:CGSV:u32:0
4149+
F.2.0.33.rate.1:MRPP:u32:0
4150+
F.2.0.34.rate_lim.1:CLPV:u32:0
4151+
F.2.0.35.rate_max.1:MMPV:u32:0
4152+
F.2.0.46.req_rate.1:MRPP:u32:0
4153+
F.2.0.47.req_rate_max.1:MMPV:u32:0
4154+
F.2.0.48.req_tot.1:MCPP:u64:0
4155+
F.2.0.51.comp_in.1:MCPP:u64:0
4156+
F.2.0.52.comp_out.1:MCPP:u64:0
4157+
F.2.0.53.comp_byp.1:MCPP:u64:0
4158+
F.2.0.54.comp_rsp.1:MCPP:u64:0
41494159
(...)
41504160

41514161
In the typed format, the presence of the process ID at the end of the
@@ -4156,20 +4166,20 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
41564166
$ ( echo show stat typed | socat /var/run/haproxy.sock1 - ; \
41574167
echo show stat typed | socat /var/run/haproxy.sock2 - ) | \
41584168
sort -t . -k 1,1 -k 2,2n -k 3,3n -k 4,4n -k 5,5 -k 6,6n
4159-
B.3.0.0.pxname.1:MGP:str:private-backend
4160-
B.3.0.0.pxname.2:MGP:str:private-backend
4161-
B.3.0.1.svname.1:MGP:str:BACKEND
4162-
B.3.0.1.svname.2:MGP:str:BACKEND
4163-
B.3.0.2.qcur.1:MGP:u32:0
4164-
B.3.0.2.qcur.2:MGP:u32:0
4165-
B.3.0.3.qmax.1:MGP:u32:0
4166-
B.3.0.3.qmax.2:MGP:u32:0
4167-
B.3.0.4.scur.1:MGP:u32:0
4168-
B.3.0.4.scur.2:MGP:u32:0
4169-
B.3.0.5.smax.1:MGP:u32:0
4170-
B.3.0.5.smax.2:MGP:u32:0
4171-
B.3.0.6.slim.1:MGP:u32:1000
4172-
B.3.0.6.slim.2:MGP:u32:1000
4169+
B.3.0.0.pxname.1:KNSV:str:private-backend
4170+
B.3.0.0.pxname.2:KNSV:str:private-backend
4171+
B.3.0.1.svname.1:KNSV:str:BACKEND
4172+
B.3.0.1.svname.2:KNSV:str:BACKEND
4173+
B.3.0.2.qcur.1:MGPV:u32:0
4174+
B.3.0.2.qcur.2:MGPV:u32:0
4175+
B.3.0.3.qmax.1:MMPV:u32:0
4176+
B.3.0.3.qmax.2:MMPV:u32:0
4177+
B.3.0.4.scur.1:MGPV:u32:0
4178+
B.3.0.4.scur.2:MGPV:u32:0
4179+
B.3.0.5.smax.1:MMPV:u32:0
4180+
B.3.0.5.smax.2:MMPV:u32:0
4181+
B.3.0.6.slim.1:CLPV:u32:1000
4182+
B.3.0.6.slim.2:CLPV:u32:1000
41734183
(...)
41744184

41754185
The format of JSON output is described in a schema which may be output
@@ -5558,7 +5568,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
55585568
<br>
55595569
<hr>
55605570
<div class="text-right">
5561-
HAProxy 3.3-dev2-22 &ndash; Management Guide<br>
5571+
HAProxy 3.3-dev2-30 &ndash; Management Guide<br>
55625572
<small>, </small>
55635573
</div>
55645574
</div>

0 commit comments

Comments
 (0)