A cross-platform curses-based monitoring tool
Project description
Follow Glances on Twitter: @nicolargo or @glances_system
Summary
Glances is a cross-platform monitoring tool which aims to present a maximum of information in a minimum of space through a curses or Web based interface. It can adapt dynamically the displayed information depending on the user interface size.
It can also work in client/server mode. Remote monitoring could be done via terminal, Web interface or API (XMLRPC and RESTful). Stats can also be exported to files or external time/value databases.
Glances is written in Python and uses libraries to grab information from your system. It is based on an open architecture where developers can add news plugins or exports modules.
Requirements
python 2.7,>=3.3 (tested with version 2.7, 3.3, 3.4, 3.5)
psutil>=2.0.0 (better with latest version)
setuptools
Optional dependencies:
batinfo (for battery monitoring support) [Linux-only]
bernhard (for the Riemann export module)
bottle (for Web server mode)
cassandra-driver (for the Cassandra export module)
couchdb (for the CouchDB export module)
docker-py (for the Docker monitoring support) [Linux-only]
elasticsearch (for the Elastic Search export module)
hddtemp (for HDD temperature monitoring support) [Linux-only]
influxdb (for the InfluxDB export module)
matplotlib (for graphical/chart support)
netifaces (for the IP plugin)
nvidia-ml-py (for the GPU plugin)
pika (for the RabbitMQ/ActiveMQ export module)
potsdb (for the OpenTSDB export module)
py3sensors (for hardware monitoring support) [Linux-only]
py-cpuinfo (for the Quicklook CPU info module)
pymdstat (for RAID support) [Linux-only]
pysnmp (for SNMP support)
pystache (for the action script feature)
pyzmq (for the ZeroMQ export module)
requests (for the Ports plugin)
scandir (for the Folders plugin) [Only for Python < 3.5]
statsd (for the StatsD export module)
wifi (for the wifi plugin) [Linux-only]
zeroconf (for the autodiscover mode)
Note for Python 2.6 users
Since version 2.7, Glances no longer support Python 2.6. Please upgrade to at least Python 2.7/3.3+ or downgrade to Glances 2.6.2 (latest version with Python 2.6 support).
Note for CentOS Linux 6 and 7 users
Python 2.7, 3.3 and 3.4 are now available via SCLs. See: https://lists.centos.org/pipermail/centos-announce/2015-December/021555.html.
Installation
Several method to test/install Glances on your system. Choose your weapon !
Glances Auto Install script: the total way
To install both dependencies and latest Glances production ready version (aka master branch), just enter the following command line:
curl -L https://bit.ly/glances | /bin/bashor
wget -O- https://bit.ly/glances | /bin/bashNote: Only supported on some GNU/Linux distributions. If you want to support other distributions, please contribute to glancesautoinstall.
PyPI: The simple way
Glances is on PyPI. By using PyPI, you are sure to have the latest stable version.
To install, simply use pip:
pip install glancesNote: Python headers are required to install psutil. For example, on Debian/Ubuntu you need to install first the python-dev package. For Fedora/CentOS/RHEL install first python-devel package. For Windows, just install PsUtil from the binary installation file.
You can also install the following libraries in order to use optional features (like the Web interface, exports modules, sensors…):
curl -o /tmp/optional-requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/optional-requirements.txt
pip install -r /tmp/optional-requirements.txtTo upgrade Glances to the latest version:
pip install --upgrade glances
curl -o /tmp/requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/requirements.txt
pip install --upgrade /tmp/requirements.txt
curl -o /tmp/optional-requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/optional-requirements.txt
pip install --upgrade /tmp/optional-requirements.txtIf you need to install Glances in a specific user location, use:
export PYTHONUSERBASE=~/mylocalpath
pip install --user glancesDocker: the funny way
A Glances container is available. It will include the latest development HEAD version. You can use it to monitor your server and all your others containers !
Get the Glances container:
docker pull nicolargo/glancesRun the container in console mode:
docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -it docker.io/nicolargo/glancesAdditionally, If you want to use your own glances.conf file, you can create your own Dockerfile:
FROM nicolargo/glances
COPY glances.conf /glances/conf/glances.conf
CMD python -m glances -C /glances/conf/glances.conf $GLANCES_OPTAlternatively, you can specify something along the same lines with docker run options:
docker run -v ./glances.conf:/glances/conf/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -it docker.io/nicolargo/glancesWhere ./glances.conf is a local directory containing your glances.conf file.
Run the container in Web server mode (notice the GLANCES_OPT environment variable setting parameters for the glances startup command) :
docker run -d --restart="always" -p 61208-61209:61208-61209 -e GLANCES_OPT="-w" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host docker.io/nicolargo/glancesGNU/Linux
At the moment, packages exist for the following GNU/Linux distributions:
Arch Linux
Debian
Fedora/CentOS/RHEL
Gentoo
Slackware (SlackBuild)
Ubuntu
Void Linux
So you should be able to install it using your favorite package manager. Be aware that the Glances version can not be the latest one using this method.
FreeBSD
To install the binary package:
# pkg install py27-glancesTo install Glances from ports:
# cd /usr/ports/sysutils/py-glances/
# make install cleanmacOS
macOS users can install Glances using Homebrew or MacPorts.
Homebrew
$ brew install python
$ pip install glancesMacPorts
$ sudo port install glancesWindows
Install Python for Windows (Python 2.7.9+ and 3.4+ ship with pip) and then just:
$ pip install glancesYou can also install the following libraries in order to use optional features (like the Web interface, exports modules, sensors…):
pip install bottle requests zeroconf netifaces influxdb elasticsearch potsdb statsd pystache pysnmp pika py-cpuinfo bernhard cassandra scandirSource
To install Glances from source:
$ wget https://github.com/nicolargo/glances/archive/vX.Y.tar.gz -O - | tar xz
$ cd glances-*
# python setup.py installNote: Python headers are required to install psutil. For example, on Debian/Ubuntu you need to install first the python-dev package.
Chef
An awesome Chef cookbook is available to monitor your infrastructure: https://supermarket.chef.io/cookbooks/glances (thanks to Antoine Rouyer)
Puppet
You can install Glances using Puppet: https://github.com/rverchere/puppet-glances
Usage
For the standalone mode, just run:
$ glancesFor the Web server mode, run:
$ glances -wand enter the URL http://<ip>:61208 in your favorite web browser.
For the client/server mode, run:
$ glances -son the server side and run:
$ glances -c <ip>on the client one.
You can also detect and display all Glances servers available on your network or defined in the configuration file:
$ glances --browserand RTFM, always.
Documentation
For complete documentation have a look at the readthedocs website.
If you have any question (after RTFM!), please post it on the official Q&A forum.
Gateway to other services
Glances can export stats to: CSV file, InfluxDB, Cassandra, CouchDB, OpenTSDB, StatsD, ElasticSearch, RabbitMQ/ActiveMQ, ZeroMQ, and Riemann server.
How to contribute ?
If you want to contribute to the Glances project, read this wiki page.
There is also a chat dedicated to the Glances developers:
License
LGPL. See COPYING for more details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
