Glances
-This manual describes Glances version 2.0.1.
+This manual describes Glances version 2.1.
Copyright © 2012-2014 Nicolas Hennion <nicolas@nicolargo.com>
-June 2014
+September 2014
Table of Contents
-
@@ -142,24 +142,25 @@ td.option-group {
In client mode, you can set the TCP port of the server -p PORT.
You can also set a password to access to the server --password.
Default binding address is 0.0.0.0 (Glances will listen on all the -network interfaces) and TCP port is 61209.
+available network interfaces) and TCP port is 61209.In client/server mode, limits are set by the server side.
Glances is IPv6 compatible. Just use the -B :: option to bind to all IPv6 addresses.
@@ -215,13 +216,12 @@ client, the latter will try to grab stats using the client$ glances -c @snmpserver -Known issues: grab using SNMP is only validated for GNU/Linux with SNMP -v2/2c server.
+Note: Stats grabbed by SNMP request are limited.
Web Server Mode
If you want to remotely monitor a machine, called server, from any -device with a web browser, called client, just run on the server:
+device with a web browser, just run on the server:
server$ glances -w
@@ -239,6 +239,7 @@ http://@server:61208
Command Reference
Command-Line Options
++
@@ -250,21 +251,16 @@ http://@server:61208 -V, --version show program's version number and exit - --b, --byte -display network rate in byte per second - --B BIND_ADDRESS, --bind BIND_ADDRESS -- bind server to the given IPv4/IPv6 address or hostname - --c CLIENT, --client CLIENT -+-d, --debug + connect to a Glances server by IPv4/IPv6 address or -hostname Enable debug mode -C CONF_FILE, --config CONF_FILE + path to the configuration file + +--enable-history +enable the history mode @@ -274,7 +270,7 @@ hostname --disable-bold disable bold mode in the terminal disable disk I/O module + --disable-fs -disable file system module disable filesystem module @@ -287,6 +283,10 @@ hostname --disable-process --disable-network + disable process module + +--disable-process-extended +disable extended stats on top process @@ -295,16 +295,29 @@ hostname --disable-log disable log module export stats to a CSV file + +-c CLIENT, --client CLIENT ++ connect to a Glances server by IPv4/IPv6 address or +hostname + +-s, --server +run Glances in server mode -p PORT, --port PORT + define the client/server TCP port [default: 61209] + +-B BIND_ADDRESS, --bind BIND_ADDRESS ++ bind server to the given IPv4/IPv6 address or hostname + +--password-badidea PASSWORD_ARG +define password from the command line - --password define a client/server password from the prompt or file --s, --server -run Glances in server mode @@ -325,6 +338,9 @@ file --snmp-auth SNMP_AUTH --snmp-community SNMP_COMMUNITY + SNMP authentication key (only for SNMPv3) +--snmp-force +force SNMP mode @@ -332,17 +348,40 @@ file -t TIME, --time TIME - -w, --webserver + run Glances in Web server mode + run Glances in web server mode + +-f PROCESS_FILTER, --process-filter PROCESS_FILTER ++ set the process filter patern (regular expression) + +--process-short-name ++ force short name for processes name +-b, --byte +display network rate in byte per second + -1, --percpu start Glances in per CPU mode +--theme-white +optimize display for white background
Interactive Commands
The following commands (key pressed) are supported while in Glances:
-
+
- ENTER +
Set the process filter +Filter is a regular expression pattern:
+-
+
- gnome: all processes starting with the gnome string +
- .*gnome.*: all processes containing the gnome string +
- a
Sort process list automatically
-
@@ -357,8 +396,12 @@ file
- Sort processes by CPU usage
- d
- Show/hide disk I/O stats +
- e +
- Enable/disable top extended stats
- f
- Show/hide file system stats +
- g +
- Generate hraphs for current history
- h
- Show/hide the help screen
- i @@ -373,6 +416,8 @@ file
- Sort processes by name
- q
- Quit +
- r +
- Reset history
- s
- Show/hide sensors stats
- t @@ -387,16 +432,17 @@ file
- Show/hide processes stats
- 1
- Switch between global CPU and per-CPU stats +
- / +
- Switch between short name / command line (processes name)
Configuration
-Caution! Glances version 1.x configuration files are not compatible -with the version 2.x.
No configuration file is mandatory to use Glances.
Furthermore a configuration file is needed to set up limits, disks or -network interfaces to hide and/or monitored processes list.
+network interfaces to hide and/or monitored processes list or to define +alias.By default, the configuration file is under:
| Linux, *BSD and OS X: | |
|---|---|
| /tmp/glances.conf | +|
| Windows: | %APPDATA%\Local\temp\glances.conf | +
Anatomy Of The Application
+Anatomy Of The Application
Legend
+Legend
Header
+Header
The header shows the hostname, OS name, release version, platform architecture and system uptime (on the upper right corner). @@ -455,7 +521,7 @@ Additionally, on GNU/Linux, it also shows the kernel version.
CPU
+CPU
Short view:
If enough horizontal space is available, extended CPU information are @@ -476,7 +542,7 @@ time. The total CPU usage is displayed on the first line.
the [cpu] and/or [percpu] sections.Load
+Load
On the No Sheep blog, Zachary Tirrell defines the load average [1]:
@@ -496,7 +562,7 @@ The first line also displays the number of CPU core. the [load] section.
Memory
+Memory
Glances uses two columns: one for the RAM and one for the SWAP.
If enough space is available, Glances displays extended information for @@ -513,7 +579,7 @@ the RAM:
the [memory] and/or [memswap] sections.Network
+Network
Glances displays the network interface bit rate. The unit is adapted dynamically (bits per second, kbits per second, Mbits per second, etc).
@@ -521,18 +587,18 @@ dynamically (bits per second, kbits per second, Mbits per second, etc). (see sample in the configuration file).Note: it is possibile to define a list of network interfaces to hide and per-interface limit values in the [network] section of the -configuration file.
+configuration file and aliases for interface name.Disk I/O
+Disk I/O
Glances displays the disk I/O throughput. The unit is adapted dynamically.
There is no alert on this information.
Note: it is possible to define a list of disks to hide under the -[diskio] section in the configuration file.
+[diskio] section in the configuration file and aliases for disk name.File System
+File System
Glances displays the used and total file system disk space. The unit is adapted dynamically.
@@ -547,7 +613,7 @@ adapted dynamically. the [filesystem] section.Sensors
+Sensors
Glances can displays the sensors information using lm-sensors, hddtemp and batinfo [2].
All of the above libraries are available only on Linux.
@@ -555,11 +621,11 @@ the [filesystem] section. temperature only.
There is no alert on this information.
-Note: limit values can be overwritten in the configuration file under -the [sensors] section.
+Note: limit values and sensors alias names can be defined in the configuration +file under the [sensors] section.
Processes List
+Processes List
Compact view:
Full view:
@@ -612,7 +678,8 @@ automatically sorted by:Process status legend:
-
@@ -627,11 +694,20 @@ automatically sorted by:
- Z
- Zombie
In standalone mode, additionals informations are provided for the top process:
+
+-
+
- CPU affinity (number of cores used by the process) +
- Extended memory information (swap, shared, text, lib, data and dirty on Linux) +
- Openned threads, files and network sessions (TCP and UDP) +
- IO nice level +
The extended stats feature could be disabled using the --disable-process-extended option (command line) or the e key (curses interface).
Note: limit values can be overwritten in the configuration file under the [process] section.
Monitored Processes List
+Monitored Processes List
The monitored processes list allows user, through the configuration file, to group processes and quickly show if the number of running processes is not good.
@@ -683,7 +759,7 @@ get the JSON representation of the monitored processes list.
Other Outputs
+Other Outputs
It is possible to export statistics to CSV file.
$ glances --output-csv /tmp/glances.csv
@@ -714,17 +790,21 @@ processes list alerts
API Documentation
-Glances uses a XML-RPC server and can be used by another client software.
-API documentation is available at -https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to.
+APIs Documentations
+Glances includes a XML-RPC server and a RESTFULL-JSON API which and can be used by another client software.
+APIs documentations are available at:
+Support
+Support
+To post a question about Glances use case, please post it to the offical Q&A forum.
To report a bug or a feature request use the bug tracking system at https://github.com/nicolargo/glances/issues.
-Feel free to contribute!
+Feel free to contribute !