Skip to main content

A cross-platform curses-based monitoring tool

Project description

https://img.shields.io/pypi/v/glances.svg Github stars Linux tests (Travis) Windows tests (Appveyor) https://img.shields.io/scrutinizer/g/nicolargo/glances.svg https://img.shields.io/badge/Donate-PayPal-green.svg

Follow Glances on Twitter: @nicolargo

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.

https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-summary.png

It can also work 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.

https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-responsive-webdesign.png

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.

Requirements

  • python 2.7,>=3.3

  • psutil>=2.0.0 (better with latest version)

Optional dependencies:

  • 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 (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)

  • kafka-python (for the Kafka export module)

  • matplotlib (for graphical/chart support)

  • netifaces (for the IP plugin)

  • nvidia-ml-py (for the GPU plugin) [Python 2-only]

  • 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)

  • 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 and Cloud plugins)

  • 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/bash

or

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

Note: 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 glances

Note: 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.

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.

You can also install the following libraries in order to use optional features (like the Web interface, exports modules…):

pip install glances[action,browser,cloud,cpuinfo,chart,docker,export,folders,gpu,ip,raid,snmp,web,wifi]

To upgrade Glances to the latest version:

pip install --upgrade glances
pip install --upgrade glances[...]

If you need to install Glances in a specific user location, use:

export PYTHONUSERBASE=~/mylocalpath
pip install --user glances

Docker: 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/glances

Run the container in console mode:

docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -it docker.io/nicolargo/glances

Additionally, 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_OPT

Alternatively, 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/glances

Where ./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/glances

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 Glances may not be the latest one using this method.

FreeBSD

To install the binary package:

# pkg install py27-glances

To install Glances from ports:

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

macOS

macOS users can install Glances using Homebrew or MacPorts.

Homebrew

$ brew install python
$ pip install glances

MacPorts

$ sudo port install glances

Windows

Install Python for Windows (Python 2.7.9+ and 3.4+ ship with pip) and then just:

$ pip install glances

Android

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

Start Termux on your device and enter:

$ apt update
$ apt upgrade
$ apt install clang python python-dev
$ 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

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

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, InfluxDB, Cassandra, CouchDB, OpenTSDB, Prometheus, StatsD, ElasticSearch, RabbitMQ/ActiveMQ, ZeroMQ, Kafka 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:

https://badges.gitter.im/Join%20Chat.svg

Author

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

License

LGPLv3. See COPYING for more details.

Project details


Release history Release notifications | RSS feed

This version

2.10

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Glances-2.10.tar.gz (5.6 MB view details)

Uploaded Source

Built Distributions

Glances-2.10-py3.6.egg (1.0 MB view details)

Uploaded Egg

Glances-2.10-py3.5.egg (1.0 MB view details)

Uploaded Egg

Glances-2.10-py3.4.egg (1.0 MB view details)

Uploaded Egg

Glances-2.10-py3.3.egg (1.1 MB view details)

Uploaded Egg

Glances-2.10-py2.7.egg (1.0 MB view details)

Uploaded Egg

File details

Details for the file Glances-2.10.tar.gz.

File metadata

  • Download URL: Glances-2.10.tar.gz
  • Upload date:
  • Size: 5.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Glances-2.10.tar.gz
Algorithm Hash digest
SHA256 3e3ebd41a4f627b76ee1cdf107482d81e787efde8a5e41e6568169d38eb2e696
MD5 934c68bcef612d6ba60b6bf351005338
BLAKE2b-256 dd8240bd95f116d3507c5dd1211356c4be676f62cce8fe639c71fa5bf4d7e608

See more details on using hashes here.

File details

Details for the file Glances-2.10-py3.6.egg.

File metadata

  • Download URL: Glances-2.10-py3.6.egg
  • Upload date:
  • Size: 1.0 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Glances-2.10-py3.6.egg
Algorithm Hash digest
SHA256 e90fcddf437554bb3237a71957953fe0a139ec45a9c12ef28abf9dae8d402ce0
MD5 61843c0765ce7ba3d08b2d2d90280ebb
BLAKE2b-256 756c0a6ea21aa309de2c983c9b85d352a5d048ed745d1eefe06fa0fd6e0f9ec0

See more details on using hashes here.

File details

Details for the file Glances-2.10-py3.5.egg.

File metadata

  • Download URL: Glances-2.10-py3.5.egg
  • Upload date:
  • Size: 1.0 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Glances-2.10-py3.5.egg
Algorithm Hash digest
SHA256 790710f386576916316c146dd32d8fad507b1c87ba1386dd5f78b223798130dc
MD5 699ea9b89ef2c881e83ff340db4e5c71
BLAKE2b-256 5d716eb9c072ead2287ba87a62471b5afecc4c9afd8f5ed72fb4c9a5291b4af9

See more details on using hashes here.

File details

Details for the file Glances-2.10-py3.4.egg.

File metadata

  • Download URL: Glances-2.10-py3.4.egg
  • Upload date:
  • Size: 1.0 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Glances-2.10-py3.4.egg
Algorithm Hash digest
SHA256 b03301563ddbea812e7b8ff4563b9475839b304d8792975afc942dbcf9ee49f3
MD5 46273623080da86b67e035a1c9e4d4f1
BLAKE2b-256 26180f578de353b9b815e48af3992a93d1f74f9afe167b613d1ac2f81e0f030f

See more details on using hashes here.

File details

Details for the file Glances-2.10-py3.3.egg.

File metadata

  • Download URL: Glances-2.10-py3.3.egg
  • Upload date:
  • Size: 1.1 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Glances-2.10-py3.3.egg
Algorithm Hash digest
SHA256 107897efb80cca262d1d6a0ea07fd8c8c06e6fb9a7830fc25078e3dfd8c511ca
MD5 79127b22ab868ad8305c365a070c7f79
BLAKE2b-256 508daf4b83dff763bd84af74655b8661bdbca81769de4bd9b3d9a33630acd4b7

See more details on using hashes here.

File details

Details for the file Glances-2.10-py2.7.egg.

File metadata

  • Download URL: Glances-2.10-py2.7.egg
  • Upload date:
  • Size: 1.0 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Glances-2.10-py2.7.egg
Algorithm Hash digest
SHA256 f1372bdd34404957446694ded5aaaead50c781e80990204311f5457d99a0b31c
MD5 f250c916aea570e275fb05da54e34dae
BLAKE2b-256 53f2ce3bd745f70569f69ceb194dc838d4969ee658e73144e11b0ee8e107a71c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page