greatbody
/
glances
mirror of https://github.com/nicolargo/glances
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update doc on configuration as per issue #288

pull/298/head
Alessio Sergi 2013-09-19 15:00:00 +02:00
parent 3a4d517985
commit 49f63e4fb3
17 changed files with 163 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_build/doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
docs/_build/doctrees/glances-doc.doctree vendored
View File

Binary file not shown.

BIN
docs/_build/doctrees/index.doctree vendored
View File

Binary file not shown.

2
docs/_build/html/.buildinfo vendored
View File

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9c6c7a85f4b84c6b7c479b3858c2bcdd
config: d0d20961c041fc20aa9ab1847c268834
tags: fbb0d17656682115ca4d033fb2f83ba1

51
docs/_build/html/_sources/glances-doc.txt vendored
View File

@ -2,11 +2,11 @@
Glances
=======
This manual describes *Glances* version 1.7.1.
This manual describes *Glances* version 1.7.2.
Copyright © 2012-2013 Nicolas Hennion <nicolas@nicolargo.com>
August 2013
September 2013
.. contents:: Table of Contents
@ -81,7 +81,7 @@ Command-line options
-b Display network rate in Byte per second (default: bit per second)
-B IP Bind server to the given IPv4/IPv6 address or hostname
-c IP Connect to a Glances server by IPv4/IPv6 address or hostname
-C file Path to the configuration file (default: {/usr/local,}/etc/glances/glances.conf)
-C file Path to the configuration file
-d Disable disk I/O module
-e Enable sensors module (requires pysensors, Linux-only)
-f file Set the HTML output folder or CSV file
@ -157,18 +157,26 @@ Furthermore a configuration file is needed for setup limits and/or monitored pro
By default, the configuration file is under:
.. code-block:: console
:Linux: ``/etc/glances/glances.conf``
:\*BSD and OS X: ``/usr/local/etc/glances/glances.conf``
:Windows: ``%APPDATA%\glances\glances.conf``
/etc/glances/glances.conf (Linux)
or:
On Windows XP, the ``%APPDATA%`` path is:
.. code-block:: console
/usr/local/etc/glances/glances.conf (*BSD and OS X)
C:\Documents and Settings\<User>\Application Data
To override the default configuration, you can copy the ``glances.conf`` file to
your ``$XDG_CONFIG_HOME`` directory (e.g. Linux):
Since Windows Vista and newer versions:
.. code-block:: console
C:\Users\<User>\AppData\Roaming
You can override the default configuration, located in one of the above
directories on your system, except for Windows.
Just copy the ``glances.conf`` file to your ``$XDG_CONFIG_HOME`` directory, e.g. Linux:
.. code-block:: console
@ -286,8 +294,9 @@ 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:
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
@ -420,12 +429,12 @@ Each item is defined by:
Up to 10 items can be defined.
For example, if you want to monitor the NGINX processes on a Web server, the following definition should do the job:
For example, if you want to monitor the Nginx processes on a Web server, the following definition should do the job:
.. code-block:: console
[monitor]
list_1_description=NGINX server
list_1_description=Nginx server
list_1_regex=.*nginx.*
list_1_command=nginx -v
list_1_countmin=1
@ -436,7 +445,7 @@ If you also want to monitor the PHP-FPM daemon processes, you should add another
.. code-block:: console
[monitor]
list_1_description=NGINX server
list_1_description=Nginx server
list_1_regex=.*nginx.*
list_1_command=nginx -v
list_1_countmin=1
@ -446,12 +455,13 @@ If you also want to monitor the PHP-FPM daemon processes, you should add another
list_1_countmin=1
list_1_countmax=20
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.
In client/server mode, the list is defined on the server side.
A new method, called getAllMonitored, is available in the APIs and get the JSON representation of the monitored processes list.
Alerts are set following:
Alerts are set as 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"``
| If number of processes is min < current < max, then status is set to ``"OK"``
| Else status is set to ``"WARNING"``
Logs
@ -469,7 +479,7 @@ Each alert message displays the following information:
1. start date
2. end date
3. alert name
4. {min/avg/max} values or number of running pocesses for monitored processes list alerts
4. {min/avg/max} values or number of running processes for monitored processes list alerts
Footer
------
@ -478,7 +488,8 @@ 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 library [3]_ is installed on your system then Glances displays the available percent capacity in the middle on the footer.
If one or mode batteries were found on your machine and if the batinfo Python library [3]_
is installed on your system then Glances displays the available percent capacity in the middle on the footer.
.. image:: images/battery.png

5
docs/_build/html/_sources/index.txt vendored
View File

