Update doc and screenshot for version 1.7

author: Nicolas Hennion <nicolas@nicolargo.com> 2013-08-09 12:27:33 +0200
committer: Nicolas Hennion <nicolas@nicolargo.com> 2013-08-09 12:27:33 +0200
commit: 2909357e686823a8a7bdba81ca52d505621380e2 (patch)
tree: d62924d4a8f2fe556f1dd85f3f4d2dce3555f780 /docs
parent: d3c1205831af283a9b6f56b708bb3298d2096938 (diff)
5 files changed, 101 insertions, 61 deletions
diff --git a/docs/glances-doc.html b/docs/glances-doc.html
index 27b37620..05079374 100644
--- a/docs/glances-doc.html
+++ b/docs/glances-doc.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.11: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.10: http://docutils.sourceforge.net/" />
 <title>Glances</title>
 <style type="text/css">
 
@@ -129,40 +129,40 @@ td.option-group {
 <div class="contents topic" id="table-of-contents">
 <p class="topic-title first">Table of Contents</p>
 <ul class="simple">
-<li><a class="reference internal" href="#introduction" id="id3">Introduction</a></li>
-<li><a class="reference internal" href="#usage" id="id4">Usage</a><ul>
-<li><a class="reference internal" href="#standalone-mode" id="id5">Standalone mode</a></li>
-<li><a class="reference internal" href="#client-server-mode" id="id6">Client/Server mode</a></li>
+<li><a class="reference internal" href="#introduction" id="id7">Introduction</a></li>
+<li><a class="reference internal" href="#usage" id="id8">Usage</a><ul>
+<li><a class="reference internal" href="#standalone-mode" id="id9">Standalone mode</a></li>
+<li><a class="reference internal" href="#client-server-mode" id="id10">Client/Server mode</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#command-reference" id="id7">Command reference</a><ul>
-<li><a class="reference internal" href="#command-line-options" id="id8">Command-line options</a></li>
-<li><a class="reference internal" href="#interactive-commands" id="id9">Interactive commands</a></li>
+<li><a class="reference internal" href="#command-reference" id="id11">Command reference</a><ul>
+<li><a class="reference internal" href="#command-line-options" id="id12">Command-line options</a></li>
+<li><a class="reference internal" href="#interactive-commands" id="id13">Interactive commands</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#configuration" id="id10">Configuration</a></li>
-<li><a class="reference internal" href="#anatomy-of-the-application" id="id11">Anatomy of the application</a><ul>
-<li><a class="reference internal" href="#legend" id="id12">Legend</a></li>
-<li><a class="reference internal" href="#header" id="id13">Header</a></li>
-<li><a class="reference internal" href="#cpu" id="id14">CPU</a></li>
-<li><a class="reference internal" href="#load" id="id15">Load</a></li>
-<li><a class="reference internal" href="#memory" id="id16">Memory</a></li>
-<li><a class="reference internal" href="#network" id="id17">Network</a></li>
-<li><a class="reference internal" href="#sensors" id="id18">Sensors</a></li>
-<li><a class="reference internal" href="#disk-i-o" id="id19">Disk I/O</a></li>
-<li><a class="reference internal" href="#file-system" id="id20">File system</a></li>
-<li><a class="reference internal" href="#processes-list" id="id21">Processes list</a></li>
-<li><a class="reference internal" href="#monitored-processes-list" id="id22">Monitored processes list</a></li>
-<li><a class="reference internal" href="#logs" id="id23">Logs</a></li>
-<li><a class="reference internal" href="#footer" id="id24">Footer</a></li>
+<li><a class="reference internal" href="#configuration" id="id14">Configuration</a></li>
+<li><a class="reference internal" href="#anatomy-of-the-application" id="id15">Anatomy of the application</a><ul>
+<li><a class="reference internal" href="#legend" id="id16">Legend</a></li>
+<li><a class="reference internal" href="#header" id="id17">Header</a></li>
+<li><a class="reference internal" href="#cpu" id="id18">CPU</a></li>
+<li><a class="reference internal" href="#load" id="id19">Load</a></li>
+<li><a class="reference internal" href="#memory" id="id20">Memory</a></li>
+<li><a class="reference internal" href="#network" id="id21">Network</a></li>
+<li><a class="reference internal" href="#sensors" id="id22">Sensors</a></li>
+<li><a class="reference internal" href="#disk-i-o" id="id23">Disk I/O</a></li>
+<li><a class="reference internal" href="#file-system" id="id24">File system</a></li>
+<li><a class="reference internal" href="#processes-list" id="id25">Processes list</a></li>
+<li><a class="reference internal" href="#monitored-processes-list" id="id26">Monitored processes list</a></li>
+<li><a class="reference internal" href="#logs" id="id27">Logs</a></li>
+<li><a class="reference internal" href="#footer" id="id28">Footer</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#api-documentation" id="id25">API documentation</a></li>
-<li><a class="reference internal" href="#support" id="id26">Support</a></li>
+<li><a class="reference internal" href="#api-documentation" id="id29">API documentation</a></li>
+<li><a class="reference internal" href="#support" id="id30">Support</a></li>
 </ul>
 </div>
 <div class="section" id="introduction">
-<h1><a class="toc-backref" href="#id3">Introduction</a></h1>
+<h1><a class="toc-backref" href="#id7">Introduction</a></h1>
 <p>Glances is a cross-platform curses-based monitoring tool which aims to
 present a maximum of information in a minimum of space, ideally to fit
 in a classical 80x24 terminal or higher to have additional information.</p>
@@ -175,16 +175,16 @@ terminal size. It can also work in a client/server mode for remote monitoring.</
 <img alt="images/screenshot-wide.png" src="images/screenshot-wide.png" />
 </div>
 <div class="section" id="usage">
-<h1><a class="toc-backref" href="#id4">Usage</a></h1>
+<h1><a class="toc-backref" href="#id8">Usage</a></h1>
 <div class="section" id="standalone-mode">
-<h2><a class="toc-backref" href="#id5">Standalone mode</a></h2>
+<h2><a class="toc-backref" href="#id9">Standalone mode</a></h2>
 <p>Simply run:</p>
 <pre class="code console literal-block">
 <span class="generic prompt">$</span> glances
 </pre>
 </div>
 <div class="section" id="client-server-mode">
-<h2><a class="toc-backref" href="#id6">Client/Server mode</a></h2>
+<h2><a class="toc-backref" href="#id10">Client/Server mode</a></h2>
 <p>If you want to remotely monitor a machine, called <tt class="docutils literal">server</tt>, from another one, called <tt class="docutils literal">client</tt>,
 just run on the server:</p>
 <pre class="code console literal-block">
@@ -204,9 +204,9 @@ just run on the server:</p>
 </div>
 </div>
 <div class="section" id="command-reference">
-<h1><a class="toc-backref" href="#id7">Command reference</a></h1>
+<h1><a class="toc-backref" href="#id11">Command reference</a></h1>
 <div class="section" id="command-line-options">
-<h2><a class="toc-backref" href="#id8">Command-line options</a></h2>
+<h2><a class="toc-backref" href="#id12">Command-line options</a></h2>
 <table class="docutils option-list" frame="void" rules="none">
 <col class="option" />
 <col class="description" />
@@ -275,7 +275,7 @@ just run on the server:</p>
 </table>
 </div>
 <div class="section" id="interactive-commands">
-<h2><a class="toc-backref" href="#id9">Interactive commands</a></h2>
+<h2><a class="toc-backref" href="#id13">Interactive commands</a></h2>
 <p>The following commands (key pressed) are supported while in Glances:</p>
 <dl class="docutils">
 <dt><tt class="docutils literal">a</tt></dt>
@@ -324,7 +324,7 @@ just run on the server:</p>
 </div>
 </div>
 <div class="section" id="configuration">
-<h1><a class="toc-backref" href="#id10">Configuration</a></h1>
+<h1><a class="toc-backref" href="#id14">Configuration</a></h1>
 <p>No configuration file is mandatory to use Glances.</p>
 <p>Furthermore a configuration file is needed for setup limits and/or monitored processes list.</p>
 <p>By default, the configuration file is under:</p>
@@ -344,9 +344,9 @@ cp /etc/glances/glances.conf $XDG_CONFIG_HOME/glances/</span>
 <p>On OS X, you should copy the configuration file to <tt class="docutils literal">~/Library/Application Support/glances/</tt>.</p>
 </div>
 <div class="section" id="anatomy-of-the-application">
-<h1><a class="toc-backref" href="#id11">Anatomy of the application</a></h1>
+<h1><a class="toc-backref" href="#id15">Anatomy of the application</a></h1>
 <div class="section" id="legend">
-<h2><a class="toc-backref" href="#id12">Legend</a></h2>
+<h2><a class="toc-backref" href="#id16">Legend</a></h2>
 <div class="line-block">
 <div class="line"><tt class="docutils literal">GREEN</tt> stat counter is <tt class="docutils literal">&quot;OK&quot;</tt></div>
 <div class="line"><tt class="docutils literal">BLUE</tt> stat counter is <tt class="docutils literal">&quot;CAREFUL&quot;</tt></div>
@@ -355,13 +355,13 @@ cp /etc/glances/glances.conf $XDG_CONFIG_HOME/glances/</span>
 </div>
 </div>
 <div class="section" id="header">
-<h2><a class="toc-backref" href="#id13">Header</a></h2>
+<h2><a class="toc-backref" href="#id17">Header</a></h2>
 <img alt="images/header.png" src="images/header.png" />
 <p>The header shows the OS name, release version, platform architecture and the hostname.
 On Linux, it shows also the kernel version.</p>
 </div>
 <div class="section" id="cpu">
-<h2><a class="toc-backref" href="#id14">CPU</a></h2>
+<h2><a class="toc-backref" href="#id18">CPU</a></h2>
 <p>Short view:</p>
 <img alt="images/cpu.png" src="images/cpu.png" />
 <p>If enough horizontal space is available, extended CPU informations are displayed.</p>
@@ -380,9 +380,9 @@ The total CPU usage is displayed on the first line.</p>
 <p><em>Note</em>: limit values can be overwritten in the configuration file under the <tt class="docutils literal">[cpu]</tt> section.</p>
 </div>
 <div class="section" id="load">
-<h2><a class="toc-backref" href="#id15">Load</a></h2>
+<h2><a class="toc-backref" href="#id19">Load</a></h2>
 <img alt="images/load.png" src="images/load.png" />
-<p>On the <em>No Sheep</em> blog, <em>Zachary Tirrell</em> defines the average load <a class="footnote-reference" href="#id2" id="id1">[1]</a>:</p>
+<p>On the <em>No Sheep</em> blog, <em>Zachary Tirrell</em> defines the average load <a class="footnote-reference" href="#id4" id="id1">[1]</a>:</p>
 <blockquote>
 &quot;In short it is the average sum of the number of processes
 waiting in the run-queue plus the number currently executing
@@ -399,7 +399,7 @@ The first line also display the number of CPU core.</p>
 <p><em>Note</em>: limit values can be overwritten in the configuration file under the <tt class="docutils literal">[load]</tt> section.</p>
 </div>
 <div class="section" id="memory">
-<h2><a class="toc-backref" href="#id16">Memory</a></h2>
+<h2><a class="toc-backref" href="#id20">Memory</a></h2>
 <p>Glances uses two columns: one for the <tt class="docutils literal">RAM</tt> and another one for the <tt class="docutils literal">Swap</tt>.</p>
 <img alt="images/mem.png" src="images/mem.png" />
 <p>If enough space is available, Glances displays extended informations:</p>
@@ -414,7 +414,7 @@ The first line also display the number of CPU core.</p>
 <p><em>Note</em>: limit values can be overwritten in the configuration file under the <tt class="docutils literal">[memory]</tt> and <tt class="docutils literal">[swap]</tt> sections.</p>
 </div>
 <div class="section" id="network">
-<h2><a class="toc-backref" href="#id17">Network</a></h2>
+<h2><a class="toc-backref" href="#id21">Network</a></h2>
 <img alt="images/network.png" src="images/network.png" />
 <p>Glances displays the network interface bit rate. The unit is adapted
 dynamically (bits per second, kbits per second, Mbits per second, etc).</p>
@@ -429,11 +429,12 @@ if the bit rate is higher than 70 Mbps.</p>
 </div>
 </div>
 <div class="section" id="sensors">
-<h2><a class="toc-backref" href="#id18">Sensors</a></h2>
-<img alt="images/sensors.png" src="images/sensors.png" />
+<h2><a class="toc-backref" href="#id22">Sensors</a></h2>
 <p>Glances can displays the sensors informations trough <cite>lm-sensors</cite> (only
-available on Linux) and <cite>hddtemp</cite> daemon.</p>
-<p>As of lm-sensors, a filter is processed in order to display temperature only.</p>
+available on Linux). As of lm-sensors, a filter is processed in order to display temperature only:</p>
+<img alt="images/sensors.png" src="images/sensors.png" />
+<p>Glances can also grab hard disk temperature through the <cite>hddtemp</cite> daemon (see here <a class="footnote-reference" href="#id5" id="id2">[2]</a> to install hddtemp on your system):</p>
+<img alt="images/hddtemp.png" src="images/hddtemp.png" />
 <p>To enable the lm-sensors module:</p>
 <pre class="code console literal-block">
 <span class="generic prompt">$</span> glances -e
