glances/README.rst

261 lines
6.5 KiB
ReStructuredText
Raw Normal View History

2013-12-26 18:03:50 +04:00
===============================
Glances - An eye on your system
===============================
2013-05-17 18:11:00 +04:00
.. image:: https://api.flattr.com/button/flattr-badge-large.png
2013-04-08 18:16:00 +04:00
:target: https://flattr.com/thing/484466/nicolargoglances-on-GitHub
2014-12-16 17:04:05 +03:00
.. image:: https://scrutinizer-ci.com/g/nicolargo/glances/badges/quality-score.png?b=master
:target: https://scrutinizer-ci.com/g/nicolargo/glances/
2013-04-08 18:16:00 +04:00
.. image:: https://travis-ci.org/nicolargo/glances.png?branch=master
:target: https://travis-ci.org/nicolargo/glances
2013-08-15 13:43:31 +04:00
.. image:: https://badge.fury.io/py/Glances.png
2013-10-28 16:13:13 +04:00
:target: http://badge.fury.io/py/Glances
2013-12-26 17:58:11 +04:00
.. image:: https://pypip.in/d/Glances/badge.png
:target: https://pypi.python.org/pypi/Glances/
:alt: Downloads
2013-04-08 18:16:00 +04:00
2015-01-10 18:36:53 +03:00
Follow Glances on Twitter: `@nicolargo`_ or `@glances_system`_
2014-06-08 22:44:49 +04:00
**Glances** is a cross-platform curses-based system monitoring tool
written in Python.
2013-04-08 18:16:00 +04:00
It uses the `psutil`_ library to get information from your system.
2013-05-17 18:11:00 +04:00
.. image:: https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png
2013-04-08 18:16:00 +04:00
Requirements
============
- ``python >= 2.6`` or ``>= 3.3`` (tested with version 2.6, 2.7, 3.3, 3.4)
2014-05-11 21:55:55 +04:00
- ``psutil >= 2.0.0``
2013-04-08 18:16:00 +04:00
- ``setuptools``
2015-01-10 18:36:53 +03:00
Optionals dependencies:
2014-06-08 22:44:49 +04:00
- ``bottle`` (for Web server mode)
2014-05-25 20:19:40 +04:00
- ``py3sensors`` (for hardware monitoring support) [Linux-only]
2014-06-08 22:44:49 +04:00
- ``hddtemp`` (for HDD temperature monitoring support) [Linux-only]
- ``batinfo`` (for battery monitoring support) [Linux-only]
- ``pymdstat`` (for RAID support) [Linux-only]
2014-06-08 22:44:49 +04:00
- ``pysnmp`` (for SNMP support)
2014-11-29 12:17:39 +03:00
- ``zeroconf`` and ``netifaces`` (for the auto discoverer mode)
- ``influxdb`` (for the InfluxDB export module)
2015-01-03 01:31:05 +03:00
- ``statsd`` (for the StatsD export module)
- ``pystache`` (for the action script feature)
2015-01-04 22:59:04 +03:00
- ``docker-py`` (for the Docker monitoring support) [Linux-only]
2013-04-08 18:16:00 +04:00
Installation
============
2014-09-09 22:54:53 +04:00
Glances Auto Install script
---------------------------
2015-01-10 18:36:53 +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
curl -L http://bit.ly/glances | /bin/bash
or
.. code-block:: console
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`_.
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
--------------------
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
To install, simply use ``pip``:
.. code-block:: console
pip install Glances
2013-06-05 15:07:17 +04:00
2014-06-08 22:44:49 +04: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.
2015-01-10 18:36:53 +03:00
*Note 2*: You can also install the following libs in order to use optionnal features:
.. code-block:: console
pip install bottle batinfo https://bitbucket.org/gleb_zhulik/py3sensors/get/tip.tar.gz zeroconf netifaces pymdstat influxdb statsd pystache
2013-08-11 22:43:30 +04:00
To upgrade Glances to the latest version:
.. code-block:: console
pip install --upgrade Glances
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
pip install --user Glances
2014-05-25 20:19:40 +04:00
GNU/Linux
---------
2014-05-25 20:19:40 +04:00
At the moment, packages exist for the following GNU/Linux distributions:
- Arch Linux
- Debian (Testing/Sid)
- Fedora/CentOS/RHEL
- Gentoo
2014-11-29 16:12:25 +03:00
- Slackware (SlackBuild)
- Ubuntu (13.04+)
- Void Linux
So you should be able to install it using your favorite package manager.
2013-04-08 18:16:00 +04:00
FreeBSD
-------
To install the binary package:
2013-04-08 18:16:00 +04:00
.. code-block:: console
# pkg install py27-glances
To install Glances from ports:
.. code-block:: console
2013-04-08 18:16:00 +04:00
# cd /usr/ports/sysutils/py-glances/
# make install clean
2013-06-05 15:07:17 +04:00
2013-04-08 18:16:00 +04:00
OS X
----
OS X users can install Glances using ``Homebrew`` or ``MacPorts``.
2013-04-08 18:16:00 +04:00
Homebrew
````````
.. code-block:: console
$ brew install python
$ pip install Glances
2013-04-08 18:16:00 +04:00
MacPorts
````````
.. code-block:: console
$ sudo port install glances
Windows
-------
2013-08-12 03:32:12 +04:00
- Install Python for Windows: http://www.python.org/getit/
2013-10-28 16:13:13 +04:00
- Install the psutil library: https://pypi.python.org/pypi?:action=display&name=psutil#downloads
- Install the colorconsole library: https://pypi.python.org/pypi/colorconsole
2015-01-10 18:36:53 +03:00
- Install Glances Download Glances from here: http://nicolargo.github.io/glances/
2013-04-08 18:16:00 +04:00
Source
------
To install Glances from source:
2013-04-08 18:16:00 +04:00
.. code-block:: console
2014-05-21 16:43:00 +04:00
$ curl -L https://github.com/nicolargo/glances/archive/vX.Y.tar.gz -o glances-X.Y.tar.gz
2013-04-08 18:16:00 +04:00
$ tar -zxvf glances-*.tar.gz
$ cd glances-*
# python setup.py install
2014-05-11 21:55:55 +04:00
*Note*: Python headers are required to install psutil. For example,
on Debian/Ubuntu you need to install first the *python-dev* package.
2013-04-08 18:16:00 +04:00
Puppet
------
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
$ 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.
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
and RTFM, always.
2013-12-15 13:23:06 +04:00
2013-04-08 18:16:00 +04:00
Documentation
=============
2013-05-17 20:52:00 +04:00
For complete documentation see `glances-doc`_.
2013-04-08 18:16:00 +04: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
=========================
Glances can export stats to: ``CSV`` file, ``InfluxDB`` and ``StatsD`` server.
2015-01-31 15:45:48 +03:00
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:
.. 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
=======
LGPL. See ``COPYING`` for more details.
.. _psutil: https://github.com/giampaolo/psutil
2014-09-09 22:54:53 +04:00
.. _glancesautoinstall: https://github.com/nicolargo/glancesautoinstall
.. _@nicolargo: https://twitter.com/nicolargo
.. _@glances_system: https://twitter.com/glances_system
2013-05-17 20:52:00 +04:00
.. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst
2014-09-13 11:25:42 +04:00
.. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users
2015-01-31 15:50:06 +03:00
.. _Wiki: https://github.com/nicolargo/glances/wiki/How-to-contribute-to-Glances-%3F