@ -3,15 +3,14 @@ Welcome to Glances's documentation!
**Glances** is a cross-platform curses-based monitoring tool written in Python.
It uses the PSUtil library and some internal code to get information from your system.
It uses the psutil library and some internal code to get information from your system.
.. image:: https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png
Get the code
------------
The `source <http://github.com/nicolargo/glances>`_ is available on Github.
The `source <http://github.com/nicolargo/glances>`_ is available on GitHub.
Contents
--------

10
docs/_build/html/genindex.html vendored
View File

@ -10,7 +10,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; Glances 1.7.1 documentation</title>
<title>Index &mdash; Glances 1.7.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -18,7 +18,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.1',
VERSION: '1.7.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -27,7 +27,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Glances 1.7.1 documentation" href="index.html" />
<link rel="top" title="Glances 1.7.2 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -36,7 +36,7 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">Glances 1.7.1 documentation</a> &raquo;</li>
<li><a href="index.html">Glances 1.7.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -84,7 +84,7 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li><a href="index.html">Glances 1.7.1 documentation</a> &raquo;</li>
<li><a href="index.html">Glances 1.7.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

62
docs/_build/html/glances-doc.html vendored
View File

@ -8,7 +8,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Glances &mdash; Glances 1.7.1 documentation</title>
<title>Glances &mdash; Glances 1.7.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -16,7 +16,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.1',
VERSION: '1.7.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -25,7 +25,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Glances 1.7.1 documentation" href="index.html" />
<link rel="top" title="Glances 1.7.2 documentation" href="index.html" />
<link rel="prev" title="Welcome to Glances’s documentation!" href="index.html" />
</head>
<body>
@ -38,7 +38,7 @@
<li class="right" >
<a href="index.html" title="Welcome to Glances’s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Glances 1.7.1 documentation</a> &raquo;</li>
<li><a href="index.html">Glances 1.7.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -49,9 +49,9 @@
<div class="section" id="glances">
<h1><a class="toc-backref" href="#id7">Glances</a><a class="headerlink" href="#glances" title="Permalink to this headline"></a></h1>
<p>This manual describes <em>Glances</em> version 1.7.1.</p>
<p>This manual describes <em>Glances</em> version 1.7.2.</p>
<p>Copyright © 2012-2013 Nicolas Hennion &lt;<a class="reference external" href="mailto:nicolas&#37;&#52;&#48;nicolargo&#46;com">nicolas<span>&#64;</span>nicolargo<span>&#46;</span>com</a>&gt;</p>
<p>August 2013</p>
<p>September 2013</p>
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
@ -151,7 +151,7 @@ just run on the server:</p>
<td>Connect to a Glances server by IPv4/IPv6 address or hostname</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-C <var>file</var></span></kbd></td>
<td>Path to the configuration file (default: {/usr/local,}/etc/glances/glances.conf)</td></tr>
<td>Path to the configuration file</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-d</span></kbd></td>
<td>Disable disk I/O module</td></tr>
@ -259,15 +259,29 @@ just run on the server:</p>
<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>
<div class="highlight-console"><div class="highlight"><pre><span class="go">/etc/glances/glances.conf (Linux)</span>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Linux:</th><td class="field-body"><tt class="docutils literal"><span class="pre">/etc/glances/glances.conf</span></tt></td>
</tr>
<tr class="field-even field"><th class="field-name">*BSD and OS X:</th><td class="field-body"><tt class="docutils literal"><span class="pre">/usr/local/etc/glances/glances.conf</span></tt></td>
</tr>
<tr class="field-odd field"><th class="field-name">Windows:</th><td class="field-body"><tt class="docutils literal"><span class="pre">%APPDATA%\glances\glances.conf</span></tt></td>
</tr>
</tbody>
</table>
<p>On Windows XP, the <tt class="docutils literal"><span class="pre">%APPDATA%</span></tt> path is:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="go">C:\Documents and Settings\&lt;User&gt;\Application Data</span>
</pre></div>
</div>
<p>or:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="go">/usr/local/etc/glances/glances.conf (*BSD and OS X)</span>
<p>Since Windows Vista and newer versions:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="go">C:\Users\&lt;User&gt;\AppData\Roaming</span>
</pre></div>
</div>
<p>To override the default configuration, you can copy the <tt class="docutils literal"><span class="pre">glances.conf</span></tt> file to
your <tt class="docutils literal"><span class="pre">$XDG_CONFIG_HOME</span></tt> directory (e.g. Linux):</p>
<p>You can override the default configuration, located in one of the above
directories on your system, except for Windows.</p>
<p>Just copy the <tt class="docutils literal"><span class="pre">glances.conf</span></tt> file to your <tt class="docutils literal"><span class="pre">$XDG_CONFIG_HOME</span></tt> directory, e.g. Linux:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="go">mkdir -p $XDG_CONFIG_HOME/glances</span>
<span class="go">cp /etc/glances/glances.conf $XDG_CONFIG_HOME/glances/</span>
</pre></div>
@ -361,8 +375,8 @@ if the bit rate is higher than 70 Mbps.</p>
</div>
<div class="section" id="sensors">
<h3><a class="toc-backref" href="#id23">Sensors</a><a class="headerlink" href="#sensors" title="Permalink to this headline"></a></h3>
<p>Glances can displays the sensors informations trough <cite>lm-sensors</cite> (only
available on Linux). As of lm-sensors, a filter is processed in order to display temperature only:</p>
<p>Glances can displays the sensors informations trough <cite>lm-sensors</cite> (only available on Linux).</p>
<p>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" />
@ -468,9 +482,9 @@ to group processes and quickly show if the number of running process is not good
<li><tt class="docutils literal"><span class="pre">countmax</span></tt> (optional): maximum number of processes. A warning will be displayed if number of processes &gt; count.</li>
</ul>
<p>Up to 10 items can be defined.</p>
<p>For example, if you want to monitor the NGINX processes on a Web server, the following definition should do the job:</p>
<p>For example, if you want to monitor the Nginx processes on a Web server, the following definition should do the job:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="go">[monitor]</span>
<span class="go">list_1_description=NGINX server</span>
<span class="go">list_1_description=Nginx server</span>
<span class="go">list_1_regex=.*nginx.*</span>
<span class="go">list_1_command=nginx -v</span>
<span class="go">list_1_countmin=1</span>
@ -479,7 +493,7 @@ to group processes and quickly show if the number of running process is not good
</div>
<p>If you also want to monitor the PHP-FPM daemon processes, you should add another item:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="go">[monitor]</span>
<span class="go">list_1_description=NGINX server</span>
<span class="go">list_1_description=Nginx server</span>
<span class="go">list_1_regex=.*nginx.*</span>
<span class="go">list_1_command=nginx -v</span>
<span class="go">list_1_countmin=1</span>
@ -490,11 +504,12 @@ to group processes and quickly show if the number of running process is not good
<span class="go">list_1_countmax=20</span>
</pre></div>
</div>
<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>
<p>In client/server mode, the list is defined on the server side.
A new method, called getAllMonitored, is available in the APIs and get the JSON representation of the monitored processes list.</p>
<p>Alerts are set as following:</p>
<div class="line-block">
<div class="line">If number of processes is 0, then status is set to <tt class="docutils literal"><span class="pre">&quot;CRITICAL&quot;</span></tt></div>
<div class="line">If number of processes is min &lt; curent &lt; max, then status is set to <tt class="docutils literal"><span class="pre">&quot;OK&quot;</span></tt></div>
<div class="line">If number of processes is min &lt; current &lt; max, then status is set to <tt class="docutils literal"><span class="pre">&quot;OK&quot;</span></tt></div>
<div class="line">Else status is set to <tt class="docutils literal"><span class="pre">&quot;WARNING&quot;</span></tt></div>
</div>
</div>
@ -511,14 +526,15 @@ to group processes and quickly show if the number of running process is not good
<li>start date</li>
<li>end date</li>
<li>alert name</li>
<li>{min/avg/max} values or number of running pocesses for monitored processes list alerts</li>
<li>{min/avg/max} values or number of running processes for monitored processes list alerts</li>
</ol>
</div>
<div class="section" id="footer">
<h3><a class="toc-backref" href="#id29">Footer</a><a class="headerlink" href="#footer" title="Permalink to this headline"></a></h3>
<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 library <a class="footnote-reference" href="#id6" id="id3">[3]</a> is installed on your system then Glances displays the available percent capacity in the middle on the footer.</p>
<p>If one or mode batteries were found on your machine and if the batinfo Python library <a class="footnote-reference" href="#id6" id="id3">[3]</a>
is installed on your system then Glances displays 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>
@ -635,7 +651,7 @@ to group processes and quickly show if the number of running process is not good
<li class="right" >
<a href="index.html" title="Welcome to Glances’s documentation!"
>previous</a> |</li>
<li><a href="index.html">Glances 1.7.1 documentation</a> &raquo;</li>
<li><a href="index.html">Glances 1.7.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