@@ -446,13 +447,13 @@ available on Linux) and <cite>hddtemp</cite> daemon.</p>
 <p><em>Note</em>: limit values can be overwritten in the configuration file under the <tt class="docutils literal">[temperature]</tt> and <tt class="docutils literal">[hddtemperature]</tt> sections.</p>
 </div>
 <div class="section" id="disk-i-o">
-<h2><a class="toc-backref" href="#id19">Disk I/O</a></h2>
+<h2><a class="toc-backref" href="#id23">Disk I/O</a></h2>
 <img alt="images/diskio.png" src="images/diskio.png" />
 <p>Glances displays the disk I/O throughput. The unit is adapted dynamically.</p>
-<p>There is no alert on this information.</p>
+<p><em>Note</em>: There is no alert on this information.</p>
 </div>
 <div class="section" id="file-system">
-<h2><a class="toc-backref" href="#id20">File system</a></h2>
+<h2><a class="toc-backref" href="#id24">File system</a></h2>
 <img alt="images/fs.png" src="images/fs.png" />
 <p>Glances displays the used and total file system disk space. The unit is
 adapted dynamically.</p>
@@ -466,7 +467,7 @@ adapted dynamically.</p>
 <p><em>Note</em>: limit values can be overwritten in the configuration file under <tt class="docutils literal">[filesystem]</tt> section.</p>
 </div>
 <div class="section" id="processes-list">
