mirror
/
glances
mirror of https://github.com/nicolargo/glances.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation

This commit is contained in:
nicolargo 2025-06-30 08:04:14 +02:00
parent 155452e223
commit 82a829d0c4
3 changed files with 377 additions and 363 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.rst
View File

@ -124,6 +124,7 @@ Optional dependencies:
- ``podman`` (for the Containers Podman monitoring support) - ``podman`` (for the Containers Podman monitoring support)
- ``potsdb`` (for the OpenTSDB export module) - ``potsdb`` (for the OpenTSDB export module)
- ``prometheus_client`` (for the Prometheus export module) - ``prometheus_client`` (for the Prometheus export module)
- ``psycopg[binary]`` (for the PostgreSQL/TimeScale export module)
- ``pygal`` (for the graph export module) - ``pygal`` (for the graph export module)
- ``pymdstat`` (for RAID support) [Linux-only] - ``pymdstat`` (for RAID support) [Linux-only]
- ``pymongo`` (for the MongoDB export module) - ``pymongo`` (for the MongoDB export module)
@ -410,12 +411,13 @@ Shell tab completion
Glances 4.3.2 and higher includes shell tab autocompletion thanks to the --print-completion option. Glances 4.3.2 and higher includes shell tab autocompletion thanks to the --print-completion option.
For example, on a Linux operating system with Bash shell: For example, on a Linux operating system with bash shell:
.. code-block:: console .. code-block:: console
$ glances --print-completion bash | sudo tee -a /etc/bash_completion.d/glances $ mkdir -p ${XDG_DATA_HOME:="$HOME/.local/share"}/bash-completion
$ source /etc/bash_completion.d/glances $ glances --print-completion bash > ${XDG_DATA_HOME:="$HOME/.local/share"}/bash-completion/glances
$ source ${XDG_DATA_HOME:="$HOME/.local/share"}/bash-completion/glances
Following shells are supported: bash, zsh and tcsh. Following shells are supported: bash, zsh and tcsh.
@ -501,9 +503,23 @@ If you have any question (after RTFM!), please post it on the official Q&A `foru
Gateway to other services Gateway to other services
========================= =========================
Glances can export stats to: ``CSV`` file, ``JSON`` file, ``InfluxDB``, ``Cassandra``, ``CouchDB``, Glances can export stats to:
``OpenTSDB``, ``Prometheus``, ``StatsD``, ``ElasticSearch``, ``RabbitMQ/ActiveMQ``, - ``CSV`` file
``ZeroMQ``, ``Kafka``, ``Riemann``, ``Graphite`` and ``RESTful`` server. - ``JSON`` file
- ``InfluxDB`` server
- ``Cassandra`` server
- ``CouchDB`` server
- ``OpenTSDB`` server
- ``Prometheus`` server
- ``StatsD`` server
- ``ElasticSearch`` server
- ``PostgreSQL/TimeScale`` server
- ``RabbitMQ/ActiveMQ`` broker
- ``ZeroMQ`` broker
- ``Kafka`` broker
- ``Riemann`` server
- ``Graphite`` server
- ``RESTful`` endpoint
How to contribute ? How to contribute ?
=================== ===================

710
docs/api.rst
View File

File diff suppressed because it is too large Load Diff

2
docs/man/glances.1
View File

@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "GLANCES" "1" "Jun 29, 2025" "4.3.2_dev05" "Glances" .TH "GLANCES" "1" "Jun 30, 2025" "4.3.2_rc01" "Glances"
.SH NAME .SH NAME
glances \- An eye on your system glances \- An eye on your system
.SH SYNOPSIS .SH SYNOPSIS