14
docs/_build/html/index.html vendored
View File

@ -8,7 +8,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to Glances’s documentation! &mdash; Glances 1.7.1 documentation</title>
<title>Welcome to Glances’s documentation! &mdash; Glances 1.7.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -16,7 +16,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.1',
VERSION: '1.7.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -25,7 +25,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Glances 1.7.1 documentation" href="#" />
<link rel="top" title="Glances 1.7.2 documentation" href="#" />
<link rel="next" title="Glances" href="glances-doc.html" />
</head>
<body>
@ -38,7 +38,7 @@
<li class="right" >
<a href="glances-doc.html" title="Glances"
accesskey="N">next</a> |</li>
<li><a href="#">Glances 1.7.1 documentation</a> &raquo;</li>
<li><a href="#">Glances 1.7.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -50,11 +50,11 @@
<div class="section" id="welcome-to-glances-s-documentation">
<h1>Welcome to Glances&#8217;s documentation!<a class="headerlink" href="#welcome-to-glances-s-documentation" title="Permalink to this headline"></a></h1>
<p><strong>Glances</strong> is a cross-platform curses-based monitoring tool written in Python.</p>
<p>It uses the PSUtil library and some internal code to get information from your system.</p>
<p>It uses the psutil library and some internal code to get information from your system.</p>
<img alt="https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png" src="https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png" />
<div class="section" id="get-the-code">
<h2>Get the code<a class="headerlink" href="#get-the-code" title="Permalink to this headline"></a></h2>
<p>The <a class="reference external" href="http://github.com/nicolargo/glances">source</a> is available on Github.</p>
<p>The <a class="reference external" href="http://github.com/nicolargo/glances">source</a> is available on GitHub.</p>
</div>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
@ -135,7 +135,7 @@
<li class="right" >
<a href="glances-doc.html" title="Glances"
>next</a> |</li>
<li><a href="#">Glances 1.7.1 documentation</a> &raquo;</li>
<li><a href="#">Glances 1.7.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

