|
2 | 2 | <html lang="en"> |
3 | 3 | <head> |
4 | 4 | <meta charset="utf-8" /> |
5 | | - <title>HAProxy version 3.3-dev7-30 - Management Guide</title> |
| 5 | + <title>HAProxy version 3.3-dev7-63 - Management Guide</title> |
6 | 6 | <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" /> |
7 | 7 | <link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" /> |
8 | 8 | <link href="../css/page.css?0.4.2-15" rel="stylesheet" /> |
|
662 | 662 | You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br> |
663 | 663 | </p> |
664 | 664 | <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/08/27</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/08/28</b></small> |
666 | 666 | </p> |
667 | 667 | </div> |
668 | 668 | <!-- /.sidebar --> |
|
673 | 673 | <div class="text-center"> |
674 | 674 | <h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1> |
675 | 675 | <h2>Management Guide</h2> |
676 | | - <p><strong>version 3.3-dev7-30</strong></p> |
| 676 | + <p><strong>version 3.3-dev7-63</strong></p> |
677 | 677 | <p> |
678 | 678 | <br> |
679 | 679 |
|
@@ -2171,6 +2171,26 @@ <h2 id="chapter-9.1" data-target="9.1"><small><a class="small" href="#9.1">9.1.< |
2171 | 2171 | 97. used_conn_cur [...S]: current number of connections in use |
2172 | 2172 | 98. need_conn_est [...S]: estimated needed number of connections |
2173 | 2173 | 99. uweight [..BS]: total user weight (backend), server user weight (server) |
| 2174 | + 100. agg_server_status [..B.]: backend aggregated gauge of server's status |
| 2175 | + 101. agg_server_status_check [..B.]: (deprecated) |
| 2176 | + 102. agg_check_status [..B.]: backend aggregated gauge of server's state check |
| 2177 | + status |
| 2178 | + 103. srid [...S]: server id revision |
| 2179 | + 104. sess_other [.F..]: total number of sessions other than HTTP since process |
| 2180 | + started |
| 2181 | + 105. h1_sess [.F..]: total number of HTTP/1 sessions since process started |
| 2182 | + 106. h2_sess [.F..]: total number of HTTP/2 sessions since process started |
| 2183 | + 107. h3_sess [.F..]: total number of HTTP/3 sessions since process started |
| 2184 | + 108. req_other [.F..]: total number of sessions other than HTTP processed by |
| 2185 | + this object since the worker process started |
| 2186 | + 109. h1req [.F..]: total number of HTTP/1 sessions processed by this object |
| 2187 | + since the worker process started |
| 2188 | + 110. h2req [.F..]: total number of hTTP/2 sessions processed by this object |
| 2189 | + since the worker process started |
| 2190 | + 111. h3req [.F..]: total number of HTTP/3 sessions processed by this object |
| 2191 | + since the worker process started |
| 2192 | + 112. proto [L...]: protocol |
| 2193 | + 113. priv_idle_cur [...S]: current number of private idle connections |
2174 | 2194 |
|
2175 | 2195 | For all other statistics domains, the presence or the order of the fields are |
2176 | 2196 | not guaranteed. In this case, the header line should always be used to parse |
@@ -2866,11 +2886,19 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.< |
2866 | 2886 | entry in the frontends. If a certificate is used several time in a crt-list, |
2867 | 2887 | you will need to provide which line you want to delete. To display the line |
2868 | 2888 | numbers, use "show ssl crt-list -n <crtlist>". |
2869 | | -</pre><a class="anchor" name="del"></a><a class="anchor" name="9-del"></a><a class="anchor" name="9.3-del"></a><a class="anchor" name="del (Statistics and monitoring)"></a><a class="anchor" name="del (Unix Socket commands)"></a><a class="anchor" name="del server"></a><a class="anchor" name="9-del server"></a><a class="anchor" name="9.3-del server"></a><a class="anchor" name="del server (Statistics and monitoring)"></a><a class="anchor" name="del server (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="del server"></a><a href="#9.3-del%20server">del server</a></b> <span style="color: #080"><backend></span>/<span style="color: #080"><server></span></div><pre class="text">Remove a server attached to the backend <backend>. All servers are eligible, |
2870 | | -except servers which are referenced by other configuration elements. The |
2871 | | -server must be put in maintenance mode prior to its deletion. The operation |
2872 | | -is cancelled if the server still has active or idle connection or its |
2873 | | -connection queue is not empty. |
| 2889 | +</pre><a class="anchor" name="del"></a><a class="anchor" name="9-del"></a><a class="anchor" name="9.3-del"></a><a class="anchor" name="del (Statistics and monitoring)"></a><a class="anchor" name="del (Unix Socket commands)"></a><a class="anchor" name="del server"></a><a class="anchor" name="9-del server"></a><a class="anchor" name="9.3-del server"></a><a class="anchor" name="del server (Statistics and monitoring)"></a><a class="anchor" name="del server (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="del server"></a><a href="#9.3-del%20server">del server</a></b> <span style="color: #080"><backend></span>/<span style="color: #080"><server></span></div><pre class="text">Delete a removable server attached to the backend <backend>. A removable |
| 2890 | +server is the server which satisfies all of these conditions : |
| 2891 | +- not referenced by other configuration elements |
| 2892 | +- must already be in maintenance (see "<a href="#disable%20server">disable server</a>") |
| 2893 | +- must not have any active or idle connections |
| 2894 | + |
| 2895 | +If any of these conditions is not met, the command will fail. |
| 2896 | + |
| 2897 | +Active connections are those with at least one ongoing request. It is |
| 2898 | +possible to speed up their termination using "<a href="#shutdown%20sessions%20server">shutdown sessions server</a>". It |
| 2899 | +is highly recommended to use "wait srv-removable" before "<a href="#del%20server">del server</a>" to |
| 2900 | +ensure that all active or idle connections are closed and that the command |
| 2901 | +succeeds. |
2874 | 2902 | </pre><a class="anchor" name="disable"></a><a class="anchor" name="9-disable"></a><a class="anchor" name="9.3-disable"></a><a class="anchor" name="disable (Statistics and monitoring)"></a><a class="anchor" name="disable (Unix Socket commands)"></a><a class="anchor" name="disable agent"></a><a class="anchor" name="9-disable agent"></a><a class="anchor" name="9.3-disable agent"></a><a class="anchor" name="disable agent (Statistics and monitoring)"></a><a class="anchor" name="disable agent (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="disable agent"></a><a href="#9.3-disable%20agent">disable agent</a></b> <span style="color: #080"><backend></span>/<span style="color: #080"><server></span></div><pre class="text">Mark the auxiliary agent check as temporarily stopped. |
2875 | 2903 |
|
2876 | 2904 | In the case where an agent check is being run as a auxiliary check, due |
@@ -3886,9 +3914,12 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.< |
3886 | 3914 | port Server's port (or zero if none) |
3887 | 3915 | - Unused field, serves as a visual delimiter |
3888 | 3916 | purge_delay Interval between connection purges, in milliseconds |
| 3917 | + served Number of connections currently in use |
3889 | 3918 | used_cur Number of connections currently in use |
| 3919 | + note that this excludes conns attached to a session |
3890 | 3920 | used_max Highest value of used_cur since the process started |
3891 | 3921 | need_est Floating estimate of total needed connections |
| 3922 | + idle_sess Number of idle connections flagged as private |
3892 | 3923 | unsafe_nb Number of idle connections considered as "unsafe" |
3893 | 3924 | safe_nb Number of idle connections considered as "safe" |
3894 | 3925 | idle_lim Configured maximum number of idle connections |
@@ -4696,6 +4727,10 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.< |
4696 | 4727 | can be used to terminate long-running streams after a server is put into |
4697 | 4728 | maintenance mode, for instance. Such terminated streams are reported with a |
4698 | 4729 | 'K' flag in the logs. |
| 4730 | + |
| 4731 | +Backend connections are left in idle state, unless the server is already in |
| 4732 | +maintenance mode, in which case they will be immediately scheduled for |
| 4733 | +deletion. |
4699 | 4734 | </pre><a class="anchor" name="trace"></a><a class="anchor" name="9-trace"></a><a class="anchor" name="9.3-trace"></a><a class="anchor" name="trace (Statistics and monitoring)"></a><a class="anchor" name="trace (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="trace"></a><a href="#9.3-trace">trace</a></b></div><pre class="text">The "<a href="#trace">trace</a>" command alone lists the trace sources, their current status, and |
4700 | 4735 | their brief descriptions. It is only meant as a menu to enter next levels, |
4701 | 4736 | see other "<a href="#trace">trace</a>" commands below. |
@@ -4902,12 +4937,13 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.< |
4902 | 4937 | unsatisfied for the whole <delay> duration. The supported conditions are: |
4903 | 4938 |
|
4904 | 4939 | - srv-removable <proxy>/<server> : this will wait for the specified server to |
4905 | | - be removable, i.e. be in maintenance and no longer have any connection on |
4906 | | - it. Some conditions will never be accepted (e.g. not in maintenance) and |
4907 | | - will cause the report of a specific error message indicating what condition |
4908 | | - is not met. The server might even have been removed in parallel and no |
4909 | | - longer exit. If everything is OK before the delay, a success is returned |
4910 | | - and the operation is terminated. |
| 4940 | + be removable by the "<a href="#del%20server">del server</a>" command, i.e. be in maintenance and no |
| 4941 | + longer have any connection on it (neither active or idle). Some conditions |
| 4942 | + will never be accepted (e.g. not in maintenance) and will cause the report |
| 4943 | + of a specific error message indicating what condition is not met. The |
| 4944 | + server might even have been removed in parallel and no longer exit. If |
| 4945 | + everything is OK before the delay, a success is returned and the operation |
| 4946 | + is terminated. |
4911 | 4947 |
|
4912 | 4948 | The default unit for the delay is milliseconds, though other units are |
4913 | 4949 | accepted if suffixed with the usual timer units (us, ms, s, m, h, d). When |
@@ -4957,6 +4993,11 @@ <h3 id="chapter-9.4.1" data-target="9.4.1"><small><a class="small" href="#9.4.1" |
4957 | 4993 | command and only this one will be sent to the designated process. In this |
4958 | 4994 | case the full command ends at the end of line or semi-colon like any regular |
4959 | 4995 | command. |
| 4996 | + |
| 4997 | + Bugs: the sockpair@ protocol used to implement communication between the |
| 4998 | + master and the worker is known to not be reliable on macOS because of an |
| 4999 | + issue in the macOS sendmsg(2) implementation. A command might end up without |
| 5000 | + response because of that. |
4960 | 5001 | </pre><div class="separator"> |
4961 | 5002 | <span class="label label-success">Examples:</span> |
4962 | 5003 | <pre class="prettyprint"> |
@@ -5023,6 +5064,11 @@ <h3 id="chapter-9.4.1" data-target="9.4.1"><small><a class="small" href="#9.4.1" |
5023 | 5064 | closing the connection or by quitting the worker process (using the "<a href="#quit">quit</a>" |
5024 | 5065 | command). In this case, the prompt mode of the master socket (interactive, |
5025 | 5066 | prompt, timed) is propagated into the worker process. |
| 5067 | + |
| 5068 | + Bugs: the sockpair@ protocol used to implement communication between the |
| 5069 | + master and the worker is known to not be reliable on macOS because of an |
| 5070 | + issue in the macOS sendmsg(2) implementation. A command might end up without |
| 5071 | + response because of that. |
5026 | 5072 | </pre><div class="separator"> |
5027 | 5073 | <span class="label label-success">Examples:</span> |
5028 | 5074 | <pre class="prettyprint"> |
@@ -5578,7 +5624,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13 |
5578 | 5624 | <br> |
5579 | 5625 | <hr> |
5580 | 5626 | <div class="text-right"> |
5581 | | - HAProxy 3.3-dev7-30 – Management Guide<br> |
| 5627 | + HAProxy 3.3-dev7-63 – Management Guide<br> |
5582 | 5628 | <small>, </small> |
5583 | 5629 | </div> |
5584 | 5630 | </div> |
|
0 commit comments