diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 126 |
1 files changed, 77 insertions, 49 deletions
@@ -6,18 +6,44 @@ Glances -- Eye on your system ## Description -Glances is a CLI curses based monitoring tool for GNU/Linux or BSD OS. +Glances is a CLI curses based monitoring tool for GNU/Linux and BSD OS. -Glances uses the libstatgrab library to get information from your system. -It is developed in Python and uses the python-statgrab lib. +Glances uses the PsUtil library to get information from your system. + +It is developed in Python.  ## Installation -### From package manager +### From package manager (very easy way) + +Packages exist for Arch, Fedora, Redhat, FreeBSD... + +### From PPA (easy way for Ubuntu/Mint...) + +Arnaud Hartmann (thanks to him !) maintains a PPA with the latest Glances version: + +To install the PPA just enter: + + $ sudo add-apt-repository ppa:arnaud-hartmann/glances-dev + $ sudo apt-get update + +Then install Glances: + + $ sudo apt-get install glances + +### From PyPi (easy way) + +PyPi is an official Python package manager. -Packages exist for Arch, Fedora, Redhat ... +You first need to install pypi on your system. For exemple on Debian/Ubuntu: + + $ sudo apt-get install python-pip + +Then install the latest Glances version: + + $ sudo pip install glances ### From PPA (Ubuntu/Mint) @@ -35,39 +61,21 @@ The PPA is available for Ubuntu version 9.10 to 12.04. Get the latest version: - $ wget https://github.com/downloads/nicolargo/glances/glances-1.3.7.tar.gz + $ wget https://github.com/downloads/nicolargo/glances/glances-1.4.tar.gz Glances use a standard GNU style installer: - $ tar zxvf glances-1.3.7.tar.gz - $ cd glances-1.3.7 - $ ./configure - $ make - $ sudo make install + $ tar zxvf glances-1.4.tar.gz + $ cd glances-1.4 + $ sudo python setup.py install Pre-requisites: * Python 2.6+ (not tested with Python 3+) -* python-statgrab 0.5+ (did NOT work with python-statgrab 0.4) - -Notes: For Debian. -The Debian Squeeze repos only include the python-statgrab 0.4. -You had to install the version 0.5 using the following commands: - - $ sudo apt-get install libstatgrab-dev pkg-config python-dev make - $ wget http://ftp.uk.i-scream.org/sites/ftp.i-scream.org/pub/i-scream/pystatgrab/pystatgrab-0.5.tar.gz - $ tar zxvf pystatgrab-0.5.tar.gz - $ cd pystatgrab-0.5/ - $ ./setup.py build - $ sudo ./setup.py install - -Notes: For Ubuntu 10.04 and 10.10. -The instruction to install the version 0.5 are here: -https://github.com/nicolargo/glances/issues/5#issuecomment-3033194 ## Running -Easy: +Easy way (that's all folks !): $ glances.py @@ -98,23 +106,23 @@ When Glances is running, you can press: * 'd' Disable or enable the disk IO stats * 'f' Disable or enable the file system stats * 'l' Disable or enable the logs -* 'm' to sort the processes list by process size +* 'm' to sort the processes list by process MEM * 'n' Disable or enable the network interfaces stats +* 'p' to sort by process name * 'q' Exit ### Header  -The header shows the Glances version, the host name and the operating -system name, version and architecture. +The header shows the host name and the operating system name, version and architecture. ### CPU  -The CPU states are shown as a percentage and for the configured refresh -time. +The CPU states are shown as a percentage and for the configured refresh +time. The total CPU usage is displayed on the first line. If user|kernel|nice CPU is < 50%, then status is set to "OK". @@ -128,12 +136,13 @@ If user|kernel|nice CPU is > 90%, then status is set to "CRITICAL".  -On the Nosheep blog, Zach defines the average load: "In short it is the -average sum of the number of processes waiting in the run-queue plus the +On the Nosheep blog, Zach defines the average load: "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 cores to adapt the alerts. With Glances, -alerts on average load are only set on 5 and 15 mins. +Glances gets the number of CPU cores to adapt the alerts. With Glances, +alerts on average load are only set on 5 and 15 mins. The first line +also display the number of CPU core. If average load is < O.7*Core, then status is set to "OK". @@ -147,7 +156,7 @@ If average load is > 5*Core, then status is set to "CRITICAL".  -Glances uses tree columns: memory (RAM), swap and "real". +Glances uses tree columns: memory (RAM), "real" and swap. Real used memory is: used - cache. @@ -167,7 +176,7 @@ If memory is > 90%, then status is set to "CRITICAL".  -Glances display the network interface bit rate. The unit is adapted +Glances display the network interface bit rate. The unit is adapted dynamicaly (bits per second, Kbits per second, Mbits per second...). Alerts are set only if the network interface maximum speed is available. @@ -180,14 +189,14 @@ If bitrate is > 70%, then status is set to "WARNING". If bitrate is > 90%, then status is set to "CRITICAL". -For exemple, on a 100 Mbps Ethernet interface, the warning status is set +For exemple, on a 100 Mbps Ethernet interface, the warning status is set if the bit rate is higher than 70 Mbps. ### Disk I/O  -Glances display the disk I/O throughput. The unit is adapted dynamicaly +Glances display the disk I/O throughput. The unit is adapted dynamicaly (bytes per second, Kbytes per second, Mbytes per second...). There is no alert on this information. @@ -196,8 +205,8 @@ There is no alert on this information.  -Glances display the total and used filesytem disk space. The unit is -adapted dynamicaly (bytes per second, Kbytes per second, Mbytes per +Glances display the total and used filesytem disk space. The unit is +adapted dynamicaly (bytes per second, Kbytes per second, Mbytes per second...). Alerts are set for used disk space: @@ -216,11 +225,30 @@ If disk used is > 90%, then status is set to "CRITICAL". Glances displays a summary and a list of processes. -By default (or if you hit the 'a' key) the process list is automaticaly +By default (or if you hit the 'a' key) the process list is automaticaly sorted by CPU of memory consumption. The number of processes in the list is adapted to the screen size. +* VIRT: Virtual memory size (in byte) +* REST: Amount of resident memory (in byte) +* CPU%: % of CPU used by the process +* MEM%: % of MEM used by the process +* PID: Process ID +* USER: Process user ID +* NI: Nice level of the process +* S: Process status + + R - Running + D - Sleeping (may not be interrupted) + S - Sleeping (may be interrupted) + T - Traced or stopped + Z - Zombie or "hung" process + +* TIME+: Cumulative CPU time used +* NAME: Process name or command line + + ### Logs  @@ -235,13 +263,13 @@ There is one line per alert with the following information: * start date * end date * alert name -* (min/avg/max) values +* (min/avg/max) values ### Footer  -Glances displays a caption and the current time/date. +Glances displays the current time/date and access to the embeded help screen. ## Localisation @@ -255,6 +283,6 @@ i18n_espanol_generate.sh You are welcome to contribute to this software. -* Packaging for Debian, Ubuntu, BSD... -* Check the needed Python library in the configure.ac -* Add file system stats when the python-statgrab is corrected +* Code optimization +* Port to FreeBSD and Mac OS X +* Documentation for HTML and CVS export option |