-<h2><a class="toc-backref" href="#id21">Processes list</a></h2>
+<h2><a class="toc-backref" href="#id25">Processes list</a></h2>
 <p>Compact view:</p>
 <img alt="images/processlist.png" src="images/processlist.png" />
 <p>Full view:</p>
@@ -522,10 +523,11 @@ sorted by CPU of memory usage.</p>
 </dl>
 </div>
 <div class="section" id="monitored-processes-list">
-<h2><a class="toc-backref" href="#id22">Monitored processes list</a></h2>
+<h2><a class="toc-backref" href="#id26">Monitored processes list</a></h2>
 <p>New in version 1.7. Optional.</p>
 <p>The monitored processes list allows user, through the configuration file,
 to group processes and quickly show if the number of running process is not good.</p>
+<img alt="images/monitored.png" src="images/monitored.png" />
 <p>Each item is defined by:</p>
 <ul class="simple">
 <li><tt class="docutils literal">description</tt>: description of the processes (max 16 chars).</li>
@@ -557,9 +559,16 @@ list_1_regex=.*php-fpm.*
 list_1_countmin=1
 list_1_countmax=20</span>
 </pre>
+<p>In the client/server mode, the list is define on the server side. A new method (getAllMonitored) is available in the API and get the JSON representation of the monitored processes list.</p>
+<p>Alerts are set following:</p>
+<div class="line-block">
+<div class="line">If number of processes is 0, then status is set to <tt class="docutils literal">&quot;CRITICAL&quot;</tt></div>
+<div class="line">If number of processes is min &lt; curent &lt; max, then status is set to <tt class="docutils literal">&quot;OK&quot;</tt></div>
+<div class="line">Else status is set to <tt class="docutils literal">&quot;WARNING&quot;</tt></div>
+</div>
 </div>
 <div class="section" id="logs">
