diff options
| author | Alessio Sergi <al3hex@gmail.com> | 2014-06-08 20:44:49 +0200 |
|---|---|---|
| committer | Alessio Sergi <al3hex@gmail.com> | 2014-06-08 21:08:33 +0200 |
| commit | b1d8e7a26036db927acdf8ec19fb7e4f76e3e189 (patch) | |
| tree | 48fd3004ec3b7bea84b0e70a9c15a0fbc62da252 | |
| parent | 8222630785179c5b4cccaf28dbae36abb80bd39e (diff) | |
Update docs
63 files changed, 541 insertions, 15231 deletions
@@ -37,3 +37,6 @@ local.properties # ctags .tags* + +# Sphinx +_build @@ -18,7 +18,8 @@ Glances - An eye on your system .. image:: https://raw.github.com/nicolargo/glances/master/docs/images/glances-white-256.png :width: 128 -**Glances** is a cross-platform curses-based system monitoring tool written in Python. +**Glances** is a cross-platform curses-based system monitoring tool +written in Python. It uses the `psutil`_ library to get information from your system. @@ -33,10 +34,11 @@ Requirements Optional dependencies: -- ``bottle`` (for Web Server mode) +- ``bottle`` (for Web server mode) - ``py3sensors`` (for hardware monitoring support) [Linux-only] -- ``hddtemp`` (for HDD temperature monitoring support) +- ``hddtemp`` (for HDD temperature monitoring support) [Linux-only] - ``batinfo`` (for battery monitoring support) [Linux-only] +- ``pysnmp`` (for SNMP support) Installation ============ @@ -44,7 +46,8 @@ Installation PyPI: The simple way -------------------- -Glances is on `PyPI`_. By using Pypi, you are sure to have the latest stable version. +Glances is on `PyPI`_. By using PyPI, you are sure to have the latest +stable version. To install, simply use `pip`_: @@ -52,7 +55,7 @@ To install, simply use `pip`_: pip install Glances -*Note*: Python headers are required to install PSutil. For example, +*Note*: Python headers are required to install psutil. For example, on Debian/Ubuntu you need to install first the *python-dev* package. To upgrade Glances to the latest version: @@ -121,9 +124,10 @@ MacPorts Windows ------- -Glances proposes a Windows client based on the `colorconsole`_ Python library. +Glances proposes a Windows client based on the `colorconsole`_ Python +library. -To install Glances on Windows OS, you have to follow these steps: +To install Glances on Windows, you have to follow these steps: - Install Python for Windows: http://www.python.org/getit/ - Install the psutil library: https://pypi.python.org/pypi?:action=display&name=psutil#downloads @@ -166,7 +170,7 @@ For the Web server mode, run: $ glances -w -and enter the URL http://<ip>:61208 in your favorite Web Browser. +and enter the URL ``http://<ip>:61208`` in your favorite web browser. For the client/server mode, run: @@ -206,7 +210,6 @@ LGPL. See ``COPYING`` for more details. .. _pip: http://www.pip-installer.org/ .. _Homebrew: http://brew.sh/ .. _MacPorts: https://www.macports.org/ -.. _Glances-1.7.2-win32.msi: http://glances.s3.amazonaws.com/Glances-1.7.2-win32.msi .. _colorconsole: https://pypi.python.org/pypi/colorconsole .. _Puppet: https://puppetlabs.com/puppet/what-is-puppet/ .. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle Binary files differdeleted file mode 100644 index 55ef87fd..00000000 --- a/docs/_build/doctrees/environment.pickle +++ /dev/null diff --git a/docs/_build/doctrees/glances-doc.doctree b/docs/_build/doctrees/glances-doc.doctree Binary files differdeleted file mode 100644 index 812de66b..00000000 --- a/docs/_build/doctrees/glances-doc.doctree +++ /dev/null diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree Binary files differdeleted file mode 100644 index 20624f9a..00000000 --- a/docs/_build/doctrees/index.doctree +++ /dev/null diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo deleted file mode 100644 index 32820bba..00000000 --- a/docs/_build/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# 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: 88f9709ac94d939db26f5322044ea5df -tags: fbb0d17656682115ca4d033fb2f83ba1 diff --git a/docs/_build/html/_images/battery.png b/docs/_build/html/_images/battery.png Binary files differdeleted file mode 100644 index 238b7b94..00000000 --- a/docs/_build/html/_images/battery.png +++ /dev/null diff --git a/docs/_build/html/_images/client-connected.png b/docs/_build/html/_images/client-connected.png Binary files differdeleted file mode 100644 index 29dac50a..00000000 --- a/docs/_build/html/_images/client-connected.png +++ /dev/null diff --git a/docs/_build/html/_images/client-disconnected.png b/docs/_build/html/_images/client-disconnected.png Binary files differdeleted file mode 100644 index 8bce9c28..00000000 --- a/docs/_build/html/_images/client-disconnected.png +++ /dev/null diff --git a/docs/_build/html/_images/cpu-wide.png b/docs/_build/html/_images/cpu-wide.png Binary files differdeleted file mode 100644 index 9c1032a0..00000000 --- a/docs/_build/html/_images/cpu-wide.png +++ /dev/null diff --git a/docs/_build/html/_images/cpu.png b/docs/_build/html/_images/cpu.png Binary files differdeleted file mode 100644 index 1d5093d3..00000000 --- a/docs/_build/html/_images/cpu.png +++ /dev/null diff --git a/docs/_build/html/_images/diskio.png b/docs/_build/html/_images/diskio.png Binary files differdeleted file mode 100644 index 67661593..00000000 --- a/docs/_build/html/_images/diskio.png +++ /dev/null diff --git a/docs/_build/html/_images/footer.png b/docs/_build/html/_images/footer.png Binary files differdeleted file mode 100644 index 1145927d..00000000 --- a/docs/_build/html/_images/footer.png +++ /dev/null diff --git a/docs/_build/html/_images/fs.png b/docs/_build/html/_images/fs.png Binary files differdeleted file mode 100644 index ec9a7622..00000000 --- a/docs/_build/html/_images/fs.png +++ /dev/null diff --git a/docs/_build/html/_images/hddtemp.png b/docs/_build/html/_images/hddtemp.png Binary files differdeleted file mode 100644 index e238efad..00000000 --- a/docs/_build/html/_images/hddtemp.png +++ /dev/null diff --git a/docs/_build/html/_images/header.png b/docs/_build/html/_images/header.png Binary files differdeleted file mode 100644 index 5b381833..00000000 --- a/docs/_build/html/_images/header.png +++ /dev/null diff --git a/docs/_build/html/_images/load.png b/docs/_build/html/_images/load.png Binary files differdeleted file mode 100644 index 48cae129..00000000 --- a/docs/_build/html/_images/load.png +++ /dev/null diff --git a/docs/_build/html/_images/logs.png b/docs/_build/html/_images/logs.png Binary files differdeleted file mode 100644 index d51f2be8..00000000 --- a/docs/_build/html/_images/logs.png +++ /dev/null diff --git a/docs/_build/html/_images/mem-wide.png b/docs/_build/html/_images/mem-wide.png Binary files differdeleted file mode 100644 index 570c022f..00000000 --- a/docs/_build/html/_images/mem-wide.png +++ /dev/null diff --git a/docs/_build/html/_images/mem.png b/docs/_build/html/_images/mem.png Binary files differdeleted file mode 100644 index 5128c6e8..00000000 --- a/docs/_build/html/_images/mem.png +++ /dev/null diff --git a/docs/_build/html/_images/monitored.png b/docs/_build/html/_images/monitored.png Binary files differdeleted file mode 100644 index 222425c6..00000000 --- a/docs/_build/html/_images/monitored.png +++ /dev/null diff --git a/docs/_build/html/_images/network.png b/docs/_build/html/_images/network.png Binary files differdeleted file mode 100644 index 3336afd1..00000000 --- a/docs/_build/html/_images/network.png +++ /dev/null diff --git a/docs/_build/html/_images/per-cpu.png b/docs/_build/html/_images/per-cpu.png Binary files differdeleted file mode 100644 index 16601447..00000000 --- a/docs/_build/html/_images/per-cpu.png +++ /dev/null diff --git a/docs/_build/html/_images/processlist-wide.png b/docs/_build/html/_images/processlist-wide.png Binary files differdeleted file mode 100644 index aa9b2446..00000000 --- a/docs/_build/html/_images/processlist-wide.png +++ /dev/null diff --git a/docs/_build/html/_images/processlist.png b/docs/_build/html/_images/processlist.png Binary files differdeleted file mode 100644 index 460e0f8c..00000000 --- a/docs/_build/html/_images/processlist.png +++ /dev/null diff --git a/docs/_build/html/_images/screenshot-wide.png b/docs/_build/html/_images/screenshot-wide.png Binary files differdeleted file mode 100644 index e0e3a510..00000000 --- a/docs/_build/html/_images/screenshot-wide.png +++ /dev/null diff --git a/docs/_build/html/_images/screenshot.png b/docs/_build/html/_images/screenshot.png Binary files differdeleted file mode 100644 index 1940adb8..00000000 --- a/docs/_build/html/_images/screenshot.png +++ /dev/null diff --git a/docs/_build/html/_images/sensors.png b/docs/_build/html/_images/sensors.png Binary files differdeleted file mode 100644 index 8b17c0af..00000000 --- a/docs/_build/html/_images/sensors.png +++ /dev/null diff --git a/docs/_build/html/_sources/glances-doc.txt b/docs/_build/html/_sources/glances-doc.txt deleted file mode 100644 index b3549798..00000000 --- a/docs/_build/html/_sources/glances-doc.txt +++ /dev/null @@ -1,529 +0,0 @@ -======= -Glances -======= - -This manual describes *Glances* version 1.7.3. - -Copyright © 2012-2013 Nicolas Hennion <nicolas@nicolargo.com> - -November 2013 - -.. contents:: Table of Contents - -Introduction -============ - -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. - -Glances can adapt dynamically the displayed information depending on the -terminal size. It can also work in a client/server mode for remote monitoring. - -Glances is written in Python and uses the `psutil`_ library to get information from your system. - -Console (80x24) - -.. image:: images/screenshot.png - -Full view (>80x24) - -.. image:: images/screenshot-wide.png - -Usage -===== - -Standalone mode ---------------- - -Simply run: - -.. code-block:: console - - $ glances - -Client/Server mode ------------------- - -If you want to remotely monitor a machine, called ``server``, from another one, called ``client``, -just run on the server: - -.. code-block:: console - - server$ glances -s - -and on the client: - -.. code-block:: console - - client$ glances -c @server - -where ``@server`` is the IP address or hostname of the server. - -In server mode, you can set the bind address ``-B ADDRESS`` and listening TCP port ``-p PORT``. - -In client mode, you can set the TCP port of the server ``-p PORT``. - -Default binding address is ``0.0.0.0`` (Glances will listen on all the network interfaces) and TCP port is ``61209``. - -In client/server mode, limits are set by the server side. - -You can also set a password to access to the server ``-P password``. - -Glances is ``IPv6`` compatible. Just use the ``-B ::`` option to bind to all IPv6 addresses. - -Command reference -================= - -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 --d Disable disk I/O module --e Enable sensors module (requires pysensors, Linux-only) --f FILE Set the HTML output folder or CSV file --h Display the help and exit --m Disable mount module --n Disable network module --o OUTPUT Define additional output (available: HTML or CSV) --p PORT Define the client/server TCP port (default: 61209) --P PASSWORD Define a client/server password ---password Define a client/server password from the prompt --r Disable process list (for low CPU consumption) --s Run Glances in server mode --t SECONDS Set refresh time in seconds (default: 3 sec) --v Display the version and exit --y Enable hddtemp module (requires hddtemp) --z Do not use the bold color attribute --1 Start Glances in per-CPU mode - -Interactive commands --------------------- - -The following commands (key pressed) are supported while in Glances: - - -``a`` - Sort process list automatically - - - If CPU iowait ``>60%``, sort processes by I/O read and write - - If CPU ``>70%``, sort processes by CPU usage - - If MEM ``>70%``, sort processes by memory usage -``b`` - Switch between bit/s or Byte/s for network I/O -``c`` - Sort processes by CPU usage -``d`` - Show/hide disk I/O stats -``f`` - Show/hide file system stats -``h`` - Show/hide the help screen -``i`` - Sort processes by I/O rate (may need root privileges on some OSes) -``l`` - Show/hide log messages -``m`` - Sort processes by MEM usage -``n`` - Show/hide network stats -``p`` - Sort processes by name -``q`` - Quit -``s`` - Show/hide sensors stats (only available with -e flag) -``t`` - View network I/O as combination -``u`` - View cumulative network I/O -``w`` - Delete finished warning log messages -``x`` - Delete finished warning and critical log messages -``y`` - Show/hide hddtemp stats (only available with -y flag) -``1`` - Switch between global CPU and per-CPU stats - -Configuration -============= - -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: - -: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: - -.. code-block:: console - - C:\Documents and Settings\<User>\Application Data - -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 - - mkdir -p $XDG_CONFIG_HOME/glances - cp /etc/glances/glances.conf $XDG_CONFIG_HOME/glances/ - -On OS X, you should copy the configuration file to ``~/Library/Application Support/glances/``. - -Anatomy of the application -========================== - -Legend ------- - -| ``GREEN`` stat counter is ``"OK"`` -| ``BLUE`` stat counter is ``"CAREFUL"`` -| ``MAGENTA`` stat counter is ``"WARNING"`` -| ``RED`` stat counter is ``"CRITICAL"`` - -Header ------- - -.. image:: images/header.png - -The header shows the OS name, release version, platform architecture and the hostname. -On Linux, it shows also the kernel version. - -CPU ---- - -Short view: - -.. image:: images/cpu.png - -If enough horizontal space is available, extended CPU informations are displayed. - -Extended view: - -.. image:: images/cpu-wide.png - -To switch to per-CPU stats, just hit the ``1`` key: - -.. image:: images/per-cpu.png - -The CPU stats are shown as a percentage and for the configured refresh time. -The total CPU usage is displayed on the first line. - -| If user|system|nice CPU is ``<50%``, then status is set to ``"OK"`` -| If user|system|nice CPU is ``>50%``, then status is set to ``"CAREFUL"`` -| If user|system|nice CPU is ``>70%``, then status is set to ``"WARNING"`` -| If user|system|nice CPU is ``>90%``, then status is set to ``"CRITICAL"`` - -*Note*: limit values can be overwritten in the configuration file under the ``[cpu]`` section. - -Load ----- - -.. image:: images/load.png - -On the *No Sheep* blog, *Zachary Tirrell* defines the average load [1]_: - - "In short it is the average sum of the number of processes - waiting in the run-queue plus the number currently executing - over 1, 5, and 15 minute time periods." - -Glances gets the number of CPU core to adapt the alerts. -Alerts on average load are only set on 5 and 15 min. -The first line also display the number of CPU core. - -| If average load is ``<0.7*core``, then status is set to ``"OK"`` -| If average load is ``>0.7*core``, then status is set to ``"CAREFUL"`` -| If average load is ``>1*core``, then status is set to ``"WARNING"`` -| If average load is ``>5*core``, then status is set to ``"CRITICAL"`` - -*Note*: limit values can be overwritten in the configuration file under the ``[load]`` section. - -Memory ------- - -Glances uses two columns: one for the ``RAM`` and another one for the ``Swap``. - -.. image:: images/mem.png - -If enough space is available, Glances displays extended informations: - -.. image:: images/mem-wide.png - -With Glances, alerts are only set for on used memory and used swap. - -| If memory is ``<50%``, then status is set to ``"OK"`` -| If memory is ``>50%``, then status is set to ``"CAREFUL"`` -| If memory is ``>70%``, then status is set to ``"WARNING"`` -| If memory is ``>90%``, then status is set to ``"CRITICAL"`` - -*Note*: limit values can be overwritten in the configuration file under the ``[memory]`` and ``[swap]`` sections. - -Network -------- - -.. image:: images/network.png - -Glances displays the network interface bit rate. The unit is adapted -dynamically (bits per second, kbits per second, Mbits per second, etc). - -Alerts are only set if the network interface maximum speed is available. - -For example, on a 100 Mbps ethernet interface, the warning status is set -if the bit rate is higher than 70 Mbps. - -| If bit rate is ``<50%``, then status is set to ``"OK"`` -| If bit rate is ``>50%``, then status is set to ``"CAREFUL"`` -| If bit rate is ``>70%``, then status is set to ``"WARNING"`` -| If bit rate is ``>90%``, then status is set to ``"CRITICAL"`` - -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 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: - -.. code-block:: console - - $ glances -e - -To enable the hddtemp module: - -.. code-block:: console - - $ glances -y - -There is no alert on this information. - -*Note*: limit values can be overwritten in the configuration file under the ``[temperature]`` and ``[hddtemperature]`` sections. - -Disk I/O --------- - -.. image:: images/diskio.png - -Glances displays the disk I/O throughput. The unit is adapted dynamically. - -*Note*: There is no alert on this information. - -File system ------------ - -.. image:: images/fs.png - -Glances displays the used and total file system disk space. The unit is -adapted dynamically. - -Alerts are set for used disk space: - -| If disk used is ``<50%``, then status is set to ``"OK"`` -| If disk used is ``>50%``, then status is set to ``"CAREFUL"`` -| If disk used is ``>70%``, then status is set to ``"WARNING"`` -| If disk used is ``>90%``, then status is set to ``"CRITICAL"`` - -*Note*: limit values can be overwritten in the configuration file under ``[filesystem]`` section. - -Processes list --------------- - -Compact view: - -.. image:: images/processlist.png - -Full view: - -.. image:: images/processlist-wide.png - -Three views are available for processes: - -* Processes summary -* Optional monitored processes list (new in 1.7) -* Processes list - -By default, or if you hit the ``a`` key, the processes list is automatically -sorted by CPU of memory usage. - -*Note*: limit values can be overwritten in the configuration file under the ``[process]`` section. - -The number of processes in the list is adapted to the screen size. - -``VIRT`` - Total program size (VMS) -``RES`` - Resident set size (RSS) -``CPU%`` - % o |