BIN
docs/_build/html/objects.inv vendored
View File

Binary file not shown.

10
docs/_build/html/search.html vendored
View File

@ -8,7 +8,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; Glances 1.7.1 documentation</title>
<title>Search &mdash; Glances 1.7.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -16,7 +16,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.1',
VERSION: '1.7.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -26,7 +26,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="Glances 1.7.1 documentation" href="index.html" />
<link rel="top" title="Glances 1.7.2 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
@ -40,7 +40,7 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">Glances 1.7.1 documentation</a> &raquo;</li>
<li><a href="index.html">Glances 1.7.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -88,7 +88,7 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">Glances 1.7.1 documentation</a> &raquo;</li>
<li><a href="index.html">Glances 1.7.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

2
docs/_build/html/searchindex.js vendored
View File

@ -1 +1 @@
Search.setIndex({objects:{},terms:{represent:0,all:0,code:1,global:0,sleep:0,follow:0,disk:0,compact:0,middl:0,depend:0,swap:0,under:0,list_1_command:0,sourc:1,string:0,iowait:0,trough:0,pocess:0,level:0,list:0,item:0,rate:0,port:0,compat:0,index:1,hide:0,sum:0,access:0,delet:0,version:0,"new":0,net:0,method:0,full:0,mem:0,batinfo:0,here:0,address:0,path:0,legend:0,valu:0,wait:0,search:1,queue:0,throughput:0,list_1_countmax:0,modul:[0,1],unix:0,api:[0,1],xdg_config_hom:0,instal:0,total:0,unit:0,regex:0,from:[0,1],describ:0,memori:0,two:0,call:0,usr:0,sort:0,warn:0,flag:0,setup:0,work:0,can:0,root:0,overrid:0,process:0,indic:1,critic:0,minimum:0,caution:0,want:0,magenta:0,occur:0,end:0,fpm:0,anoth:0,write:0,how:0,csv:0,max:0,date:0,averag:0,github:[0,1],footer:0,bind:0,countmin:0,issu:0,inform:[0,1],"switch":0,curent:0,green:0,allow:0,ethernet:0,order:0,hennion:0,cyberc:0,help:0,over:0,privileg:0,dynam:0,group:0,monitor:[0,1],fit:0,platform:[0,1],good:0,"return":0,python:[0,1],interrupt:0,introduct:[0,1],name:0,refresh:0,psutil:[0,1],mode:0,each:0,found:0,side:0,hard:0,connect:0,tirrel:0,shown:0,network:0,space:0,content:[0,1],adapt:0,sensor:0,red:0,free:0,standalon:0,base:[0,1],zombi:0,releas:0,"byte":0,care:0,mbit:0,filter:0,summari:0,first:0,softwar:0,feel:0,number:0,system:[0,1],mai:0,messag:0,size:0,sheep:0,given:0,script:0,interact:0,mkdir:0,capac:0,least:0,stori:0,cumul:0,termin:0,listen:0,shell:0,consol:0,option:0,tool:[0,1],copi:0,"short":0,hddtemp:0,list_1_regex:0,than:0,remot:0,second:0,horizont:0,were:0,consumpt:0,minut:0,zachari:0,counter:0,ran:0,ram:0,have:0,tabl:[0,1],need:0,min:0,note:0,also:0,ideal:0,client:0,which:0,combin:0,singl:0,anatomi:[0,1],blue:0,trace:0,track:0,regular:0,"80x24":0,bsd:0,request:0,drive:0,section:0,show:0,xml:0,current:0,onli:0,execut:0,copyright:0,configur:[0,1],written:[0,1],should:0,folder:0,local:0,overwritten:0,hit:0,contribut:0,get:[0,1],express:0,stop:0,report:0,requir:0,enabl:0,through:0,grab:0,where:0,view:0,wiki:0,kernel:0,set:0,displai:0,see:0,sec:0,statu:0,extend:0,list_1_descript:0,enough:0,between:0,attribut:0,hddtemperatur:0,august:0,kei:0,screen:0,job:0,addit:0,etc:0,com:0,load:0,simpli:0,color:0,period:0,header:0,rpc:0,linux:0,batteri:0,nicola:0,quit:0,three:0,json:0,quickli:0,present:0,mount:0,aim:0,defin:0,"while":0,mandatori:0,file:0,list_1_countmin:0,virt:0,conf:0,nicolargo:0,avg:0,welcom:1,minim:0,cross:[0,1],html:0,nosheep:0,document:[0,1],higher:0,finish:0,http:0,hostnam:0,iow:0,ior:0,alert:0,user:0,php:0,exampl:0,command:[0,1],thi:0,filesystem:0,left:0,just:0,tip:0,tcp:0,speed:0,web:0,blog:0,add:0,els:0,applic:[0,1],read:0,howto:0,nginx:0,temperatur:0,biz:0,press:0,bit:0,password:0,daemon:0,resid:0,manual:0,server:0,kbit:0,output:0,architectur:0,page:1,www:0,some:[0,1],percentag:0,intern:1,librari:[0,1],bottom:0,definit:0,per:0,pysensor:0,exit:0,ipv4:0,refer:[0,1],machin:0,core:0,plu:0,run:0,bold:0,usag:[0,1],column:0,disabl:0,countmax:0,automat:0,mbp:0,your:[0,1],log:0,support:[0,1],avail:[0,1],start:0,interfac:0,low:0,ipv6:0,line:0,bug:0,count:0,"default":0,maximum:0,limit:0,embed:0,featur:0,curs:[0,1],classic:0,pid:0,"char":0,glanc:[0,1],percent:0,virtual:0,you:0,nice:0,stat:0,easili:0,furthermor:0,directori:0,descript:0,getallmonitor:0,time:0,cpu:0},objtypes:{},titles:["Glances","Welcome to Glances&#8217;s documentation!"],objnames:{},filenames:["glances-doc","index"]})
Search.setIndex({objects:{},terms:{represent:0,all:0,code:1,appdata:0,global:0,sleep:0,follow:0,disk:0,compact:0,middl:0,depend:0,swap:0,under:0,list_1_command:0,sourc:1,string:0,iowait:0,trough:0,pocess:[],level:0,list:0,item:0,rate:0,port:0,compat:0,index:1,hide:0,sum:0,access:0,delet:0,version:0,"new":0,net:0,method:0,full:0,mem:0,batinfo:0,here:0,address:0,path:0,legend:0,valu:0,wait:0,search:1,queue:0,throughput:0,list_1_countmax:0,modul:[0,1],unix:0,api:[0,1],xdg_config_hom:0,instal:0,total:0,unit:0,regex:0,from:[0,1],describ:0,memori:0,two:0,call:0,usr:0,sort:0,warn:0,flag:0,setup:0,work:0,can:0,root:0,overrid:0,process:0,indic:1,critic:0,minimum:0,caution:0,want:0,magenta:0,occur:0,end:0,fpm:0,anoth:0,write:0,how:0,low:0,csv:0,max:0,mai:0,data:0,averag:0,"short":0,footer:0,bind:0,counter:0,issu:0,inform:[0,1],"switch":0,curent:[],combin:0,allow:0,ethernet:0,order:0,hennion:0,cyberc:0,help:0,over:0,privileg:0,dynam:0,group:0,monitor:[0,1],fit:0,platform:[0,1],window:0,good:0,"return":0,python:[0,1],interrupt:0,introduct:[0,1],name:0,refresh:0,psutil:[0,1],mode:0,each:0,found:0,side:0,hard:0,connect:0,tirrel:0,shown:0,network:0,space:0,content:[0,1],adapt:0,sensor:0,red:0,free:0,standalon:0,base:[0,1],zombi:0,releas:0,"byte":0,care:0,mbit:0,filter:0,view:0,first:0,softwar:0,feel:0,number:0,system:[0,1],date:0,messag:0,size:0,sheep:0,given:0,script:0,interact:0,mkdir:0,capac:0,least:0,stori:0,cumul:0,termin:0,listen:0,shell:0,consol:0,option:0,tool:[0,1],copi:0,github:[0,1],hddtemp:0,list_1_regex:0,than:0,remot:0,second:0,horizont:0,were:0,consumpt:0,minut:0,zachari:0,countmin:0,ran:0,ram:0,have:0,tabl:[0,1],need:0,min:0,note:0,also:0,ideal:0,client:0,which:0,green:0,singl:0,anatomi:[0,1],blue:0,trace:0,track:0,regular:0,"80x24":0,bsd:0,request:0,drive:0,section:0,show:0,xml:0,current:0,onli:0,locat:0,execut:0,copyright:0,configur:[0,1],written:[0,1],should:0,folder:0,local:0,overwritten:0,hit:0,contribut:0,get:[0,1],express:0,stop:0,report:0,requir:0,enabl:0,through:0,grab:0,septemb:0,where:0,summari:0,wiki:0,kernel:0,set:0,maximum:0,see:0,sec:0,statu:0,kei:0,list_1_descript:0,enough:0,between:0,attribut:0,hddtemperatur:0,august:[],extend:0,screen:0,job:0,addit:0,etc:0,com:0,load:0,simpli:0,color:0,period:0,header:0,rpc:0,linux:0,batteri:0,nicola:0,quit:0,three:0,sinc:0,json:0,quickli:0,present:0,mount:0,aim:0,defin:0,"while":0,abov:0,mandatori:0,glanc:[0,1],list_1_countmin:0,virt:0,conf:0,nicolargo:0,avg:0,welcom:1,minim:0,cross:[0,1],html:0,nosheep:0,document:[0,1],higher:0,finish:0,http:0,hostnam:0,iow:0,ior:0,alert:0,user:0,php:0,exampl:0,command:[0,1],thi:0,filesystem:0,left:0,just:0,percent:0,tcp:0,speed:0,web:0,except:0,blog:0,add:0,els:0,applic:[0,1],read:0,howto:0,nginx:0,temperatur:0,biz:0,press:0,bit:0,password:0,daemon:0,resid:0,manual:0,server:0,kbit:0,output:0,nice:0,page:1,www:0,some:[0,1],percentag:0,intern:1,librari:[0,1],bottom:0,definit:0,per:0,pysensor:0,exit:0,refer:[0,1],machin:0,core:0,plu:0,run:0,bold:0,usag:[0,1],column:0,roam:0,disabl:0,countmax:0,automat:0,mbp:0,your:[0,1],log:0,support:[0,1],avail:[0,1],start:0,interfac:0,ipv4:0,ipv6:0,newer:0,line:0,bug:0,count:0,"default":0,displai:0,limit:0,embed:0,featur:0,curs:[0,1],classic:0,pid:0,"char":0,file:0,vista:0,tip:0,virtual:0,you:0,architectur:0,stat:0,easili:0,furthermor:0,directori:0,descript:0,getallmonitor:0,time:0,cpu:0},objtypes:{},titles:["Glances","Welcome to Glances&#8217;s documentation!"],objnames:{},filenames:["glances-doc","index"]})

