|
2 | 2 | <html lang="en"> |
3 | 3 | <head> |
4 | 4 | <meta charset="utf-8" /> |
5 | | - <title>HAProxy version 3.1.5-17 - Management Guide</title> |
| 5 | + <title>HAProxy version 3.1.5-39 - 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" /> |
|
652 | 652 | You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br> |
653 | 653 | </p> |
654 | 654 | <p class="text-right"> |
655 | | - <small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/02/20</b></small> |
| 655 | + <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/13</b></small> |
656 | 656 | </p> |
657 | 657 | </div> |
658 | 658 | <!-- /.sidebar --> |
|
663 | 663 | <div class="text-center"> |
664 | 664 | <h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1> |
665 | 665 | <h2>Management Guide</h2> |
666 | | - <p><strong>version 3.1.5-17</strong></p> |
| 666 | + <p><strong>version 3.1.5-39</strong></p> |
667 | 667 | <p> |
668 | 668 | <br> |
669 | 669 |
|
@@ -1947,9 +1947,9 @@ <h1 id="chapter-summary" data-target="summary">Summary</h1> |
1947 | 1947 | Unix socket. |
1948 | 1948 |
|
1949 | 1949 | Statistics are regroup in categories labelled as domains, corresponding to the |
1950 | | -multiple components of HAProxy. There are two domains available: proxy and dns. |
1951 | | -If not specified, the proxy domain is selected. Note that only the proxy |
1952 | | -statistics are printed on the HTTP page. |
| 1950 | +multiple components of HAProxy. There are two domains available: proxy and |
| 1951 | +resolvers. If not specified, the proxy domain is selected. Note that only the |
| 1952 | +proxy statistics are printed on the HTTP page. |
1953 | 1953 | </pre></div> |
1954 | 1954 | <a class="anchor" id="9.1" name="9.1"></a> |
1955 | 1955 | <h2 id="chapter-9.1" data-target="9.1"><small><a class="small" href="#9.1">9.1.</a></small> CSV format</h2> |
@@ -3944,36 +3944,47 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.< |
3944 | 3944 | existing streams up to the last one that was created before the command was |
3945 | 3945 | entered; those which die in the mean time will not appear. |
3946 | 3946 | For supported opitons, see below. |
3947 | | -</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"><id></span> | older <span style="color: #080"><age></span> | susp | all]</span> <span style="color: #008">[<span style="color: #080"><options></span>*]</span></div><pre class="text">Display a lot of internal information about the matching streams. In the |
3948 | | -first form, only the stream matching the specified stream identifier will |
3949 | | -be shown. This identifier is the first field at the beginning of the lines in |
3950 | | -the dumps of "<a href="#show%20sess">show sess</a>" (it corresponds to the stream pointer). In the |
3951 | | -second form, only streams older than <age> (in seconds by default) will be |
3952 | | -shown. Passing "susp" instead will only report entries that are considered as |
3953 | | -suspicious by the developers based on criteria that may in time or vary along |
3954 | | -versions. If "all" is used instead, then all streams will be dumped. Dumping |
3955 | | -many streams can produce a huge output, take a lot of time and be CPU |
3956 | | -intensive, so it's always better to only dump the minimum needed. Those |
3957 | | -information are useless to most users but may be used by haproxy developers |
3958 | | -to troubleshoot a complex bug. The output format is intentionally not |
3959 | | -documented so that it can freely evolve depending on demands. This output |
3960 | | -is meant to be interpreted while checking function strm_dump_to_buffer() in |
3961 | | -src/stream.c to figure the exact meaning of certain fields. |
3962 | | - |
3963 | | -It is possible to set some options to customize the dump. Here are the |
3964 | | -supported options: |
3965 | | - |
3966 | | - - show-uri: Dump the transaction URI, as captured during the request |
3967 | | - analysis. It is only displayed if it was captured. |
3968 | | - |
3969 | | - - help: dump a more detailed help message instead |
| 3947 | +</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"><id></span> | all | help]</span> <span style="color: #008">[<span style="color: #080"><options></span>*]</span></div><pre class="text">Display a lot of internal information about the matching streams. The command |
| 3948 | +knows two output formats: a short one, which is the default when not asking |
| 3949 | +for a specific stream identifier, and an extended one when listing designated |
| 3950 | +streams. The short format, used by default with "<a href="#show%20sess">show sess</a>", only dumps one |
| 3951 | +stream per line with a few info, and the stream identifier at the beginning |
| 3952 | +of the line in hexadecimal (it corresponds to the pointer to the stream). |
| 3953 | + |
| 3954 | +In the extended form, used by "show sess <id>" or "show sess all", streams |
| 3955 | +are dumped with a huge amount of debugging details over multiple lines |
| 3956 | +(around 20 each), and still start with their identifier. The delimiter |
| 3957 | +between streams here is the identifier at the beginning of the line; extra |
| 3958 | +lines belonging to the same stream start with one or multiple spaces (the |
| 3959 | +stream is dumped indented). Dumping many streams can produce a huge output, |
| 3960 | +take a lot of time and be CPU intensive, so it's always better to only dump |
| 3961 | +the minimum needed. Those information are useless to most users but may be |
| 3962 | +used by HAProxy developers to troubleshoot a complex bug. The exact output |
| 3963 | +format is intentionally not documented so that it can freely evolve depending |
| 3964 | +on requirements, including in stable branches. This output is meant to be |
| 3965 | +interpreted while checking function strm_dump_to_buffer() in src/stream.c to |
| 3966 | +figure the exact meaning of certain fields. |
| 3967 | + |
| 3968 | +The "<a href="#help">help</a>" argument will show the detailed usage of the command instead of |
| 3969 | +dumping streams. |
| 3970 | + |
| 3971 | +It is possible to set some options to customize the dump or apply some |
| 3972 | +filters. Here are the supported options: |
| 3973 | + - backend <b> only display streams attached to this backend |
| 3974 | + - frontend <f> only display streams attached to this frontend |
| 3975 | + - older <age> only display streams older than <age> seconds |
| 3976 | + - server <b/s> only show streams attached to this backend+server |
| 3977 | + - show-uri dump the transaction URI, as captured during the request |
| 3978 | + analysis. It is only displayed if it was captured. |
| 3979 | + - susp only show streams considered as suspicious by the developers |
| 3980 | + based on criteria that may in time or vary along versions. |
3970 | 3981 | </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"><resolvers|proxy></span>]</span> <span style="color: #008">[<span style="color: #800">{<span style="color: #080"><iid></span>|<span style="color: #080"><proxy></span>}</span> <span style="color: #080"><type></span> <span style="color: #080"><sid></span>]</span> \ |
3971 | | - <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 |
3972 | | -and proxy are available for now. By default, the CSV format is used; you can |
3973 | | -activate the extended typed output format described in the section above if |
3974 | | -"typed" is passed after the other arguments; or in JSON if "json" is passed |
3975 | | -after the other arguments. By passing <id>, <type> and <sid>, it is possible |
3976 | | -to dump only selected items : |
| 3982 | + <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; |
| 3983 | +resolvers and proxy are available for now. By default, the CSV format is used; |
| 3984 | +you can activate the extended typed output format described in the section |
| 3985 | +above if "typed" is passed after the other arguments; or in JSON if "json" is |
| 3986 | +passed after the other arguments. By passing <id>, <type> and <sid>, it is |
| 3987 | +possible to dump only selected items : |
3977 | 3988 | - <iid> is a proxy ID, -1 to dump everything. Alternatively, a proxy name |
3978 | 3989 | <proxy> may be specified. In this case, this proxy's ID will be used as |
3979 | 3990 | the ID selector. |
@@ -5394,7 +5405,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13 |
5394 | 5405 | <br> |
5395 | 5406 | <hr> |
5396 | 5407 | <div class="text-right"> |
5397 | | - HAProxy 3.1.5-17 – Management Guide<br> |
| 5408 | + HAProxy 3.1.5-39 – Management Guide<br> |
5398 | 5409 | <small>, </small> |
5399 | 5410 | </div> |
5400 | 5411 | </div> |
|
0 commit comments