aboutsummaryrefslogtreecommitdiff
path: root/man/man1/stats.html
diff options
context:
space:
mode:
Diffstat (limited to 'man/man1/stats.html')
-rw-r--r--man/man1/stats.html214
1 files changed, 214 insertions, 0 deletions
diff --git a/man/man1/stats.html b/man/man1/stats.html
new file mode 100644
index 00000000..77b598d5
--- /dev/null
+++ b/man/man1/stats.html
@@ -0,0 +1,214 @@
+<head>
+<title>stats(1) - Plan 9 from User Space</title>
+<meta content="text/html; charset=utf-8" http-equiv=Content-Type>
+</head>
+<body bgcolor=#ffffff>
+<table border=0 cellpadding=0 cellspacing=0 width=100%>
+<tr height=10><td>
+<tr><td width=20><td>
+<tr><td width=20><td><b>STATS(1)</b><td align=right><b>STATS(1)</b>
+<tr><td width=20><td colspan=2>
+ <br>
+<p><font size=+1><b>NAME </b></font><br>
+
+<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ stats, auxstats &ndash; display graphs of system activity<br>
+
+</table>
+<p><font size=+1><b>SYNOPSIS </b></font><br>
+
+<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ <tt><font size=+1>stats</font></tt> [ <tt><font size=+1>&#8722;</font></tt><i>option</i> ] [ <i>machine</i>[<tt><font size=+1>:</font></tt><i>path</i>] ... ]
+ <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
+
+ <tt><font size=+1>auxstats</font></tt> [ <i>machine</i> [ <i>path</i> ] ]<br>
+
+</table>
+<p><font size=+1><b>DESCRIPTION </b></font><br>
+
+<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ <i>Stats</i> displays a rolling graph of various statistics collected
+ by the operating system and updated once per second. The statistics
+ may be from a remote <i>machine</i> or multiple <i>machines</i>, whose graphs
+ will appear in adjacent columns. The columns are labeled by the
+ machine names and the number of processors on the
+ machine if it is a multiprocessor.
+ <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
+
+ <i>Auxstats</i> collects the machine statistics for display by <i>stats</i>.
+ With no arguments, it collects statistics from the local machine.
+ If <i>machine</i> is named, it executes <tt><font size=+1>ssh</font></tt> <i>machine path</i>; when <i>ssh</i> finishes,
+ <i>auxstats</i> sleeps for one minute and runs it again. The default
+ <i>path</i> is simply <tt><font size=+1>auxstats</font></tt>, but since some shells do not
+ execute any sort of user profile when run as a non-login shell,
+ it is often necessary to specify an exact path.
+ <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
+
+ The right mouse button presents a menu to enable and disable the
+ display of various statistics; by default, <i>stats</i> begins by showing
+ the load average on the executing machine.
+ <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
+
+ The lower-case <i>options</i> choose the initial set to display:<br>
+ <tt><font size=+1>b battery</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;percentage battery life remaining.<br>
+ <tt><font size=+1>c context</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;number of process context switches per second.<br>
+ <tt><font size=+1>e ether</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;total number of packets sent and received per second.<br>
+ <tt><font size=+1>E etherin,out<br>
+ </font></tt>
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ number of packets sent and received per second, displayed as separate
+ graphs.<br>
+
+ </table>
+
+ </table>
+ <tt><font size=+1>f fault</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;number of page faults per second.<br>
+ <tt><font size=+1>i intr</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;number of interrupts per second.<br>
+ <tt><font size=+1>l load</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(default) system load average. The load is computed as a
+ running average of the number of processes ready to run, multiplied
+ by 1000. On most systems, it changes only every five seconds and
+ has limited accuracy.<br>
+ <tt><font size=+1>m mem</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;total pages of active memory. The graph displays the fraction
+ of the machine&#8217;s total memory in use.<br>
+ <tt><font size=+1>n etherin,out,err<br>
+ </font></tt>
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ number of packets sent and received per second, and total number
+ of errors, displayed as separate graphs.<br>
+
+ </table>
+
+ </table>
+ <tt><font size=+1>s syscall</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;number of system calls per second.<br>
+ <tt><font size=+1>w swap</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;number of valid pages on the swap device. The swap is displayed
+ as a fraction of the number of swap pages configured by the machine.
+
+ <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
+
+ The graphs are plotted with time on the horizontal axis. The vertical
+ axes range from 0 to 1000*sleepsecs, multiplied by the number
+ of processors on the machine when appropriate. The only exceptions
+ are memory, and swap space, which display fractions of the total
+ available, system load, which displays a number
+ between 0 and 1000, idle and intr, which display percentages and
+ the Ethernet error count, which goes from 0 to 10.. If the value
+ of the parameter is too large for the visible range, its value
+ is shown in decimal in the upper left corner of the graph.
+ <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
+
+ Upper-case options control details of the display. All graphs
+ are affected; there is no mechanism to affect only one graph.<br>
+ <tt><font size=+1>&#8722;T</font></tt> <i>sleepsecs<br>
+ </i>
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ Set the number of seconds between samples to <i>sleepsecs</i> (default
+ one second).<br>
+
+ </table>
+ <tt><font size=+1>&#8722;S</font></tt> <i>scale<br>
+ </i>
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ Sets a scale factor for the displays. A value of 2, for example,
+ means that the highest value plotted will be twice as large as
+ the default.<br>
+
+ </table>
+ <tt><font size=+1>&#8722;L</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;Plot all graphs with logarithmic <i>y</i> axes. The graph is plotted
+ so the maximum value that would be displayed on a linear graph
+ is 2/3 of the way up the <i>y</i> axis and the total range of the graph
+ is a factor of 1000; thus the <i>y</i> origin is 1/100 of the default
+ maximum value and the top of the graph is 10 times the
+
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ default maximum.<br>
+
+ </table>
+ <tt><font size=+1>&#8722;Y</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;If the display is large enough to show them, place value markers
+ along the <i>y</i> axes of the graphs. Since one set of markers serves
+ for all machines across the display, the values in the markers
+ disregard scaling factors due to multiple processors on the machines.
+ On a graph for a multiprocessor, the displayed
+
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ values will be larger than the markers indicate. The markers appear
+ along the right, and the markers show values appropriate to the
+ rightmost machine; this only matters for graphs such as memory
+ that have machine-specific maxima.
+ <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
+
+
+ </table>
+ Typing &#8216;q&#8217; or DEL causes <i>stats</i> to exit.<br>
+
+</table>
+<p><font size=+1><b>EXAMPLE </b></font><br>
+
+<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ Show the load, memory, interrupts, system calls, context switches,
+ and ethernet packets for the local machine, a remote BSD machine
+ <i>daemon</i>, and a remote Linux machine <i>tux</i>. <i>Auxstats</i> is not in <i>tux</i>&#8217;s
+ path, so the full path must be given.<br>
+
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ <tt><font size=+1>stats &#8722;lmisce `hostname` daemon \<br>
+
+ <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ tux:/usr/local/plan9/bin/auxstats<br>
+
+ </table>
+ </font></tt>
+ </table>
+
+</table>
+<p><font size=+1><b>SOURCE </b></font><br>
+
+<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ <tt><font size=+1>/usr/local/plan9/src/cmd/draw/stats.c
+ <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
+ </font></tt>
+ <tt><font size=+1>/usr/local/plan9/src/cmd/auxstats<br>
+ </font></tt>
+</table>
+<p><font size=+1><b>BUGS </b></font><br>
+
+<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>
+
+ The <i>auxstats</i> binary needs read access to <tt><font size=+1>/dev/kmem</font></tt> in order to
+ collect network statistics on non-Linux systems. Typically this
+ can be arranged by setting the <i>auxstat</i> binary&#8217;s group to <tt><font size=+1>kmem</font></tt>
+ and then turning on its set-gid bit.<br>
+
+</table>
+
+<td width=20>
+<tr height=20><td>
+</table>
+<!-- TRAILER -->
+<table border=0 cellpadding=0 cellspacing=0 width=100%>
+<tr height=15><td width=10><td><td width=10>
+<tr><td><td>
+<center>
+<a href="../../"><img src="../../dist/spaceglenda100.png" alt="Space Glenda" border=1></a>
+</center>
+</table>
+<!-- TRAILER -->
+</body></html>