4
docs/conf.py
View File

@ -48,9 +48,9 @@ copyright = u'2013, Nicolas Hennion'
# built documents.
#
# The short X.Y version.
version = '1.7.1'
version = '1.7.2'
# The full version, including alpha/beta/rc tags.
release = '1.7.1'
release = '1.7.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

54
docs/glances-doc.html
View File

@ -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.10: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils 0.11: http://docutils.sourceforge.net/" />
<title>Glances</title>
<style type="text/css">
@ -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 1.7.1.</p>
<p>This manual describes <em>Glances</em> version 1.7.2.</p>
<p>Copyright © 2012-2013 Nicolas Hennion &lt;<a class="reference external" href="mailto:nicolas&#64;nicolargo.com">nicolas&#64;nicolargo.com</a>&gt;</p>
<p>August 2013</p>
<p>September 2013</p>
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
@ -222,7 +222,7 @@ just run on the server:</p>
<td>Connect to a Glances server by IPv4/IPv6 address or hostname</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-C <var>file</var></span></kbd></td>
<td>Path to the configuration file (default: {/usr/local,}/etc/glances/glances.conf)</td></tr>
<td>Path to the configuration file</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-d</span></kbd></td>
<td>Disable disk I/O module</td></tr>
@ -330,15 +330,29 @@ just run on the server:</p>
<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>
<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">Linux:</th><td class="field-body"><tt class="docutils literal">/etc/glances/glances.conf</tt></td>
</tr>
<tr class="field"><th class="field-name">*BSD and OS X:</th><td class="field-body"><tt class="docutils literal">/usr/local/etc/glances/glances.conf</tt></td>
</tr>
<tr class="field"><th class="field-name">Windows:</th><td class="field-body"><tt class="docutils literal"><span class="pre">%APPDATA%\glances\glances.conf</span></tt></td>
</tr>
</tbody>
</table>
<p>On Windows XP, the <tt class="docutils literal">%APPDATA%</tt> path is:</p>
<pre class="code console literal-block">
<span class="generic output">/etc/glances/glances.conf (Linux)</span>
<span class="generic output">C:\Documents and Settings\&lt;User&gt;\Application Data</span>
</pre>
<p>or:</p>
<p>Since Windows Vista and newer versions:</p>
<pre class="code console literal-block">
<span class="generic output">/usr/local/etc/glances/glances.conf (*BSD and OS X)</span>
<span class="generic output">C:\Users\&lt;User&gt;\AppData\Roaming</span>
</pre>
<p>To override the default configuration, you can copy the <tt class="docutils literal">glances.conf</tt> file to
your <tt class="docutils literal">$XDG_CONFIG_HOME</tt> directory (e.g. Linux):</p>
<p>You can override the default configuration, located in one of the above
directories on your system, except for Windows.</p>
<p>Just copy the <tt class="docutils literal">glances.conf</tt> file to your <tt class="docutils literal">$XDG_CONFIG_HOME</tt> directory, e.g. Linux:</p>
<pre class="code console literal-block">
<span class="generic output">mkdir -p $XDG_CONFIG_HOME/glances
cp /etc/glances/glances.conf $XDG_CONFIG_HOME/glances/</span>
@ -432,8 +446,8 @@ if the bit rate is higher than 70 Mbps.</p>
</div>
<div class="section" id="sensors">
<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). As of lm-sensors, a filter is processed in order to display temperature only:</p>
<p>Glances can displays the sensors informations trough <cite>lm-sensors</cite> (only available on Linux).</p>
<p>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" />
@ -539,10 +553,10 @@ to group processes and quickly show if the number of running process is not good
<li><tt class="docutils literal">countmax</tt> (optional): maximum number of processes. A warning will be displayed if number of processes &gt; count.</li>
</ul>
<p>Up to 10 items can be defined.</p>
<p>For example, if you want to monitor the NGINX processes on a Web server, the following definition should do the job:</p>
<p>For example, if you want to monitor the Nginx processes on a Web server, the following definition should do the job:</p>
<pre class="code console literal-block">
<span class="generic output">[monitor]
list_1_description=NGINX server
list_1_description=Nginx server
list_1_regex=.*nginx.*
list_1_command=nginx -v
list_1_countmin=1
@ -551,7 +565,7 @@ list_1_countmax=4</span>
<p>If you also want to monitor the PHP-FPM daemon processes, you should add another item:</p>
<pre class="code console literal-block">
<span class="generic output">[monitor]
list_1_description=NGINX server
list_1_description=Nginx server
list_1_regex=.*nginx.*
list_1_command=nginx -v
list_1_countmin=1
@ -561,11 +575,12 @@ 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>
<p>In client/server mode, the list is defined on the server side.
A new method, called getAllMonitored, is available in the APIs and get the JSON representation of the monitored processes list.</p>
<p>Alerts are set as 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">If number of processes is min &lt; current &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>
@ -582,14 +597,15 @@ list_1_countmax=20</span>
<li>start date</li>
<li>end date</li>
<li>alert name</li>
<li>{min/avg/max} values or number of running pocesses for monitored processes list alerts</li>
<li>{min/avg/max} values or number of running processes for monitored processes list alerts</li>
</ol>
</div>
<div class="section" id="footer">
<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 library <a class="footnote-reference" href="#id6" id="id3">[3]</a> is installed on your system then Glances displays the available percent capacity in the middle on the footer.</p>
<p>If one or mode batteries were found on your machine and if the batinfo Python library <a class="footnote-reference" href="#id6" id="id3">[3]</a>
is installed on your system then Glances displays 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>

