Glances - An eye on your system

Summary

Glances is an open-source system cross-platform monitoring tool. It allows real-time monitoring of various aspects of your system such as CPU, memory, disk, network usage etc. It also allows monitoring of running processes, logged in users, temperatures, voltages, fan speeds etc. It also supports container monitoring, it supports different container management systems such as Docker, LXC. The information is presented in an easy to read dashboard and can also be used for remote monitoring of systems via a web interface or command line interface. It is easy to install and use and can be customized to show only the information that you are interested in.

In client/server mode, remote monitoring could be done via terminal, Web interface or API (XML-RPC and RESTful). Stats can also be exported to files or external time/value databases, CSV or direct output to STDOUT.

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 new plugins or exports modules.

Project sponsorship

You can help me to achieve my goals of improving this open-source project or just say "thank you" by:

sponsor me using one-time or monthly tier Github sponsors page
send me some pieces of bitcoin: 185KN9FCix3svJYp7JQM7hRMfSKyeaJR4X
buy me a gift on my wishlist page

Any and all contributions are greatly appreciated.

Requirements

python>=2.7 or python>=3.4
psutil>=5.3.0 (better with latest version)
defusedxml (in order to monkey patch xmlrpc)
ujson (an optimized alternative to the standard json module)
future (for Python 2 support)

Note for Python 2.6 users

Glances no longer supports Python 2.6. Please upgrade to a minimum Python version of 2.7/3.4+ or downgrade to Glances 2.6.2 (last version with Python 2.6 support).

Deprecation warning note for Python 2.x users

Glances version 4.0 will no longer supports Python 2.x.

Optional dependencies:

batinfo (for battery monitoring)
bernhard (for the Riemann export module)
bottle (for Web server mode)
cassandra-driver (for the Cassandra export module)
chevron (for the action script feature)
couchdb (for the CouchDB export module)
docker (for the Docker monitoring support) [Linux/macOS-only]
elasticsearch (for the Elastic Search export module)
graphitesender (For the Graphite export module)
hddtemp (for HDD temperature monitoring support) [Linux-only]
influxdb (for the InfluxDB version 1 export module)
influxdb-client (for the InfluxDB version 2 export module) [Only for Python >= 3.6]
kafka-python (for the Kafka export module)
netifaces (for the IP plugin)
py3nvml (for the GPU plugin) [Only for Python 3]
pika (for the RabbitMQ/ActiveMQ export module)
potsdb (for the OpenTSDB export module)
prometheus_client (for the Prometheus export module)
py-cpuinfo (for the Quicklook CPU info module)
pygal (for the graph export module)
pymdstat (for RAID support) [Linux-only]
pysnmp (for SNMP support)
pySMART.smartx (for HDD Smart support) [Linux-only]
pyzmq (for the ZeroMQ export module)
requests (for the Ports, Cloud plugins and RESTful export module)
scandir (for the Folders plugin) [Only for Python < 3.5]
sparklines (for the Quick Plugin sparklines option)
statsd (for the StatsD export module)
wifi (for the wifi plugin) [Linux-only]
zeroconf (for the autodiscover mode)

Installation

There are several methods to test/install Glances on your system. Choose your weapon!

PyPI: The standard way

Glances is on PyPI. By using PyPI, you will be using the latest stable version.

To install Glances, simply use pip:

pip install --user glances

Note: Python headers are required to install psutil, a Glances dependency. For example, on Debian/Ubuntu you need to install first the python-dev package (python-devel on Fedora/CentOS/RHEL). For Windows, just install psutil from the binary installation file.

Note 2 (for the Wifi plugin): If you want to use the Wifi plugin, you need to install the wireless-tools package on your system.

By default, Glances is installed without the Web interface dependencies. To install it, use the following command:

pip install --user 'glances[web]'

For a full installation (with all features):

pip install --user 'glances[action,browser,cloud,cpuinfo,docker,export,folders,gpu,graph,ip,raid,snmp,web,wifi]'

To upgrade Glances to the latest version:

pip install --user --upgrade glances

The current develop branch is published to the test.pypi.org package index. If you want to test the develop version (could be instable), enter:

pip install --user -i https://test.pypi.org/simple/ Glances

Glances Auto Install script: the easy way

To install both dependencies and the latest Glances production ready version (aka master branch), just enter the following command line:

curl -L https://bit.ly/glances | /bin/bash

wget -O- https://bit.ly/glances | /bin/bash

Note: This is only supported on some GNU/Linux distributions and Mac OS X. If you want to support other distributions, please contribute to glancesautoinstall.

Docker: the fun way

Glances Docker images are availables. You can use it to monitor your server and all your containers !

Get the Glances container:

docker pull nicolargo/glances:latest-full

The following tags are availables:

