You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
473 lines
14 KiB
473 lines
14 KiB
Metadata-Version: 2.1
|
|
Name: Glances
|
|
Version: 3.0.2
|
|
Summary: A cross-platform curses-based monitoring tool
|
|
Home-page: https://github.com/nicolargo/glances
|
|
Author: Nicolas Hennion
|
|
Author-email: nicolas@nicolargo.com
|
|
License: LGPLv3
|
|
Keywords: cli curses monitoring system
|
|
Platform: UNKNOWN
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Environment :: Console :: Curses
|
|
Classifier: Environment :: Web Environment
|
|
Classifier: Framework :: Bottle
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Intended Audience :: End Users/Desktop
|
|
Classifier: Intended Audience :: System Administrators
|
|
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python :: 2
|
|
Classifier: Programming Language :: Python :: 2.7
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.4
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Topic :: System :: Monitoring
|
|
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
|
|
Requires-Dist: psutil (>=5.3.0)
|
|
Provides-Extra: action
|
|
Requires-Dist: pystache ; extra == 'action'
|
|
Provides-Extra: browser
|
|
Requires-Dist: zeroconf (>=0.19.1) ; extra == 'browser'
|
|
Provides-Extra: cloud
|
|
Requires-Dist: requests ; extra == 'cloud'
|
|
Provides-Extra: cpuinfo
|
|
Requires-Dist: py-cpuinfo ; extra == 'cpuinfo'
|
|
Provides-Extra: docker
|
|
Requires-Dist: docker (>=2.0.0) ; extra == 'docker'
|
|
Provides-Extra: export
|
|
Requires-Dist: bernhard ; extra == 'export'
|
|
Requires-Dist: cassandra-driver ; extra == 'export'
|
|
Requires-Dist: couchdb ; extra == 'export'
|
|
Requires-Dist: elasticsearch ; extra == 'export'
|
|
Requires-Dist: influxdb (>=1.0.0) ; extra == 'export'
|
|
Requires-Dist: kafka-python ; extra == 'export'
|
|
Requires-Dist: pika ; extra == 'export'
|
|
Requires-Dist: paho-mqtt ; extra == 'export'
|
|
Requires-Dist: potsdb ; extra == 'export'
|
|
Requires-Dist: prometheus-client ; extra == 'export'
|
|
Requires-Dist: pyzmq ; extra == 'export'
|
|
Requires-Dist: statsd ; extra == 'export'
|
|
Provides-Extra: folders
|
|
Requires-Dist: scandir ; extra == 'folders'
|
|
Provides-Extra: gpu
|
|
Requires-Dist: nvidia-ml-py3 ; extra == 'gpu'
|
|
Provides-Extra: graph
|
|
Requires-Dist: pygal ; extra == 'graph'
|
|
Provides-Extra: ip
|
|
Requires-Dist: netifaces ; extra == 'ip'
|
|
Provides-Extra: raid
|
|
Requires-Dist: pymdstat ; extra == 'raid'
|
|
Provides-Extra: snmp
|
|
Requires-Dist: pysnmp ; extra == 'snmp'
|
|
Provides-Extra: web
|
|
Requires-Dist: bottle ; extra == 'web'
|
|
Requires-Dist: requests ; extra == 'web'
|
|
Provides-Extra: wifi
|
|
Requires-Dist: wifi ; extra == 'wifi'
|
|
|
|
===============================
|
|
Glances - An eye on your system
|
|
===============================
|
|
|
|
.. image:: https://img.shields.io/pypi/v/glances.svg
|
|
:target: https://pypi.python.org/pypi/Glances
|
|
|
|
.. image:: https://img.shields.io/github/stars/nicolargo/glances.svg
|
|
:target: https://github.com/nicolargo/glances/
|
|
:alt: Github stars
|
|
|
|
.. image:: https://img.shields.io/travis/nicolargo/glances/master.svg?maxAge=3600&label=Linux%20/%20BSD%20/%20macOS
|
|
:target: https://travis-ci.org/nicolargo/glances
|
|
: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)
|
|
|
|
.. image:: https://img.shields.io/scrutinizer/g/nicolargo/glances.svg
|
|
:target: https://scrutinizer-ci.com/g/nicolargo/glances/
|
|
|
|
.. image:: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fnicolargo%2Fglances.svg?type=shield
|
|
:target: https://app.fossa.io/projects/git%2Bgithub.com%2Fnicolargo%2Fglances?ref=badge_shield
|
|
|
|
.. image:: https://img.shields.io/badge/Donate-PayPal-green.svg
|
|
:target: https://www.paypal.me/nicolargo
|
|
|
|
Follow Glances on Twitter: `@nicolargo`_
|
|
|
|
Summary
|
|
=======
|
|
|
|
**Glances** is a cross-platform monitoring tool which aims to present a
|
|
large amount of monitoring information through a curses or Web
|
|
based interface. The information dynamically adapts depending on the
|
|
size of the user interface.
|
|
|
|
.. image:: 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.
|
|
|
|
.. image:: 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.4``
|
|
- ``psutil>=5.3.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)
|
|
- ``netifaces`` (for the IP plugin)
|
|
- ``nvidia-ml-py3`` (for the GPU plugin)
|
|
- ``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)
|
|
- ``pystache`` (for the action script feature)
|
|
- ``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]
|
|
- ``statsd`` (for the StatsD export module)
|
|
- ``wifi`` (for the wifi plugin) [Linux-only]
|
|
- ``zeroconf`` (for the autodiscover mode)
|
|
|
|
*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).
|
|
|
|
*Note for CentOS Linux 6 and 7 users*
|
|
|
|
Python 2.7 and 3.4 are now available via SCL repositories. See:
|
|
https://lists.centos.org/pipermail/centos-announce/2015-December/021555.html.
|
|
|
|
Installation
|
|
============
|
|
|
|
There are several methods to test/install Glances on your system. Choose your weapon!
|
|
|
|
Glances Auto Install script: the total way
|
|
------------------------------------------
|
|
|
|
To install both dependencies and the latest Glances production ready version
|
|
(aka *master* branch), just enter the following command line:
|
|
|
|
.. code-block:: console
|
|
|
|
curl -L https://bit.ly/glances | /bin/bash
|
|
|
|
or
|
|
|
|
.. code-block:: console
|
|
|
|
wget -O- https://bit.ly/glances | /bin/bash
|
|
|
|
*Note*: This is 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 will be using the latest
|
|
stable version.
|
|
|
|
To install, simply use ``pip``:
|
|
|
|
.. code-block:: console
|
|
|
|
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...):
|
|
|
|
.. code-block:: console
|
|
|
|
pip install 'glances[action,browser,cloud,cpuinfo,chart,docker,export,folders,gpu,ip,raid,snmp,web,wifi]'
|
|
|
|
To upgrade Glances to the latest version:
|
|
|
|
.. code-block:: console
|
|
|
|
pip install --upgrade glances
|
|
pip install --upgrade glances[...]
|
|
|
|
If you need to install Glances in a specific user location, use:
|
|
|
|
.. code-block:: console
|
|
|
|
export PYTHONUSERBASE=~/mylocalpath
|
|
pip install --user glances
|
|
|
|
Docker: the funny way
|
|
---------------------
|
|
|
|
A Glances container is available. It includes the latest development
|
|
HEAD version. You can use it to monitor your server and all your other
|
|
containers!
|
|
|
|
Get the Glances container:
|
|
|
|
.. code-block:: console
|
|
|
|
docker pull nicolargo/glances
|
|
|
|
Run the container in *console mode*:
|
|
|
|
.. code-block:: console
|
|
|
|
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it docker.io/nicolargo/glances
|
|
|
|
Additionally, if you want to use your own glances.conf file, you can
|
|
create your own Dockerfile:
|
|
|
|
.. code-block:: console
|
|
|
|
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:
|
|
|
|
.. 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.
|
|
|
|
Run the container in *Web server mode* (notice the `GLANCES_OPT` environment
|
|
variable setting parameters for the glances startup command):
|
|
|
|
.. 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
|
|
|
|
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.
|
|
|
|
FreeBSD
|
|
-------
|
|
|
|
To install the binary package:
|
|
|
|
.. code-block:: console
|
|
|
|
# pkg install py27-glances
|
|
|
|
To install Glances from ports:
|
|
|
|
.. code-block:: console
|
|
|
|
# cd /usr/ports/sysutils/py-glances/
|
|
# make install clean
|
|
|
|
macOS
|
|
-----
|
|
|
|
macOS users can install Glances using ``Homebrew`` or ``MacPorts``.
|
|
|
|
Homebrew
|
|
````````
|
|
|
|
.. code-block:: console
|
|
|
|
$ brew install glances
|
|
|
|
MacPorts
|
|
````````
|
|
|
|
.. code-block:: console
|
|
|
|
$ 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:
|
|
|
|
.. code-block:: console
|
|
|
|
$ pip install glances
|
|
|
|
Alternatively, you could clone the repository and install with the following command.
|
|
|
|
.. code-block:: console
|
|
|
|
$ git clone https://github.com/nicolargo/glances.git
|
|
$ cd glances
|
|
$ python setup.py install
|
|
|
|
|
|
Android
|
|
-------
|
|
|
|
You need a rooted device and the `Termux`_ application (available on the
|
|
Google Play Store).
|
|
|
|
Start Termux on your device and enter:
|
|
|
|
.. code-block:: console
|
|
|
|
$ apt update
|
|
$ apt upgrade
|
|
$ apt install clang python python-dev
|
|
$ pip install bottle
|
|
$ pip install glances
|
|
|
|
And start Glances:
|
|
|
|
.. code-block:: console
|
|
|
|
$ 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:
|
|
|
|
.. code-block:: console
|
|
|
|
$ 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:
|
|
|
|
.. code-block:: console
|
|
|
|
$ glances
|
|
|
|
For the Web server mode, run:
|
|
|
|
.. code-block:: console
|
|
|
|
$ glances -w
|
|
|
|
and enter the URL ``http://<ip>:61208`` in your favorite web browser.
|
|
|
|
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.
|
|
|
|
You can also detect and display all Glances servers available on your
|
|
network or defined in the configuration file:
|
|
|
|
.. code-block:: console
|
|
|
|
$ 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, ``JSON`` file, ``InfluxDB``, ``Cassandra``, ``CouchDB``,
|
|
``OpenTSDB``, ``Prometheus``, ``StatsD``, ``ElasticSearch``, ``RabbitMQ/ActiveMQ``,
|
|
``ZeroMQ``, ``Kafka``, ``Riemann`` 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:
|
|
|
|
.. 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
|
|
|
|
Author
|
|
======
|
|
|
|
Nicolas Hennion (@nicolargo) <nicolas@nicolargo.com>
|
|
|
|
License
|
|
=======
|
|
|
|
LGPLv3. See ``COPYING`` for more details.
|
|
|
|
.. _psutil: https://github.com/giampaolo/psutil
|
|
.. _glancesautoinstall: https://github.com/nicolargo/glancesautoinstall
|
|
.. _@nicolargo: https://twitter.com/nicolargo
|
|
.. _Python: https://www.python.org/getit/
|
|
.. _Termux: https://play.google.com/store/apps/details?id=com.termux
|
|
.. _readthedocs: https://glances.readthedocs.io/
|
|
.. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users
|
|
.. _wiki: https://github.com/nicolargo/glances/wiki/How-to-contribute-to-Glances-%3F
|
|
|
|
|