diff options
| -rw-r--r-- | README.rst | 26 | ||||
| -rw-r--r-- | docs/gw/cassandra.rst | 3 | ||||
| -rw-r--r-- | docs/index.rst | 9 | ||||
| -rw-r--r-- | docs/install.rst | 36 |
4 files changed, 59 insertions, 15 deletions
@@ -100,21 +100,15 @@ To install, simply use ``pip``: *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 Fedora/CentOS/RHEL install first *python-devel* package. For Windows, +just install PsUtil from the binary installation file. You can also install the following libraries in order to use optional -features (like the Web interface): +features (like the Web interface, exports modules, sensors...): .. code-block:: console - pip install bottle batinfo https://bitbucket.org/gleb_zhulik/py3sensors/get/tip.tar.gz zeroconf netifaces pymdstat influxdb potsdb statsd pystache docker-py pysnmp pika py-cpuinfo scandir - -Install or upgrade Glances from the Git ``develop`` repository: - -.. code-block:: console - - git clone -b develop https://github.com/nicolargo/glances.git - + pip install bottle requests batinfo https://bitbucket.org/gleb_zhulik/py3sensors/get/tip.tar.gz zeroconf netifaces pymdstat influxdb elasticsearch potsdb statsd pystache docker-py pysnmp pika py-cpuinfo bernhard cassandra scandir To upgrade Glances to the latest version: @@ -183,6 +177,7 @@ At the moment, packages exist for the following GNU/Linux distributions: - Void Linux So you should be able to install it using your favorite package manager. +Be aware that the Glances version can not be the latest one using this method. FreeBSD ------- @@ -230,6 +225,13 @@ then just: $ pip install glances +You can also install the following libraries in order to use optional +features (like the Web interface, exports modules, sensors...): + +.. code-block:: console + + pip install bottle requests zeroconf netifaces influxdb elasticsearch potsdb statsd pystache pysnmp pika py-cpuinfo bernhard cassandra scandir + Source ------ @@ -304,8 +306,8 @@ If you have any question (after RTFM!), please post it on the official Q&A `foru Gateway to other services ========================= -Glances can export stats to: ``CSV`` file, ``InfluxDB``, ``OpenTSDB``, -``StatsD``, ``ElasticSearch``, ``RabbitMQ`` and ``Riemann`` server. +Glances can export stats to: ``CSV`` file, ``InfluxDB``, ``Cassandra``, +``OpenTSDB``, ``StatsD``, ``ElasticSearch``, ``RabbitMQ`` and ``Riemann`` server. How to contribute ? =================== diff --git a/docs/gw/cassandra.rst b/docs/gw/cassandra.rst index 2f514d1b..59700af9 100644 --- a/docs/gw/cassandra.rst +++ b/docs/gw/cassandra.rst @@ -1,6 +1,6 @@ .. _cassandra: -CASSANDRA +Cassandra ========= You can export statistics to an ``Cassandra`` or ``Scylla`` server. @@ -30,3 +30,4 @@ The data model is the following: CREATE TABLE <table> (plugin text, time timeuuid, stat map<text,float>, PRIMARY KEY (plugin, time)) Only numerical stats are stored in the Cassandra table. All the stats are converted to float. +If a stat can not be converted to float, it is not stored in the database. diff --git a/docs/index.rst b/docs/index.rst index 54177786..b8796d6f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,12 +7,16 @@ Glances is a cross-platform curses-based monitoring tool which aims to present a maximum of information in a minimum of space, ideally to fit in a classical 80x24 terminal or higher to have additional information. It can adapt dynamically the displayed information depending on the -terminal size. It can also work in client/server mode. Remote monitoring -could be done via terminal or web interface. +terminal size. + +It can also work in client/server mode. Remote monitoring +could be done via terminal or Web interface. Glances is written in Python and uses the `psutil`_ library to get information from your system. +Stats can also be exported to external time/value databases. + .. _psutil: https://github.com/giampaolo/psutil Table of Contents @@ -21,6 +25,7 @@ Table of Contents .. toctree:: :maxdepth: 2 + install quickstart cmds config diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 00000000..496d9f09 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,36 @@ +.. _install: + +Install +======= + +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. +For Fedora/CentOS/RHEL install first *python-devel* package. For Windows, +just install PsUtil from the binary installation file. + +You can also install the following libraries in order to use optional +features (like the Web interface, exports modules, sensors...): + +.. code-block:: console + + pip install bottle requests batinfo https://bitbucket.org/gleb_zhulik/py3sensors/get/tip.tar.gz zeroconf netifaces pymdstat influxdb elasticsearch potsdb statsd pystache docker-py pysnmp pika py-cpuinfo bernhard cassandra scandir + +To upgrade Glances to the latest version: + +.. code-block:: console + + pip install --upgrade glances + +For additionnal installation methods, read the official `README`_ file. + +.. _psutil: https://github.com/giampaolo/psutil +.. _README: https://github.com/nicolargo/glances/blob/master/README.rst |