latest-full for a full Alpine Glances image (latest release) with all dependencies
latest for a basic Alpine Glances (latest release) version with minimal dependencies (Bottle and Docker)
dev for a basic Alpine Glances image (based on development branch) with all dependencies (Warning: may be instable)

Run last version of Glances container in console mode:

docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it nicolargo/glances:latest-full

Additionally, if you want to use your own glances.conf file, you can create your own Dockerfile:

FROM nicolargo/glances:latest
COPY glances.conf /etc/glances.conf
CMD python -m glances -C /etc/glances.conf $GLANCES_OPT

Alternatively, you can specify something along the same lines with docker run options (notice the GLANCES_OPT environment variable setting parameters for the glances startup command):

docker run -v `pwd`/glances.conf:/etc/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -e GLANCES_OPT="-C /etc/glances.conf" -it nicolargo/glances:latest-full

Where `pwd`/glances.conf is a local directory containing your glances.conf file.

Run the container in Web server mode:

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 nicolargo/glances:latest-full

GNU/Linux

Glances is available on many Linux distributions, so you should be able to install it using your favorite package manager. Be aware that when you use this method the operating system package for Glances may not be the latest version.

Note: The Debian package (and all other Debian-based distributions) do not include anymore the JS statics files used by the Web interface (see issue2021). If you want to add it to your Glances installation, follow the instructions: issue2021comment.

FreeBSD

To install the binary package:

# pkg install py38-glances

To install Glances from ports:

# cd /usr/ports/sysutils/py-glances/
# make install clean

macOS

If you do not want to use the glancesautoinstall script, follow this procedure.

macOS users can install Glances using Homebrew or MacPorts.

Homebrew

$ brew install glances

MacPorts

$ sudo port install glances

Windows

Install Python for Windows (Python 2.7.9+ and 3.4+ ship with pip) and then run the following command:

$ pip install glances

Android

You need a rooted device and the Termux application (available on the Google Play Store).

Start Termux on your device and enter:

$ apt update
$ apt upgrade
$ apt install clang python
$ pip install bottle
$ pip install glances

And start Glances:

$ glances

You can also run Glances in server mode (-s or -w) in order to remotely monitor your Android device.

Source

To install Glances from source:

$ wget https://github.com/nicolargo/glances/archive/vX.Y.tar.gz -O - | tar xz
$ cd glances-*
# python setup.py install

Note: Python headers are required to install psutil.

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

Ansible

A Glances Ansible role is available: https://galaxy.ansible.com/zaxos/glances-ansible-role/

Usage

For the standalone mode, just run:

$ glances

For the Web server mode, run:

$ glances -w

and enter the URL http://<ip>:61208 in your favorite web browser.

For the client/server mode, run:

$ glances -s

on 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 --browser

You can also display raw stats on stdout:

$ glances --stdout cpu.user,mem.used,load
cpu.user: 30.7
mem.used: 3278204928
load: {'cpucore': 4, 'min1': 0.21, 'min5': 0.4, 'min15': 0.27}
cpu.user: 3.4
mem.used: 3275251712
load: {'cpucore': 4, 'min1': 0.19, 'min5': 0.39, 'min15': 0.27}
...

or in a CSV format thanks to the stdout-csv option:

$ glances --stdout-csv now,cpu.user,mem.used,load
now,cpu.user,mem.used,load.cpucore,load.min1,load.min5,load.min15
2018-12-08 22:04:20 CEST,7.3,5948149760,4,1.04,0.99,1.04
2018-12-08 22:04:23 CEST,5.4,5949136896,4,1.04,0.99,1.04
...

or in a JSON format thanks to the stdout-json option (attribute not supported in this mode in order to have a real JSON object in output):

$ glances --stdout-json cpu,mem
cpu: {"total": 29.0, "user": 24.7, "nice": 0.0, "system": 3.8, "idle": 71.4, "iowait": 0.0, "irq": 0.0, "softirq": 0.0, "steal": 0.0, "guest": 0.0, "guest_nice": 0.0, "time_since_update": 1, "cpucore": 4, "ctx_switches": 0, "interrupts": 0, "soft_interrupts": 0, "syscalls": 0}
mem: {"total": 7837949952, "available": 2919079936, "percent": 62.8, "used": 4918870016, "free": 2919079936, "active": 2841214976, "inactive": 3340550144, "buffers": 546799616, "cached": 3068141568, "shared": 788156416}
...

and 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, JSON file, InfluxDB, Cassandra, CouchDB, OpenTSDB, Prometheus, StatsD, ElasticSearch, RabbitMQ/ActiveMQ, ZeroMQ, Kafka, Riemann, Graphite and RESTful 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:

Author

Nicolas Hennion (@nicolargo) <nicolas@nicolargo.com>

https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40nicolargo

License

Glances is distributed under the LGPL version 3 license. See COPYING for more details.

edwinvincent6211/glances