-<h2><a class="toc-backref" href="#id23">Logs</a></h2>
+<h2><a class="toc-backref" href="#id27">Logs</a></h2>
 <img alt="images/logs.png" src="images/logs.png" />
 <p>A log messages list is displayed in the bottom of the screen if (and only if):</p>
 <ul class="simple">
@@ -571,13 +580,15 @@ list_1_countmax=20</span>
 <li>start date</li>
 <li>end date</li>
 <li>alert name</li>
-<li>{min/avg/max} values (or monitored processes list description)</li>
+<li>{min/avg/max} values or number of running pocesses for monitored processes list alerts</li>
 </ol>
 </div>
 <div class="section" id="footer">
-<h2><a class="toc-backref" href="#id24">Footer</a></h2>
+<h2><a class="toc-backref" href="#id28">Footer</a></h2>
 <img alt="images/footer.png" src="images/footer.png" />
 <p>Glances displays the current date &amp; time and access to the embedded help screen.</p>
+<p>If one or mode batteries were found on your machine and if the batinfo Python lib <a class="footnote-reference" href="#id5" id="id3">[2]</a> is installed on your system then Glances display the available percent capacity in the middle on the footer.</p>
+<img alt="images/battery.png" src="images/battery.png" />
 <p>If you have ran Glances in client mode <tt class="docutils literal"><span class="pre">-c</span></tt>, you can also see if the client is connected to the server.</p>
 <p>If client is connected:</p>
 <img alt="images/client-connected.png" src="images/client-connected.png" />
