2013-12-26 18:03:50 +04:00
|
|
|
===============================
|
|
|
|
Glances - An eye on your system
|
|
|
|
===============================
|
|
|
|
|
2015-11-26 13:24:55 +03:00
|
|
|
.. image:: https://img.shields.io/pypi/v/glances.svg
|
|
|
|
:target: https://pypi.python.org/pypi/Glances
|
2017-01-07 12:26:53 +03:00
|
|
|
|
2015-10-03 17:28:55 +03:00
|
|
|
.. image:: https://img.shields.io/github/stars/nicolargo/glances.svg
|
|
|
|
:target: https://github.com/nicolargo/glances/
|
|
|
|
:alt: Github stars
|
2017-01-07 12:26:53 +03:00
|
|
|
|
2017-01-18 22:00:21 +03:00
|
|
|
.. image:: https://img.shields.io/travis/nicolargo/glances/master.svg?maxAge=3600&label=Linux%20/%20BSD%20/%20macOS
|
2015-11-26 13:24:55 +03:00
|
|
|
:target: https://travis-ci.org/nicolargo/glances
|
2017-01-07 12:26:53 +03:00
|
|
|
:alt: Linux tests (Travis)
|
|
|
|
|
|
|
|
.. image:: https://img.shields.io/appveyor/ci/nicolargo/glances/master.svg?maxAge=3600&label=Windows
|
|
|
|
:target: https://ci.appveyor.com/project/nicolargo/glances
|
|
|
|
:alt: Windows tests (Appveyor)
|
|
|
|
|
2015-09-28 22:21:21 +03:00
|
|
|
.. image:: https://img.shields.io/scrutinizer/g/nicolargo/glances.svg
|
2015-11-26 13:24:55 +03:00
|
|
|
:target: https://scrutinizer-ci.com/g/nicolargo/glances/
|
2015-01-10 18:36:53 +03:00
|
|
|
|
|
|
|
Follow Glances on Twitter: `@nicolargo`_ or `@glances_system`_
|
|
|
|
|
2017-01-07 17:55:32 +03:00
|
|
|
Summary
|
|
|
|
=======
|
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
**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.
|
2017-01-07 17:55:32 +03:00
|
|
|
|
|
|
|
.. image:: https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-summary.png
|
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
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.
|
2017-01-07 17:55:32 +03:00
|
|
|
|
|
|
|
.. image:: https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-responsive-webdesign.png
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
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.
|
2013-04-08 18:16:00 +04:00
|
|
|
|
|
|
|
Requirements
|
|
|
|
============
|
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
- ``python 2.7,>=3.3``
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``psutil>=2.0.0`` (better with latest version)
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2015-04-19 13:45:55 +03:00
|
|
|
Optional dependencies:
|
2014-01-19 21:59:59 +04:00
|
|
|
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``bernhard`` (for the Riemann export module)
|
|
|
|
- ``bottle`` (for Web server mode)
|
2016-09-11 21:18:03 +03:00
|
|
|
- ``cassandra-driver`` (for the Cassandra export module)
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``couchdb`` (for the CouchDB export module)
|
2017-01-22 18:50:45 +03:00
|
|
|
- ``docker`` (for the Docker monitoring support) [Linux-only]
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``elasticsearch`` (for the Elastic Search export module)
|
|
|
|
- ``hddtemp`` (for HDD temperature monitoring support) [Linux-only]
|
|
|
|
- ``influxdb`` (for the InfluxDB export module)
|
2015-05-04 02:05:15 +03:00
|
|
|
- ``matplotlib`` (for graphical/chart support)
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``netifaces`` (for the IP plugin)
|
2017-02-07 14:17:27 +03:00
|
|
|
- ``nvidia-ml-py`` (for the GPU plugin) [Python 2-only]
|
2015-05-06 16:16:10 +03:00
|
|
|
- ``pika`` (for the RabbitMQ/ActiveMQ export module)
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``potsdb`` (for the OpenTSDB export module)
|
2015-09-28 22:21:21 +03:00
|
|
|
- ``py-cpuinfo`` (for the Quicklook CPU info module)
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``pymdstat`` (for RAID support) [Linux-only]
|
|
|
|
- ``pysnmp`` (for SNMP support)
|
|
|
|
- ``pystache`` (for the action script feature)
|
|
|
|
- ``pyzmq`` (for the ZeroMQ export module)
|
2017-03-02 23:03:51 +03:00
|
|
|
- ``requests`` (for the Ports and Cloud plugins)
|
2015-11-21 12:53:49 +03:00
|
|
|
- ``scandir`` (for the Folders plugin) [Only for Python < 3.5]
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``statsd`` (for the StatsD export module)
|
2016-10-21 23:11:13 +03:00
|
|
|
- ``wifi`` (for the wifi plugin) [Linux-only]
|
2017-01-01 16:14:20 +03:00
|
|
|
- ``zeroconf`` (for the autodiscover mode)
|
2014-01-19 21:59:59 +04:00
|
|
|
|
2016-06-02 19:02:16 +03:00
|
|
|
*Note for Python 2.6 users*
|
2016-05-23 16:52:53 +03:00
|
|
|
|
2016-06-02 19:02:16 +03:00
|
|
|
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.
|
2016-05-23 16:52:53 +03:00
|
|
|
|
2013-04-08 18:16:00 +04:00
|
|
|
Installation
|
|
|
|
============
|
|
|
|
|
2016-02-05 18:16:40 +03:00
|
|
|
Several method to test/install Glances on your system. Choose your weapon !
|
|
|
|
|
|
|
|
Glances Auto Install script: the total way
|
|
|
|
------------------------------------------
|
2014-09-09 22:54:53 +04:00
|
|
|
|
2015-04-19 13:45:55 +03:00
|
|
|
To install both dependencies and latest Glances production ready version
|
|
|
|
(aka *master* branch), just enter the following command line:
|
2014-09-09 22:54:53 +04:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2016-02-24 11:18:16 +03:00
|
|
|
curl -L https://bit.ly/glances | /bin/bash
|
2014-09-09 22:54:53 +04:00
|
|
|
|
2015-01-04 18:26:55 +03:00
|
|
|
or
|
2015-01-03 21:11:21 +03:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2016-02-24 11:18:16 +03:00
|
|
|
wget -O- https://bit.ly/glances | /bin/bash
|
2015-01-03 21:11:21 +03:00
|
|
|
|
2015-01-04 19:15:26 +03:00
|
|
|
*Note*: Only supported on some GNU/Linux distributions. If you want to
|
|
|
|
support other distributions, please contribute to `glancesautoinstall`_.
|
2014-09-09 22:54:53 +04:00
|
|
|
|
2013-08-12 03:32:12 +04:00
|
|
|
PyPI: The simple way
|
2013-08-11 22:43:30 +04:00
|
|
|
--------------------
|
|
|
|
|
2015-01-04 18:26:55 +03:00
|
|
|
Glances is on ``PyPI``. By using PyPI, you are sure to have the latest
|
2014-06-08 22:44:49 +04:00
|
|
|
stable version.
|
2014-05-25 20:19:40 +04:00
|
|
|
|
2015-01-04 18:26:55 +03:00
|
|
|
To install, simply use ``pip``:
|
2013-07-14 02:44:00 +04:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2015-05-06 16:16:10 +03:00
|
|
|
pip install glances
|
2013-06-05 15:07:17 +04:00
|
|
|
|
2015-10-05 22:19:07 +03:00
|
|
|
*Note*: Python headers are required to install `psutil`_. For example,
|
2014-05-11 21:55:55 +04:00
|
|
|
on Debian/Ubuntu you need to install first the *python-dev* package.
|
2016-09-03 09:48:38 +03:00
|
|
|
For Fedora/CentOS/RHEL install first *python-devel* package. For Windows,
|
2017-01-21 21:16:15 +03:00
|
|
|
just install psutil from the binary installation file.
|
2014-05-11 19:11:17 +04:00
|
|
|
|
2017-01-26 11:57:26 +03:00
|
|
|
*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.
|
|
|
|
|
2015-04-19 13:45:55 +03:00
|
|
|
You can also install the following libraries in order to use optional
|
2017-02-05 17:17:23 +03:00
|
|
|
features (like the Web interface, exports modules...):
|
2015-01-10 18:36:53 +03:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2017-03-02 23:03:51 +03:00
|
|
|
pip install glances[action,browser,cloud,cpuinfo,chart,docker,export,folders,gpu,ip,raid,snmp,web,wifi]
|
2015-01-10 18:36:53 +03:00
|
|
|
|
2013-08-11 22:43:30 +04:00
|
|
|
To upgrade Glances to the latest version:
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2015-05-06 16:16:10 +03:00
|
|
|
pip install --upgrade glances
|
2017-01-22 18:50:45 +03:00
|
|
|
pip install --upgrade glances[...]
|
2013-08-11 22:43:30 +04:00
|
|
|
|
2015-01-10 18:36:53 +03:00
|
|
|
If you need to install Glances in a specific user location, use:
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
export PYTHONUSERBASE=~/mylocalpath
|
2015-05-06 16:16:10 +03:00
|
|
|
pip install --user glances
|
2015-01-10 18:36:53 +03:00
|
|
|
|
2016-02-05 18:16:40 +03:00
|
|
|
Docker: the funny way
|
|
|
|
---------------------
|
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
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 !
|
2016-02-05 18:16:40 +03:00
|
|
|
|
|
|
|
Get the Glances container:
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
docker pull nicolargo/glances
|
|
|
|
|
2016-09-20 11:41:08 +03:00
|
|
|
Run the container in *console mode*:
|
2016-02-05 18:16:40 +03:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -it docker.io/nicolargo/glances
|
2016-07-29 22:29:44 +03:00
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
Additionally, if you want to use your own glances.conf file, you can
|
|
|
|
create your own Dockerfile:
|
2016-05-27 14:28:51 +03:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
FROM nicolargo/glances
|
|
|
|
COPY glances.conf /glances/conf/glances.conf
|
|
|
|
CMD python -m glances -C /glances/conf/glances.conf $GLANCES_OPT
|
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
Alternatively, you can specify something along the same lines with
|
|
|
|
docker run options:
|
2016-05-27 14:28:51 +03:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
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.
|
2016-02-05 18:16:40 +03:00
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
Run the container in *Web server mode* (notice the `GLANCES_OPT` environment
|
|
|
|
variable setting parameters for the glances startup command):
|
2016-09-20 11:41:08 +03:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
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
|
|
|
|
|
2014-05-25 20:19:40 +04:00
|
|
|
GNU/Linux
|
|
|
|
---------
|
2013-07-14 02:44:00 +04:00
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
`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.
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2013-07-14 02:44:00 +04:00
|
|
|
FreeBSD
|
|
|
|
-------
|
|
|
|
|
2014-01-19 21:59:59 +04:00
|
|
|
To install the binary package:
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2014-01-19 21:59:59 +04:00
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
# pkg install py27-glances
|
|
|
|
|
2013-07-14 02:44:00 +04:00
|
|
|
To install Glances from ports:
|
|
|
|
|
|
|
|
.. code-block:: console
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2013-07-14 02:44:00 +04:00
|
|
|
# cd /usr/ports/sysutils/py-glances/
|
|
|
|
# make install clean
|
2013-06-05 15:07:17 +04:00
|
|
|
|
2017-01-18 22:00:21 +03:00
|
|
|
macOS
|
|
|
|
-----
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2017-01-18 22:00:21 +03:00
|
|
|
macOS users can install Glances using ``Homebrew`` or ``MacPorts``.
|
2013-04-08 18:16:00 +04:00
|
|
|
|
|
|
|
Homebrew
|
|
|
|
````````
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2013-12-17 12:31:43 +04:00
|
|
|
$ brew install python
|
2015-05-06 16:16:10 +03:00
|
|
|
$ pip install glances
|
2013-04-08 18:16:00 +04:00
|
|
|
|
|
|
|
MacPorts
|
|
|
|
````````
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
$ sudo port install glances
|
|
|
|
|
|
|
|
Windows
|
|
|
|
-------
|
|
|
|
|
2015-09-28 22:21:21 +03:00
|
|
|
Install `Python`_ for Windows (Python 2.7.9+ and 3.4+ ship with pip) and
|
|
|
|
then just:
|
2015-05-06 16:16:10 +03:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
$ pip install glances
|
2013-04-08 18:16:00 +04:00
|
|
|
|
|
|
|
Source
|
|
|
|
------
|
|
|
|
|
2015-01-04 19:15:26 +03:00
|
|
|
To install Glances from source:
|
2013-04-08 18:16:00 +04:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2015-09-28 22:21:21 +03:00
|
|
|
$ wget https://github.com/nicolargo/glances/archive/vX.Y.tar.gz -O - | tar xz
|
2013-04-08 18:16:00 +04:00
|
|
|
$ cd glances-*
|
|
|
|
# python setup.py install
|
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
*Note*: Python headers are required to install psutil.
|
2013-09-08 00:17:54 +04:00
|
|
|
|
2015-11-24 22:47:51 +03:00
|
|
|
Chef
|
|
|
|
----
|
|
|
|
|
2017-01-21 21:16:15 +03:00
|
|
|
An awesome ``Chef`` cookbook is available to monitor your infrastructure:
|
|
|
|
https://supermarket.chef.io/cookbooks/glances (thanks to Antoine Rouyer)
|
2015-11-24 22:47:51 +03:00
|
|
|
|
2013-04-08 18:16:00 +04:00
|
|
|
Puppet
|
|
|
|
------
|
|
|
|
|
2015-01-04 18:26:55 +03:00
|
|
|
You can install Glances using ``Puppet``: https://github.com/rverchere/puppet-glances
|
2013-04-08 18:16:00 +04:00
|
|
|
|
|
|
|
Usage
|
|
|
|
=====
|
|
|
|
|
2014-05-25 20:19:40 +04:00
|
|
|
For the standalone mode, just run:
|
2013-04-08 18:16:00 +04:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2013-05-17 17:55:00 +04:00
|
|
|
$ glances
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2014-05-25 20:19:40 +04:00
|
|
|
For the Web server mode, run:
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
$ glances -w
|
|
|
|
|
2014-06-08 22:44:49 +04:00
|
|
|
and enter the URL ``http://<ip>:61208`` in your favorite web browser.
|
2014-05-25 20:19:40 +04:00
|
|
|
|
|
|
|
For the client/server mode, run:
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
$ glances -s
|
|
|
|
|
|
|
|
on the server side and run:
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
$ glances -c <ip>
|
|
|
|
|
|
|
|
on the client one.
|
|
|
|
|
2015-01-04 19:15:26 +03:00
|
|
|
You can also detect and display all Glances servers available on your
|
|
|
|
network or defined in the configuration file:
|
2014-11-16 23:31:02 +03:00
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
2014-11-29 12:17:39 +03:00
|
|
|
$ glances --browser
|
2014-11-16 23:31:02 +03:00
|
|
|
|
2015-01-04 19:15:26 +03:00
|
|
|
and RTFM, always.
|
2013-12-15 13:23:06 +04:00
|
|
|
|
2013-04-08 18:16:00 +04:00
|
|
|
Documentation
|
|
|
|
=============
|
|
|
|
|
2016-03-02 15:29:19 +03:00
|
|
|
For complete documentation have a look at the readthedocs_ website.
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2015-01-04 19:15:26 +03:00
|
|
|
If you have any question (after RTFM!), please post it on the official Q&A `forum`_.
|
2014-09-13 11:25:42 +04:00
|
|
|
|
2015-01-10 18:36:53 +03:00
|
|
|
Gateway to other services
|
|
|
|
=========================
|
|
|
|
|
2017-01-15 00:32:32 +03:00
|
|
|
Glances can export stats to: ``CSV`` file, ``InfluxDB``, ``Cassandra``, ``CouchDB``,
|
|
|
|
``OpenTSDB``, ``StatsD``, ``ElasticSearch``, ``RabbitMQ/ActiveMQ``, ``ZeroMQ``,
|
|
|
|
and ``Riemann`` server.
|
2015-01-10 18:36:53 +03:00
|
|
|
|
2015-01-31 15:45:48 +03:00
|
|
|
How to contribute ?
|
|
|
|
===================
|
|
|
|
|
2015-09-28 22:21:21 +03:00
|
|
|
If you want to contribute to the Glances project, read this `wiki`_ page.
|
2015-01-31 15:45:48 +03:00
|
|
|
|
2015-04-19 13:45:55 +03:00
|
|
|
There is also a chat dedicated to the Glances developers:
|
2015-01-31 15:45:48 +03:00
|
|
|
|
|
|
|
.. image:: https://badges.gitter.im/Join%20Chat.svg
|
|
|
|
:target: https://gitter.im/nicolargo/glances?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
|
|
|
|
2013-04-08 18:16:00 +04:00
|
|
|
Author
|
|
|
|
======
|
|
|
|
|
|
|
|
Nicolas Hennion (@nicolargo) <nicolas@nicolargo.com>
|
|
|
|
|
|
|
|
License
|
|
|
|
=======
|
|
|
|
|
2017-01-21 21:39:34 +03:00
|
|
|
LGPLv3. See ``COPYING`` for more details.
|
2013-04-08 18:16:00 +04:00
|
|
|
|
2015-01-04 18:26:55 +03:00
|
|
|
.. _psutil: https://github.com/giampaolo/psutil
|
2014-09-09 22:54:53 +04:00
|
|
|
.. _glancesautoinstall: https://github.com/nicolargo/glancesautoinstall
|
2013-12-21 16:13:51 +04:00
|
|
|
.. _@nicolargo: https://twitter.com/nicolargo
|
|
|
|
.. _@glances_system: https://twitter.com/glances_system
|
2015-09-28 22:21:21 +03:00
|
|
|
.. _Python: https://www.python.org/getit/
|
2016-07-06 17:26:49 +03:00
|
|
|
.. _readthedocs: https://glances.readthedocs.io/
|
2014-09-13 11:25:42 +04:00
|
|
|
.. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users
|
2015-09-28 22:21:21 +03:00
|
|
|
.. _wiki: https://github.com/nicolargo/glances/wiki/How-to-contribute-to-Glances-%3F
|