|
2 | 2 | <html lang="en"> |
3 | 3 | <head> |
4 | 4 | <meta charset="utf-8" /> |
5 | | - <title>HAProxy version 3.3-dev7-91 - Configuration Manual</title> |
| 5 | + <title>HAProxy version 3.3-dev7-112 - Configuration Manual</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" /> |
|
3553 | 3553 |
|
3554 | 3554 | <a class="list-group-item" href="#shdr_val">shdr_val</a> |
3555 | 3555 |
|
| 3556 | + <a class="list-group-item" href="#shm-stats-file">shm-stats-file</a> |
| 3557 | + |
| 3558 | + <a class="list-group-item" href="#shm-stats-file-max-objects">shm-stats-file-max-objects</a> |
| 3559 | + |
3556 | 3560 | <a class="list-group-item" href="#sigalgs (Bind options)">sigalgs (Bind options)</a> |
3557 | 3561 |
|
3558 | 3562 | <a class="list-group-item" href="#sigalgs (Server and default-server options)">sigalgs (Server and default-server options)</a> |
|
4603 | 4607 | You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br> |
4604 | 4608 | </p> |
4605 | 4609 | <p class="text-right"> |
4606 | | - <small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/09/02</b></small> |
| 4610 | + <small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/09/03</b></small> |
4607 | 4611 | </p> |
4608 | 4612 | </div> |
4609 | 4613 | <!-- /.sidebar --> |
|
4614 | 4618 | <div class="text-center"> |
4615 | 4619 | <h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1> |
4616 | 4620 | <h2>Configuration Manual</h2> |
4617 | | - <p><strong>version 3.3-dev7-91</strong></p> |
| 4621 | + <p><strong>version 3.3-dev7-112</strong></p> |
4618 | 4622 | <p> |
4619 | 4623 | 2025/08/20<br> |
4620 | 4624 |
|
@@ -8667,6 +8671,30 @@ <h2 id="chapter-3.1" data-target="3.1"><small><a class="small" href="#3.1">3.1.< |
8667 | 8671 | is overwritten. The changes immediately take effect so that the next line in |
8668 | 8672 | the configuration file sees the new value. See also "<a href="#presetenv">presetenv</a>", "<a href="#resetenv">resetenv</a>", |
8669 | 8673 | and "<a href="#unsetenv">unsetenv</a>". |
| 8674 | +</pre><a class="anchor" name="shm-stats-file"></a><a class="anchor" name="3-shm-stats-file"></a><a class="anchor" name="3.1-shm-stats-file"></a><a class="anchor" name="shm-stats-file (Global section)"></a><a class="anchor" name="shm-stats-file (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="shm-stats-file"></a><a href="#3.1-shm-stats-file">shm-stats-file</a></b> <span style="color: #080"><name></span> <span style="color: #008">[ EXPERIMENTAL ]</span></div><pre class="text">When this directive is set, it enables the use of shared memory for storing |
| 8675 | +stats counters. <name> is used as argument to shm_open() to open the shared |
| 8676 | +memory at a unique location. It also means that the directive is only |
| 8677 | +available on systems which support shm_open(). When SHM is used for stats, all |
| 8678 | +shareable counters for frontends, backends, listeners and servers will be |
| 8679 | +stored in the SHM, provided that they have a GUID set. When reloading haproxy, |
| 8680 | +new process will try to scan the SHM for objects that could be associated to |
| 8681 | +objects defined in the configuration based on GUID and type, the goal is to be |
| 8682 | +able to preserve some counters' values upon reload. On the other hand, when |
| 8683 | +haproxy is properly stopped, the SHM objects are released, which means counters |
| 8684 | +are effectively reset. It is also possible to manually remove the file before |
| 8685 | +starting a fresh process to force a reset. |
| 8686 | + |
| 8687 | +See also "<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">guid<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#guid%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#guid%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>", "<a href="#guid-prefix">guid-prefix</a>" and "<a href="#shm-stats-file-max-objects">shm-stats-file-max-objects</a>" |
| 8688 | +</pre><a class="anchor" name="shm-stats-file-max-objects"></a><a class="anchor" name="3-shm-stats-file-max-objects"></a><a class="anchor" name="3.1-shm-stats-file-max-objects"></a><a class="anchor" name="shm-stats-file-max-objects (Global section)"></a><a class="anchor" name="shm-stats-file-max-objects (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="shm-stats-file-max-objects"></a><a href="#3.1-shm-stats-file-max-objects">shm-stats-file-max-objects</a></b> <span style="color: #080"><number></span> <span style="color: #008">[ EXPERIMENTAL ]</span></div><pre class="text">This setting defines the maximum number of objects the shared memory used |
| 8689 | +for shared counters will be able to store per thread group. It is directly |
| 8690 | +related to the maximum memory size of the shm and is used to "premap" the |
| 8691 | +shm to a given size in order to avoid runtime re-mapping. It defaults to 2k, |
| 8692 | +which should suit for most setups without risking unsuitable memory usage, |
| 8693 | +but can be easily changed if needed. haproxy will complain during startup if |
| 8694 | +this value is to low to register objects that are expected to be stored in |
| 8695 | +the shared memory. It is only relevant when "<a href="#shm-stats-file">shm-stats-file</a>" was defined. |
| 8696 | + |
| 8697 | +See also "<a href="#thread-groups">thread-groups</a>" |
8670 | 8698 | </pre><a class="anchor" name="ssl-default-bind-ciphers"></a><a class="anchor" name="3-ssl-default-bind-ciphers"></a><a class="anchor" name="3.1-ssl-default-bind-ciphers"></a><a class="anchor" name="ssl-default-bind-ciphers (Global section)"></a><a class="anchor" name="ssl-default-bind-ciphers (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="ssl-default-bind-ciphers"></a><a href="#3.1-ssl-default-bind-ciphers">ssl-default-bind-ciphers</a></b> <span style="color: #080"><ciphers></span></div><pre class="text">This setting is only available when support for OpenSSL was built in. It sets |
8671 | 8699 | the default string describing the list of cipher algorithms ("cipher suite") |
8672 | 8700 | that are negotiated during the SSL/TLS handshake up to TLSv1.2 for all |
@@ -12362,7 +12390,7 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.< |
12362 | 12390 | types. Format is left unspecified to allow the user to select its naming |
12363 | 12391 | policy. The only restriction is its length which cannot be greater than |
12364 | 12392 | 127 characters. All alphanumerical values and '.', ':', '-' and '_' |
12365 | | -characters are valid. |
| 12393 | +characters are valid. See also "<a href="#shm-stats-file">shm-stats-file</a>". |
12366 | 12394 | </pre><a class="anchor" name="hash-balance-factor"></a><a class="anchor" name="4-hash-balance-factor"></a><a class="anchor" name="4.2-hash-balance-factor"></a><a class="anchor" name="hash-balance-factor (Proxies)"></a><a class="anchor" name="hash-balance-factor (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="hash-balance-factor"></a><a href="#4.2-hash-balance-factor">hash-balance-factor</a></b> <span style="color: #080"><factor></span></div><pre class="text">Specify the balancing factor for bounded-load consistent hashing |
12367 | 12395 |
|
12368 | 12396 | May be used in the following contexts: tcp, http |
@@ -21125,6 +21153,7 @@ <h2 id="chapter-5.1" data-target="5.1"><small><a class="small" href="#5.1">5.1.< |
21125 | 21153 | allocated on this bind line. Prefix will be concatenated to listeners |
21126 | 21154 | position index on the current bind line, with character '-' as separator. See |
21127 | 21155 | "<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">guid<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#guid%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#guid%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>" proxy keyword description for more information on its format. |
| 21156 | +See also "<a href="#shm-stats-file">shm-stats-file</a>". |
21128 | 21157 | </pre><a class="anchor" name="id"></a><a class="anchor" name="5-id"></a><a class="anchor" name="5.1-id"></a><a class="anchor" name="id (Bind and server options)"></a><a class="anchor" name="id (Bind options)"></a><div class="keyword"><b><a class="anchor" name="id"></a><a href="#5.1-id">id</a></b> <span style="color: #080"><id></span></div><pre class="text">Fixes the socket ID. By default, socket IDs are automatically assigned, but |
21129 | 21158 | sometimes it is more convenient to fix them to ease monitoring. This value |
21130 | 21159 | must be strictly positive and unique within the listener/frontend. This |
@@ -22011,7 +22040,8 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.< |
22011 | 22040 |
|
22012 | 22041 | Specify a case-sensitive global unique ID for this server. This must be |
22013 | 22042 | unique across all haproxy configuration on every object types. See "<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">guid<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#guid%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#guid%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>" |
22014 | | -proxy keyword description for more information on its format. |
| 22043 | +proxy keyword description for more information on its format. See also |
| 22044 | +"<a href="#shm-stats-file">shm-stats-file</a>". |
22015 | 22045 | </pre><a class="anchor" name="hash-key"></a><a class="anchor" name="5-hash-key"></a><a class="anchor" name="5.2-hash-key"></a><a class="anchor" name="hash-key (Bind and server options)"></a><a class="anchor" name="hash-key (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="hash-key"></a><a href="#5.2-hash-key">hash-key</a></b> <span style="color: #080"><key></span></div><pre class="text">May be used in the following contexts: tcp, http, log |
22016 | 22046 |
|
22017 | 22047 | Specify how "hash-type consistent" node keys are computed |
@@ -33199,7 +33229,7 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12 |
33199 | 33229 | <br> |
33200 | 33230 | <hr> |
33201 | 33231 | <div class="text-right"> |
33202 | | - HAProxy 3.3-dev7-91 – Configuration Manual<br> |
| 33232 | + HAProxy 3.3-dev7-112 – Configuration Manual<br> |
33203 | 33233 | <small>, 2025/08/20</small> |
33204 | 33234 | </div> |
33205 | 33235 | </div> |
|
0 commit comments