@@ -587,20 +598,32 @@ list_1_countmax=20</span>
 </div>
 </div>
 <div class="section" id="api-documentation">
-<h1><a class="toc-backref" href="#id25">API documentation</a></h1>
+<h1><a class="toc-backref" href="#id29">API documentation</a></h1>
 <p>Glances uses a <a class="reference external" href="http://docs.python.org/2/library/simplexmlrpcserver.html">XML-RPC server</a> and can be used by another client software.</p>
 <p>API documentation is available at <a class="reference external" href="https://github.com/nicolargo/glances/wiki/The-Glances-API-How-To">https://github.com/nicolargo/glances/wiki/The-Glances-API-How-To</a></p>
 </div>
 <div class="section" id="support">
-<h1><a class="toc-backref" href="#id26">Support</a></h1>
+<h1><a class="toc-backref" href="#id30">Support</a></h1>
 <p>To report a bug or a feature request use the bug tracking system at <a class="reference external" href="https://github.com/nicolargo/glances/issues">https://github.com/nicolargo/glances/issues</a></p>
 <p>Feel free to contribute!</p>
-<table class="docutils footnote" frame="void" id="id2" rules="none">
+<table class="docutils footnote" frame="void" id="id4" rules="none">
 <colgroup><col class="label" /><col /></colgroup>
 <tbody valign="top">
 <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="http://nosheep.net/story/defining-unix-load-average/">http://nosheep.net/story/defining-unix-load-average/</a></td></tr>
 </tbody>
 </table>
+<table class="docutils footnote" frame="void" id="id5" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label">[2]</td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> <a class="reference external" href="http://www.cyberciti.biz/tips/howto-monitor-hard-drive-temperature.html">http://www.cyberciti.biz/tips/howto-monitor-hard-drive-temperature.html</a></td></tr>
+</tbody>
+</table>
+<table class="docutils footnote" frame="void" id="id6" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label">[3]</td><td><a class="reference external" href="https://github.com/nicolargo/batinfo">https://github.com/nicolargo/batinfo</a></td></tr>
+</tbody>
+</table>
 </div>
 </div>
 </body>
