diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 40 |
1 files changed, 27 insertions, 13 deletions
@@ -40,16 +40,22 @@ Glances - An eye on your system 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. +**Glances** is an open-source system cross-platform monitoring tool. +It allows real-time monitoring of various aspects of your system such as +CPU, memory, disk, network usage etc. It also allows monitoring of running processes, +logged in users, temperatures, voltages, fan speeds etc. +It also supports container monitoring, it supports different container management +systems such as Docker, LXC. The information is presented in an easy to read dashboard +and can also be used for remote monitoring of systems via a web interface or command +line interface. It is easy to install and use and can be customized to show only +the information that you are interested in. .. 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. +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, CSV or direct +output to STDOUT. .. image:: https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-responsive-webdesign.png @@ -96,7 +102,7 @@ Optional dependencies: - ``cassandra-driver`` (for the Cassandra export module) - ``chevron`` (for the action script feature) - ``couchdb`` (for the CouchDB export module) -- ``docker`` (for the Docker monitoring support) [Linux/macOS-only] +- ``docker`` (for the Containers Docker monitoring support) [Linux/macOS-only / Python >= 3.6] - ``elasticsearch`` (for the Elastic Search export module) - ``graphitesender`` (For the Graphite export module) - ``hddtemp`` (for HDD temperature monitoring support) [Linux-only] @@ -106,11 +112,13 @@ Optional dependencies: - ``netifaces`` (for the IP plugin) - ``py3nvml`` (for the GPU plugin) [Only for Python 3] - ``pika`` (for the RabbitMQ/ActiveMQ export module) +- ``podman`` (for the Containers Podman monitoring support) [Linux/macOS-only / Python >= 3.6] - ``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] +- ``pymongo`` (for the MongoDB export module) [Only for Python >= 3.7] - ``pysnmp`` (for SNMP support) - ``pySMART.smartx`` (for HDD Smart support) [Linux-only] - ``pyzmq`` (for the ZeroMQ export module) @@ -157,7 +165,7 @@ For a full installation (with all features): .. code-block:: console - pip install --user 'glances[action,browser,cloud,cpuinfo,docker,export,folders,gpu,graph,ip,raid,snmp,web,wifi]' + pip install --user 'glances[all]' To upgrade Glances to the latest version: @@ -208,12 +216,15 @@ The following tags are availables: - *latest-full* for a full Alpine Glances image (latest release) with all dependencies - *latest* for a basic Alpine Glances (latest release) version with minimal dependencies (Bottle and Docker) - *dev* for a basic Alpine Glances image (based on development branch) with all dependencies (Warning: may be instable) +- *ubuntu-latest-full* for a full Ubuntu Glances image (latest release) with all dependencies +- *ubuntu-latest* for a basic Ubuntu Glances (latest release) version with minimal dependencies (Bottle and Docker) +- *ubuntu-dev* for a basic Ubuntu Glances image (based on development branch) with all dependencies (Warning: may be instable) Run last version of Glances 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 nicolargo/glances:latest-full + docker run --rm -e TZ="${TZ}" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it nicolargo/glances:latest-full Additionally, if you want to use your own glances.conf file, you can create your own Dockerfile: @@ -230,7 +241,7 @@ variable setting parameters for the glances startup command): .. code-block:: console - docker run -v `pwd`/glances.conf:/etc/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -e GLANCES_OPT="-C /etc/glances.conf" -it nicolargo/glances:latest-full + docker run -e TZ="${TZ}" -v `pwd`/glances.conf:/etc/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -e GLANCES_OPT="-C /etc/glances.conf" -it nicolargo/glances:latest-full Where \`pwd\`/glances.conf is a local directory containing your glances.conf file. @@ -238,7 +249,9 @@ Run the container in *Web server mode*: .. 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 nicolargo/glances:latest-full + docker run -d --restart="always" -p 61208-61209:61208-61209 -e TZ="${TZ}" -e GLANCES_OPT="-w" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host nicolargo/glances:latest-full + +For a full list of options, see the Glances `Docker`_ documentation page. GNU/Linux --------- @@ -474,4 +487,5 @@ Glances is distributed under the LGPL version 3 license. See ``COPYING`` for mor .. _sponsors: https://github.com/sponsors/nicolargo .. _wishlist: https://www.amazon.fr/hz/wishlist/ls/BWAAQKWFR3FI?ref_=wl_share .. _issue2021: https://github.com/nicolargo/glances/issues/2021#issuecomment-1197831157 -.. _issue2021comment: https://github.com/nicolargo/glances/issues/2021#issuecomment-1197831157
\ No newline at end of file +.. _issue2021comment: https://github.com/nicolargo/glances/issues/2021#issuecomment-1197831157 +.. _Docker: https://github.com/nicolargo/glances/blob/develop/docs/docker.rst |