diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index bdcbea07..fa98c630 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/glances-doc.doctree b/docs/_build/doctrees/glances-doc.doctree index 1894b55d..643b2d81 100644 Binary files a/docs/_build/doctrees/glances-doc.doctree and b/docs/_build/doctrees/glances-doc.doctree differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree index e564c3f9..08503948 100644 Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo index b901d93b..af0bbba1 100644 --- a/docs/_build/html/.buildinfo +++ b/docs/_build/html/.buildinfo @@ -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 diff --git a/docs/_build/html/_sources/glances-doc.txt b/docs/_build/html/_sources/glances-doc.txt index 989a3746..bfb62e37 100644 --- a/docs/_build/html/_sources/glances-doc.txt +++ b/docs/_build/html/_sources/glances-doc.txt @@ -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 -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\\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\\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 diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt index cc5deb41..b03349f3 100644 --- a/docs/_build/html/_sources/index.txt +++ b/docs/_build/html/_sources/index.txt @@ -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 `_ is available on Github. +The `source `_ is available on GitHub. Contents -------- diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index 83673aaa..63ec4c2c 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -10,7 +10,7 @@ - Index — Glances 1.7.1 documentation + Index — Glances 1.7.2 documentation @@ -18,7 +18,7 @@ - + @@ -84,7 +84,7 @@
  • index
  • -
  • Glances 1.7.1 documentation »
  • +
  • Glances 1.7.2 documentation »
  • @@ -49,9 +49,9 @@

    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

    Table of Contents

      @@ -151,7 +151,7 @@ just run on the server:

      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) +Path to the configuration file -d Disable disk I/O module @@ -259,15 +259,29 @@ just run on the server:

      No configuration file is mandatory to use Glances.

      Furthermore a configuration file is needed for setup limits and/or monitored processes list.

      By default, the configuration file is under:

      -
      /etc/glances/glances.conf (Linux)
      +
      +++
      +
      +
      +
      +
      +
      +
      +
      +
      Linux:/etc/glances/glances.conf
      *BSD and OS X:/usr/local/etc/glances/glances.conf
      Windows:%APPDATA%\glances\glances.conf
      +

      On Windows XP, the %APPDATA% path is:

      +
      C:\Documents and Settings\<User>\Application Data
       
      -

      or:

      -
      /usr/local/etc/glances/glances.conf (*BSD and OS X)
      +

      Since Windows Vista and newer versions:

      +
      C:\Users\<User>\AppData\Roaming
       
      -

      To override the default configuration, you can copy the glances.conf file to -your $XDG_CONFIG_HOME directory (e.g. Linux):

      +

      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:

      mkdir -p $XDG_CONFIG_HOME/glances
       cp /etc/glances/glances.conf $XDG_CONFIG_HOME/glances/
       
      @@ -361,8 +375,8 @@ 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:

      _images/sensors.png

      Glances can also grab hard disk temperature through the hddtemp daemon (see here [2] to install hddtemp on your system):

      _images/hddtemp.png @@ -468,9 +482,9 @@ to group processes and quickly show if the number of running process is not good
    • countmax (optional): maximum number of processes. A warning will be displayed if number of processes > count.

    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:

    [monitor]
    -list_1_description=NGINX server
    +list_1_description=Nginx server
     list_1_regex=.*nginx.*
     list_1_command=nginx -v
     list_1_countmin=1
    @@ -479,7 +493,7 @@ to group processes and quickly show if the number of running process is not good
     

    If you also want to monitor the PHP-FPM daemon processes, you should add another item:

    [monitor]
    -list_1_description=NGINX server
    +list_1_description=Nginx server
     list_1_regex=.*nginx.*
     list_1_command=nginx -v
     list_1_countmin=1
    @@ -490,11 +504,12 @@ to group processes and quickly show if the number of running process is not good
     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.

    -

    Alerts are set following:

    +

    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 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"
    @@ -511,14 +526,15 @@ to group processes and quickly show if the number of running process is not good
  • start date
  • end date
  • alert name
  • -
  • {min/avg/max} values or number of running pocesses for monitored processes list alerts
  • +
  • {min/avg/max} values or number of running processes for monitored processes list alerts
  • @@ -50,11 +50,11 @@

    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.

    https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png

    Get the code

    -

    The source is available on Github.

    +

    The source is available on GitHub.

    Contents

    @@ -135,7 +135,7 @@
  • next |
  • -
  • Glances 1.7.1 documentation »
  • +
  • Glances 1.7.2 documentation »
  • @@ -88,7 +88,7 @@
  • index
  • -
  • Glances 1.7.1 documentation »
  • +
  • Glances 1.7.2 documentation »