51
docs/glances-doc.rst
View File

@ -2,11 +2,11 @@
Glances
=======
This manual describes *Glances* version 1.7.1.
This manual describes *Glances* version 1.7.2.
Copyright © 2012-2013 Nicolas Hennion <nicolas@nicolargo.com>
August 2013
September 2013
.. contents:: Table of Contents
@ -81,7 +81,7 @@ Command-line options
-b Display network rate in Byte per second (default: bit per second)
-B IP Bind server to the given IPv4/IPv6 address or hostname
-c IP Connect to a Glances server by IPv4/IPv6 address or hostname
-C file Path to the configuration file (default: {/usr/local,}/etc/glances/glances.conf)
-C file Path to the configuration file
-d Disable disk I/O module
-e Enable sensors module (requires pysensors, Linux-only)
-f file Set the HTML output folder or CSV file
@ -157,18 +157,26 @@ Furthermore a configuration file is needed for setup limits and/or monitored pro
By default, the configuration file is under:
.. code-block:: console
:Linux: ``/etc/glances/glances.conf``
:\*BSD and OS X: ``/usr/local/etc/glances/glances.conf``
:Windows: ``%APPDATA%\glances\glances.conf``
/etc/glances/glances.conf (Linux)
or:
On Windows XP, the ``%APPDATA%`` path is:
.. code-block:: console
/usr/local/etc/glances/glances.conf (*BSD and OS X)
C:\Documents and Settings\<User>\Application Data
To override the default configuration, you can copy the ``glances.conf`` file to
your ``$XDG_CONFIG_HOME`` directory (e.g. Linux):
Since Windows Vista and newer versions:
.. code-block:: console
C:\Users\<User>\AppData\Roaming
You can override the default configuration, located in one of the above
directories on your system, except for Windows.
Just copy the ``glances.conf`` file to your ``$XDG_CONFIG_HOME`` directory, e.g. Linux:
.. code-block:: console
@ -286,8 +294,9 @@ 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:
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
@ -420,12 +429,12 @@ Each item is defined by:
Up to 10 items can be defined.
For example, if you want to monitor the NGINX processes on a Web server, the following definition should do the job:
For example, if you want to monitor the Nginx processes on a Web server, the following definition should do the job:
.. code-block:: console
[monitor]
list_1_description=NGINX server
list_1_description=Nginx server
list_1_regex=.*nginx.*
list_1_command=nginx -v
list_1_countmin=1
@ -436,7 +445,7 @@ If you also want to monitor the PHP-FPM daemon processes, you should add another
.. code-block:: console
[monitor]
list_1_description=NGINX server
list_1_description=Nginx server
list_1_regex=.*nginx.*
list_1_command=nginx -v
list_1_countmin=1
@ -446,12 +455,13 @@ If you also want to monitor the PHP-FPM daemon processes, you should add another
list_1_countmin=1
list_1_countmax=20
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.
In client/server mode, the list is defined on the server side.
A new method, called getAllMonitored, is available in the APIs and get the JSON representation of the monitored processes list.
Alerts are set following:
Alerts are set as 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"``
| If number of processes is min < current < max, then status is set to ``"OK"``
| Else status is set to ``"WARNING"``
Logs
@ -469,7 +479,7 @@ Each alert message displays the following information:
1. start date
2. end date
3. alert name
4. {min/avg/max} values or number of running pocesses for monitored processes list alerts
4. {min/avg/max} values or number of running processes for monitored processes list alerts
Footer
------
@ -478,7 +488,8 @@ 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 library [3]_ is installed on your system then Glances displays the available percent capacity in the middle on the footer.
If one or mode batteries were found on your machine and if the batinfo Python library [3]_
is installed on your system then Glances displays the available percent capacity in the middle on the footer.
.. image:: images/battery.png

5
docs/index.rst
View File

@ -3,15 +3,14 @@ Welcome to Glances's documentation!
**Glances** is a cross-platform curses-based monitoring tool written in Python.
It uses the PSUtil library and some internal code to get information from your system.
It uses the psutil library and some internal code to get information from your system.
.. image:: https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png
Get the code
------------
The `source <http://github.com/nicolargo/glances>`_ is available on Github.
The `source <http://github.com/nicolargo/glances>`_ is available on GitHub.
Contents
--------

4
docs/man/glances.1
View File

@ -1,4 +1,4 @@
.TH glances 1 "August, 2013" "version 1.7.1" "USER COMMANDS"
.TH glances 1 "September, 2013" "version 1.7.2" "USER COMMANDS"
.SH NAME
glances \- A cross-platform curses-based monitoring tool
.SH SYNOPSIS
@ -26,7 +26,7 @@ Bind server to the given IPv4/IPv6 address or hostname
Connect to a Glances server by IPv4/IPv6 address or hostname
.TP
.B \-C file
Path to the configuration file (default: {/usr/local,}/etc/glances/glances.conf)
Path to the configuration file
.TP
.B \-d
Disable disk I/O module