diff --git a/docs/glances-doc.rst b/docs/glances-doc.rst
index f9f3c994..89fa6487 100644
--- a/docs/glances-doc.rst
+++ b/docs/glances-doc.rst
@@ -284,12 +284,15 @@ if the bit rate is higher than 70 Mbps.
 Sensors
 -------
 
+Glances can displays the sensors informations trough `lm-sensors` (only
+available on Linux). As of lm-sensors, a filter is processed in order to display temperature only:
+
 .. image:: images/sensors.png
 
-Glances can displays the sensors informations trough `lm-sensors` (only
-available on Linux) and `hddtemp` daemon.
 
-As of lm-sensors, a filter is processed in order to display temperature only.
+Glances can also grab hard disk temperature through the `hddtemp` daemon (see here [2]_ to install hddtemp on your system):
+
+.. image:: images/hddtemp.png
 
 To enable the lm-sensors module:
 
@@ -314,7 +317,7 @@ Disk I/O
 
 Glances displays the disk I/O throughput. The unit is adapted dynamically.
 
-There is no alert on this information.
+*Note*: There is no alert on this information.
 
 File system
 -----------
@@ -403,6 +406,8 @@ New in version 1.7. Optional.
 The monitored processes list allows user, through the configuration file,
 to group processes and quickly show if the number of running process is not good.
 
+.. image:: images/monitored.png
+
 Each item is defined by:
 
 * ``description``: description of the processes (max 16 chars).
@@ -441,6 +446,12 @@ If you also want to monitor the PHP-FPM daemon processes, you should add another
 
 In the client/server mode, the list is define on the server side. A new method (getAllMonitored) is available in the API and get the JSON representation of the monitored processes list.
 
+Alerts are set following:
+
+| If number of processes is 0, then status is set to ``"CRITICAL"``
+| If number of processes is min < curent < max, then status is set to ``"OK"``
+| Else status is set to ``"WARNING"``
+
 Logs
 ----
 
@@ -456,7 +467,7 @@ Each alert message displays the following information:
 1. start date
 2. end date
 3. alert name
-4. {min/avg/max} values (or monitored processes list description)
+4. {min/avg/max} values or number of running pocesses for monitored processes list alerts
 
 Footer
 ------
@@ -465,6 +476,10 @@ Footer
 
 Glances displays the current date & time and access to the embedded help screen.
 
+If one or mode batteries were found on your machine and if the batinfo Python lib [2]_ is installed on your system then Glances display the available percent capacity in the middle on the footer.
+
+.. image:: images/battery.png
+
 If you have ran Glances in client mode ``-c``, you can also see if the client is connected to the server.
 
 If client is connected:
@@ -493,6 +508,8 @@ Feel free to contribute!
 
 
 .. [1] http://nosheep.net/story/defining-unix-load-average/
+.. [2] http://www.cyberciti.biz/tips/howto-monitor-hard-drive-temperature.html
+.. [3] https://github.com/nicolargo/batinfo
 
 .. _psutil: https://code.google.com/p/psutil/
 .. _XML-RPC server: http://docs.python.org/2/library/simplexmlrpcserver.html
diff --git a/docs/images/monitored.png b/docs/images/monitored.png
new file mode 100644
index 00000000..222425c6
--- /dev/null
+++ b/docs/images/monitored.png
diff --git a/docs/images/screenshot-wide.png b/docs/images/screenshot-wide.png
index 223c06f8..e0e3a510 100644
--- a/docs/images/screenshot-wide.png
+++ b/docs/images/screenshot-wide.png
diff --git a/docs/images/screenshot.png b/docs/images/screenshot.png
index 5b8f6bb4..1940adb8 100644
--- a/docs/images/screenshot.png
+++ b/docs/images/screenshot.png
author	Nicolas Hennion <nicolas@nicolargo.com>	2013-08-09 12:27:33 +0200
committer	Nicolas Hennion <nicolas@nicolargo.com>	2013-08-09 12:27:33 +0200
commit	2909357e686823a8a7bdba81ca52d505621380e2 (patch)
tree	d62924d4a8f2fe556f1dd85f3f4d2dce3555f780 /docs
parent	d3c1205831af283a9b6f56b708bb3298d2096938 (diff)