|
2 | 2 | <html lang="en"> |
3 | 3 | <head> |
4 | 4 | <meta charset="utf-8" /> |
5 | | - <title>HAProxy version 3.5-dev6-16 - Management Guide</title> |
| 5 | + <title>HAProxy version 3.5-dev6-21 - 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" /> |
|
698 | 698 | You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br> |
699 | 699 | </p> |
700 | 700 | <p class="text-right"> |
701 | | - <small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/09/04</b></small> |
| 701 | + <small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/09/07</b></small> |
702 | 702 | </p> |
703 | 703 | </div> |
704 | 704 | <!-- /.sidebar --> |
|
709 | 709 | <div class="text-center"> |
710 | 710 | <h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1> |
711 | 711 | <h2>Management Guide</h2> |
712 | | - <p><strong>version 3.5-dev6-16</strong></p> |
| 712 | + <p><strong>version 3.5-dev6-21</strong></p> |
713 | 713 | <p> |
714 | 714 | <br> |
715 | 715 |
|
@@ -3843,27 +3843,43 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.< |
3843 | 3843 | error was at byte 23. This is the slash ('/') in header name |
3844 | 3844 | "header/bizarre", which is not a valid HTTP character for a header name. |
3845 | 3845 | </code></pre> |
3846 | | -</div><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 events"></a><a class="anchor" name="9-show events"></a><a class="anchor" name="9.3-show events"></a><a class="anchor" name="show events (Statistics and monitoring)"></a><a class="anchor" name="show events (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show events"></a><a href="#9.3-show%20events">show events</a></b> <span style="color: #008">[<span style="color: #080"><sink></span>]</span> <span style="color: #008">[-w]</span> <span style="color: #008">[-n]</span> <span style="color: #008">[-0]</span> <span style="color: #008">[-s]</span></div><pre class="text">With no option, this lists all known event sinks and their types. With an |
3847 | | -option, it will dump all available events in the designated sink if it is of |
3848 | | -type buffer. If option "-w" is passed after the sink name, then once the end |
3849 | | -of the buffer is reached, the command will wait for new events and display |
3850 | | -them. It is possible to stop the operation by entering any input (which will |
3851 | | -be discarded) or by closing the session. Finally, option "-n" is used to |
3852 | | -directly seek to the end of the buffer, which is often convenient when |
3853 | | -combined with "-w" to only report new events. For convenience, "-wn" or "-nw" |
3854 | | -may be used to enable both options at once. By default, all events are |
3855 | | -delimited by a line feed character ('\n' or 10 or 0x0A). It is possible to |
3856 | | -change this to the NUL character ('\0' or 0) by passing the "-0" argument. |
3857 | | -Option "-s" sanitizes the output, so that binary contents resulting from |
3858 | | -captured or decoded data do not alter the terminal's rendering. Whitespace |
3859 | | -characters (space and tab) are replaced with a space so that each record |
3860 | | -stays on a single line, and the other control characters (0x00 to 0x1F and |
3861 | | -0x7F) as well as non-ASCII chars (0x80 and above) are replaced with a '?'. |
3862 | | -The output length is preserved. This way, dumping a ring cannot inject ANSI |
3863 | | -escape sequences nor writing direction codes into the operator's terminal, |
3864 | | -which is useful when dumping to a terminal, or to a program whose input must |
3865 | | -not be interpreted as special (e.g. monitoring scripts whose output is copied |
3866 | | -verbatim into reports). |
| 3846 | +</div><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 events"></a><a class="anchor" name="9-show events"></a><a class="anchor" name="9.3-show events"></a><a class="anchor" name="show events (Statistics and monitoring)"></a><a class="anchor" name="show events (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show events"></a><a href="#9.3-show%20events">show events</a></b> <span style="color: #008">[-<span style="color: #008">[wn0rs]</span>*]</span> <span style="color: #008">[<span style="color: #080"><sink></span>]</span></div><pre class="text">With no option, this lists all known event sinks and their types. Arguments |
| 3847 | +not starting with "-" are taken for a sink name, whose events will be dumped |
| 3848 | +if it is of type buffer. The command also supports a variety of options |
| 3849 | +beginning with "-", and optionally grouped together behind the same "-": |
| 3850 | + |
| 3851 | + -0 by default, all events are delimited on output by a line feed character |
| 3852 | + ('\n' or 10 or 0x0A). Option "-0" changes this delimiter to the NUL |
| 3853 | + character ('\0' or 0), which might be more convenient for external |
| 3854 | + tools. |
| 3855 | + |
| 3856 | + -h show the help message. |
| 3857 | + |
| 3858 | + -n directly seeks to the end of the buffer, which is generally combined |
| 3859 | + with "-w" to only report new events (like "tail -f"). |
| 3860 | + |
| 3861 | + -r undoes "-s", i.e. switches the output to raw mode in case it was |
| 3862 | + already in sanitized mode (via a previous option). This is recommended |
| 3863 | + for tools that want to be future-proof in case the default format |
| 3864 | + eventually changes. |
| 3865 | + |
| 3866 | + -s sanitizes the output, so that binary contents resulting from captured |
| 3867 | + or decoded data do not alter the terminal's rendering. Whitespace |
| 3868 | + characters (spaces and tabs) are replaced with a space so that each |
| 3869 | + record stays on a single line, and the other control characters (0x00 |
| 3870 | + to 0x1F and 0x7F) as well as non-ASCII chars (0x80 and above) are |
| 3871 | + replaced with a '?'. The output length is preserved. This way, dumping |
| 3872 | + a ring cannot inject ANSI escape sequences nor writing direction codes |
| 3873 | + into the operator's terminal, which is useful when dumping to a |
| 3874 | + terminal, or to a program whose input must not be interpreted as |
| 3875 | + special (e.g. monitoring scripts whose output is copied verbatim into |
| 3876 | + reports). |
| 3877 | + |
| 3878 | + -w once the end of the buffer is reached, the command will wait for new |
| 3879 | + events and display them. It is possible to stop the operation by |
| 3880 | + entering any input (which will be discarded) or by closing the session. |
| 3881 | + Note that using "echo show events -w | socat ..." does close the input |
| 3882 | + and interrupt the dump. |
3867 | 3883 | </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 fd"></a><a class="anchor" name="9-show fd"></a><a class="anchor" name="9.3-show fd"></a><a class="anchor" name="show fd (Statistics and monitoring)"></a><a class="anchor" name="show fd (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show fd"></a><a href="#9.3-show%20fd">show fd</a></b> <span style="color: #008">[-!plcfbs]</span>* <span style="color: #008">[<span style="color: #008">[<span style="color: #080"><tgid></span>]</span>/<span style="color: #008">[<span style="color: #080"><fd></span>]</span> | <span style="color: #080"><fd></span>]</span></div><pre class="text">Dump the list of either all open file descriptors or just the one number <fd> |
3868 | 3884 | if specified. The form "<tgid>/<fd>" is also accepted, where either side may |
3869 | 3885 | be empty as a wildcard ("/<fd>" for fd <fd> across thread groups, "<tgid>/" |
@@ -5964,7 +5980,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13 |
5964 | 5980 | <br> |
5965 | 5981 | <hr> |
5966 | 5982 | <div class="text-right"> |
5967 | | - HAProxy 3.5-dev6-16 – Management Guide<br> |
| 5983 | + HAProxy 3.5-dev6-21 – Management Guide<br> |
5968 | 5984 | <small>, </small> |
5969 | 5985 | </div> |
5970 | 5986 | </div> |
|
0 commit comments