1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
===============================
Glances - An eye on your system
===============================
.. image:: https://api.flattr.com/button/flattr-badge-large.png
:target: https://flattr.com/thing/484466/nicolargoglances-on-GitHub
.. image:: https://scrutinizer-ci.com/g/nicolargo/glances/badges/quality-score.png?b=master
:target: https://scrutinizer-ci.com/g/nicolargo/glances/
.. image:: https://travis-ci.org/nicolargo/glances.png?branch=master
:target: https://travis-ci.org/nicolargo/glances
.. image:: https://badge.fury.io/py/Glances.png
:target: http://badge.fury.io/py/Glances
.. image:: https://pypip.in/d/Glances/badge.png
:target: https://pypi.python.org/pypi/Glances/
:alt: Downloads
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.
.. image:: https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png
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:
.. 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`_.
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``:
.. 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.
*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
To upgrade Glances to the latest version:
.. code-block:: console
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
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:
.. code-block:: console
# pkg install py27-glances
To install Glances from ports:
.. code-block:: console
# cd /usr/ports/sysutils/py-glances/
# make install clean
OS X
----
OS X users can install Glances using ``Homebrew`` or ``MacPorts``.
Homebrew
````````
.. code-block:: console
$ brew install python
$ pip install Glances
MacPorts
````````
.. code-block:: console
$ 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:
.. code-block:: console
$ 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:
.. 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 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:
.. 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
=======
LGPL. See ``COPYING`` for more details.
.. _psutil: https://github.com/giampaolo/psutil
.. _glancesautoinstall: https://github.com/nicolargo/glancesautoinstall
.. _@nicolargo: https://twitter.com/nicolargo
.. _@glances_system: https://twitter.com/glances_system
.. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst
.. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users
.. _Wiki: https://github.com/nicolargo/glances/wiki/How-to-contribute-to-Glances-%3F
|