mirror of https://github.com/nicolargo/glances
Update docs for 2.2 release
Nicolargo
parent
9f020ab1cb
commit
29780f83e7
2
NEWS
2
NEWS
|
|
@ -14,6 +14,8 @@ Enhancements and news features:
|
|||
* Add a short key ('F') and a command line option (--fs-free-space) to display FS free space instead of used space (issue #411)
|
||||
* Add a short key ('2') and a command line option (--disable-left-sidebar) to disable/enable the side bar (issue #429)
|
||||
* Add CPU times sort short key ('t') in the curse interface (issue #449)
|
||||
* Refactor operating system detection for GNU/Linux operating system
|
||||
* Code optimization
|
||||
|
||||
Bugs corrected:
|
||||
|
||||
|
|
|
|||
|
|
@ -198,7 +198,6 @@ You can also detect and display all Glances servers available on your network or
|
|||
|
||||
$ glances --browser
|
||||
|
||||
|
||||
And RTFM, always.
|
||||
|
||||
Documentation
|
||||
|
|
|
|||
|
|
@ -123,9 +123,9 @@ td.option-group {
|
|||
<div class="document" id="glances">
|
||||
<h1 class="title">Glances</h1>
|
||||
|
||||
<p>This manual describes <em>Glances</em> version 2.1.2.</p>
|
||||
<p>This manual describes <em>Glances</em> version 2.2.</p>
|
||||
<p>Copyright © 2012-2014 Nicolas Hennion <<a class="reference external" href="mailto:nicolas@nicolargo.com">nicolas@nicolargo.com</a>></p>
|
||||
<p>October 2014</p>
|
||||
<p>December 2014</p>
|
||||
<div class="contents topic" id="table-of-contents">
|
||||
<p class="topic-title first">Table of Contents</p>
|
||||
<ul class="simple">
|
||||
|
|
@ -202,10 +202,15 @@ another one, called <tt class="docutils literal">client</tt>, just run on the se
|
|||
<span class="generic output">client$ glances -c @server</span>
|
||||
</pre>
|
||||
<p>where <tt class="docutils literal">@server</tt> is the IP address or hostname of the server.</p>
|
||||
<p>Glances can centralize available Glances servers using the <tt class="docutils literal"><span class="pre">--browser</span></tt> option. The server list can be staticaly defined in the Glances configuration file (section [serverlist]). Glances can also detect and display all Glances servers available on you network (auto discover mode is based on the the Zeroconf protocol only available on GNU/Linux and Mac OS X):</p>
|
||||
<pre class="code console literal-block">
|
||||
<span class="generic output">client$ glances --browser</span>
|
||||
</pre>
|
||||
<p>It is possible to disable the auto discover mode <tt class="docutils literal"><span class="pre">--disable-autodiscover</span></tt>.</p>
|
||||
<p>In server mode, you can set the bind address <tt class="docutils literal"><span class="pre">-B</span> ADDRESS</tt> and listening
|
||||
TCP port <tt class="docutils literal"><span class="pre">-p</span> PORT</tt>.</p>
|
||||
<p>In client mode, you can set the TCP port of the server <tt class="docutils literal"><span class="pre">-p</span> PORT</tt>.</p>
|
||||
<p>You can also set a password to access to the server <tt class="docutils literal"><span class="pre">--password</span></tt>.</p>
|
||||
<p>You can set a password to access to the server <tt class="docutils literal"><span class="pre">--password</span></tt>.</p>
|
||||
<p>Default binding address is <tt class="docutils literal">0.0.0.0</tt> (Glances will listen on all the
|
||||
available network interfaces) and TCP port is <tt class="docutils literal">61209</tt>.</p>
|
||||
<p>In client/server mode, limits are set by the server side.</p>
|
||||
|
|
@ -216,12 +221,12 @@ client, the latter will try to grab stats using the <tt class="docutils literal"
|
|||
<pre class="code console literal-block">
|
||||
<span class="generic output">client$ glances -c @snmpserver</span>
|
||||
</pre>
|
||||
<p>Note: Stats grabbed by SNMP request are limited.</p>
|
||||
<p>Note: Stats grabbed by SNMP request are limited (operating system dependent).</p>
|
||||
</div>
|
||||
<div class="section" id="web-server-mode">
|
||||
<h2><a class="toc-backref" href="#id9">Web Server Mode</a></h2>
|
||||
<p>If you want to remotely monitor a machine, called <tt class="docutils literal">server</tt>, from any
|
||||
device with a web browser, just run on the server:</p>
|
||||
device with a web browser, just run the server with the <tt class="docutils literal"><span class="pre">-w</span></tt> option:</p>
|
||||
<pre class="code console literal-block">
|
||||
<span class="generic output">server$ glances -w</span>
|
||||
</pre>
|
||||
|
|
@ -280,17 +285,29 @@ http://@server:61208
|
|||
</tr>
|
||||
<tr><td> </td><td>disable sensors module</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--disable-left-sidebar</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>disable left sidebar</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--disable-process</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>disable process module</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--disable-process-extended</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>disable extended stats on top process</td></tr>
|
||||
<tr><td class="option-group">
|
||||
<kbd><span class="option">--disable-log</span></kbd></td>
|
||||
<td>disable log module</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--enable-process-extended</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>enable extended stats on top process</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--enable-history</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>enable the history mode</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--path-history <var>PATH_HISTORY</var></span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>Set the export path for graph history</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--output-csv <var>OUTPUT_CSV</var></span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>export stats to a CSV file</td></tr>
|
||||
|
|
@ -302,6 +319,13 @@ hostname</td></tr>
|
|||
<tr><td class="option-group">
|
||||
<kbd><span class="option">-s</span>, <span class="option">--server</span></kbd></td>
|
||||
<td>run Glances in server mode</td></tr>
|
||||
<tr><td class="option-group">
|
||||
<kbd><span class="option">--browser</span></kbd></td>
|
||||
<td>run the Glances client browser (list of Glances server)</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--disable-autodiscover</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>disable autodiscover feature</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">-p <var>PORT</var></span>, <span class="option">--port <var>PORT</var></span></kbd></td>
|
||||
</tr>
|
||||
|
|
@ -319,6 +343,10 @@ hostname</td></tr>
|
|||
<td>define a client/server password from the prompt or
|
||||
file</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--disable-autodiscover</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>Hide Glances server from the auto discover feature</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--snmp-community <var>SNMP_COMMUNITY</var></span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>SNMP community</td></tr>
|
||||
|
|
@ -357,12 +385,23 @@ file</td></tr>
|
|||
<kbd><span class="option">--process-short-name</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>force short name for processes name</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--hide-kernel-threads</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>hide kernel threads in process list</td></tr>
|
||||
<tr><td class="option-group">
|
||||
<kbd><span class="option">--tree</span></kbd></td>
|
||||
<td>display processes as a tree</td></tr>
|
||||
<tr><td class="option-group">
|
||||
<kbd><span class="option">-b</span>, <span class="option">--byte</span></kbd></td>
|
||||
<td>display network rate in byte per second</td></tr>
|
||||
<tr><td class="option-group">
|
||||
<kbd><span class="option">-1</span>, <span class="option">--percpu</span></kbd></td>
|
||||
<td>start Glances in per CPU mode</td></tr>
|
||||
<tr><td class="option-group" colspan="2">
|
||||
<kbd><span class="option">--fs-free-space</span></kbd></td>
|
||||
</tr>
|
||||
<tr><td> </td><td>display FS free space instead of used</td></tr>
|
||||
<tr><td class="option-group">
|
||||
<kbd><span class="option">--theme-white</span></kbd></td>
|
||||
<td>optimize display for white background</td></tr>
|
||||
|
|
@ -400,6 +439,8 @@ Filter is a regular expression pattern:</p>
|
|||
<dd>Enable/disable top extended stats</dd>
|
||||
<dt><tt class="docutils literal">f</tt></dt>
|
||||
<dd>Show/hide file system stats</dd>
|
||||
<dt><tt class="docutils literal">F</tt></dt>
|
||||
<dd>Switch between FS used and free space</dd>
|
||||
<dt><tt class="docutils literal">g</tt></dt>
|
||||
<dd>Generate hraphs for current history</dd>
|
||||
<dt><tt class="docutils literal">h</tt></dt>
|
||||
|
|
@ -414,13 +455,15 @@ Filter is a regular expression pattern:</p>
|
|||
<dd>Show/hide network stats</dd>
|
||||
<dt><tt class="docutils literal">p</tt></dt>
|
||||
<dd>Sort processes by name</dd>
|
||||
<dt><tt class="docutils literal">q</tt></dt>
|
||||
<dd>Quit</dd>
|
||||
<dt><tt class="docutils literal">q</tt> or <tt class="docutils literal">ESC</tt></dt>
|
||||
<dd>Quit the current Glances session</dd>
|
||||
<dt><tt class="docutils literal">r</tt></dt>
|
||||
<dd>Reset history</dd>
|
||||
<dt><tt class="docutils literal">s</tt></dt>
|
||||
<dd>Show/hide sensors stats</dd>
|
||||
<dt><tt class="docutils literal">t</tt></dt>
|
||||
<dd>Sort process by CPU times (TIME+)</dd>
|
||||
<dt><tt class="docutils literal">T</tt></dt>
|
||||
<dd>View network I/O as combination</dd>
|
||||
<dt><tt class="docutils literal">u</tt></dt>
|
||||
<dd>View cumulative network I/O</dd>
|
||||
|
|
@ -432,9 +475,22 @@ Filter is a regular expression pattern:</p>
|
|||
<dd>Show/hide processes stats</dd>
|
||||
<dt><tt class="docutils literal">1</tt></dt>
|
||||
<dd>Switch between global CPU and per-CPU stats</dd>
|
||||
<dt><tt class="docutils literal">2</tt></dt>
|
||||
<dd>Enable/disable left sidebar</dd>
|
||||
<dt><tt class="docutils literal">/</tt></dt>
|
||||
<dd>Switch between short name / command line (processes name)</dd>
|
||||
</dl>
|
||||
<p>In the Glances client browser (accessible through the --browser command line argument):</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal">ENTER</tt></dt>
|
||||
<dd>Run Glances client to the selected server</dd>
|
||||
<dt><tt class="docutils literal">UP</tt></dt>
|
||||
<dd>Up in the servers list</dd>
|
||||
<dt><tt class="docutils literal">DOWN</tt></dt>
|
||||
<dd>Down in the servers list</dd>
|
||||
<dt><tt class="docutils literal">q</tt> or <tt class="docutils literal">ESC</tt></dt>
|
||||
<dd>Quit Glances</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
|
|
@ -482,15 +538,15 @@ cp /usr/share/doc/glances/glances.conf $XDG_CONFIG_HOME/glances/</span>
|
|||
<p>Glances logs all its internal messages to a log file. By default, only
|
||||
INFO & WARNING & ERROR &CRITICAL levels are logged, but DEBUG messages
|
||||
can ben logged using the -d option on the command line.</p>
|
||||
<p>By default, the configuration file is under:</p>
|
||||
<p>By default, the log file is under:</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name" colspan="2">Linux, *BSD and OS X:</th></tr>
|
||||
<tr class="field"><td> </td><td class="field-body"><tt class="docutils literal">/tmp/glances.conf</tt></td>
|
||||
<tr class="field"><td> </td><td class="field-body"><tt class="docutils literal">/tmp/glances.log</tt></td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Windows:</th><td class="field-body"><tt class="docutils literal"><span class="pre">%APPDATA%\Local\temp\glances.conf</span></tt></td>
|
||||
<tr class="field"><th class="field-name">Windows:</th><td class="field-body"><tt class="docutils literal"><span class="pre">%APPDATA%\Local\temp\glances.log</span></tt></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -702,7 +758,7 @@ User cans switch to the process name by pressing on the <tt class="docutils lite
|
|||
<li>Openned threads, files and network sessions (TCP and UDP)</li>
|
||||
<li>IO nice level</li>
|
||||
</ul>
|
||||
<p>The extended stats feature could be disabled using the --disable-process-extended option (command line) or the <tt class="docutils literal">e</tt> key (curses interface).</p>
|
||||
<p>The extended stats feature could be enabled using the --enable-process-extended option (command line) or the <tt class="docutils literal">e</tt> key (curses interface).</p>
|
||||
<p><em>Note</em>: limit values can be overwritten in the configuration file under
|
||||
the <tt class="docutils literal">[process]</tt> section.</p>
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
995
i18n/glances.pot
995
i18n/glances.pot
File diff suppressed because it is too large
Load Diff
|
|
@ -1,4 +1,4 @@
|
|||
.TH glances 1 "October, 2014" "version 2.1.2" "USER COMMANDS"
|
||||
.TH glances 1 "December, 2014" "version 2.2" "USER COMMANDS"
|
||||
.SH NAME
|
||||
glances \- A cross-platform curses-based system monitoring tool
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
4
setup.py
4
setup.py
|
|
@ -49,13 +49,13 @@ def get_requires():
|
|||
|
||||
setup(
|
||||
name='Glances',
|
||||
version='2.2_BETA',
|
||||
version='2.2',
|
||||
description="A cross-platform curses-based monitoring tool",
|
||||
long_description=open('README.rst').read(),
|
||||
author='Nicolas Hennion',
|
||||
author_email='nicolas@nicolargo.com',
|
||||
url='https://github.com/nicolargo/glances',
|
||||
# download_url='https://s3.amazonaws.com/glances/glances-2.1.1.tar.gz',
|
||||
# download_url='https://s3.amazonaws.com/glances/glances-2.2.tar.gz',
|
||||
license="LGPL",
|
||||
keywords="cli curses monitoring system",
|
||||
install_requires=get_requires(),
|
||||
|
|
|
|||
Loading…
Reference in New Issue