bensb / glances

Glances an Eye on your system

Glances - An eye on your system

Follow Glances on Twitter: @nicolargo or @glances_system

Glances is a cross-platform curses-based system monitoring tool written in Python.

It uses the psutil library to get information from your system.

Requirements

• python >= 2.6 (tested with version 2.6, 2.7, 3.3, 3.4)
• psutil >= 2.0.0
• setuptools

Optionals dependencies:

• bottle (for Web server mode)
• py3sensors (for hardware monitoring support) [Linux-only]
• hddtemp (for HDD temperature monitoring support) [Linux-only]
• batinfo (for battery monitoring support) [Linux-only]
• pymdstat (for RAID support) [Linux-only]
• pysnmp (for SNMP support)
• zeroconf and netifaces (for the auto discoverer mode)
• influxdb (for the InfluxDB export module)
• statsd (for the StatsD export module)
• pystache (for the action script feature)
• docker-py (for the Docker monitoring support) [Linux-only]

Installation

Glances Auto Install script

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

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

or

wget -O- http://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.

Note 2: You can also install the following libs in order to use optionnal features:

pip install bottle batinfo https://bitbucket.org/gleb_zhulik/py3sensors/get/tip.tar.gz zeroconf netifaces pymdstat influxdb statsd pystache

To upgrade Glances to the latest version:

pip install --upgrade Glances

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

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

GNU/Linux

At the moment, packages exist for the following GNU/Linux distributions:

• Arch Linux
• Debian (Testing/Sid)
• Fedora/CentOS/RHEL
• Gentoo
• Slackware (SlackBuild)
• Ubuntu (13.04+)
• Void Linux

So you should be able to install it using your favorite package manager.

FreeBSD

To install the binary package:

# pkg install py27-glances

To install Glances from ports:

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

OS X

OS X 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: http://www.python.org/getit/
• Install the psutil library: https://pypi.python.org/pypi?:action=display&name=psutil#downloads
• Install the colorconsole library: https://pypi.python.org/pypi/colorconsole
• Install Glances Download Glances from here: http://nicolargo.github.io/glances/

Source

To install Glances from source:

$ curl -L https://github.com/nicolargo/glances/archive/vX.Y.tar.gz -o glances-X.Y.tar.gz
$ tar -zxvf glances-*.tar.gz
$ cd glances-*
# python setup.py install

Note: Python headers are required to install psutil. For example, on Debian/Ubuntu you need to install first the python-dev package.

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 see glances-doc.

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 and StatsD 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' developpers:

Author

Nicolas Hennion (@nicolargo) <[e-mail]>

License

LGPL. See COPYING for more details.