mirror of
https://github.com/nicolargo/glances.git
synced 2024-11-14 10:20:03 +03:00
glances-doc.rst: wrap source lines to 72 characters (where possible)
- Fix various typos and misspelling - TOC improvements
This commit is contained in:
Alessio Sergi
parent
4d07670c8d
commit
1d509f471e
@ -67,7 +67,13 @@ and on the client:
|
||||
|
||||
where ``@server`` is the IP address or hostname of the server.
|
||||
|
||||
Glances can centralize available Glances servers using the ``--browser`` option. The server list can be staticaly defined in the Glances configuration file (section [serverlist]). Glances can also detect and display all Glances servers available on you network (auto discover mode is based on the the Zeroconf protocol only available on GNU/Linux and Mac OS X):
|
||||
Glances can centralize available Glances servers using the ``--browser``
|
||||
option. The server list can be statically defined in the Glances
|
||||
configuration file (section ``[serverlist]``).
|
||||
|
||||
Glances can also detect and display all Glances servers available on your
|
||||
network (auto-discover mode is based on the the ``zeroconf`` protocol,
|
||||
which is only available on GNU/Linux and OS X):
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -97,7 +103,7 @@ client, the latter will try to grab stats using the ``SNMP`` protocol:
|
||||
|
||||
client$ glances -c @snmpserver
|
||||
|
||||
Note: Stats grabbed by SNMP request are limited (operating system dependent).
|
||||
*Note*: stats grabbed by SNMP request are limited (OS dependent).
|
||||
|
||||
Web Server Mode
|
||||
---------------
|
||||
@ -117,7 +123,12 @@ and on the client enter the following URL in your favorite web browser:
|
||||
|
||||
where ``@server`` is the IP address or hostname of the server.
|
||||
|
||||
To change the refresh rate of the page, just add the period in seconds between refreshes at the end of the URL, ie. to refresh every 10s, use ``http://@server:61208/10``.
|
||||
To change the refresh rate of the page, just add the period in seconds
|
||||
at the end of the URL. For example, to refresh the page every 10s:
|
||||
|
||||
::
|
||||
|
||||
http://@server:61208/10
|
||||
|
||||
The Glances web interface follows responsive web design principles.
|
||||
|
||||
@ -125,7 +136,6 @@ Screenshot from Chrome on Android
|
||||
|
||||
.. image:: images/screenshot-web2.png
|
||||
|
||||
|
||||
Command Reference
|
||||
=================
|
||||
|
||||
@ -272,7 +282,8 @@ The following commands (key pressed) are supported while in Glances:
|
||||
``/``
|
||||
Switch between short name / command line (processes name)
|
||||
|
||||
In the Glances client browser (accessible through the --browser command line argument):
|
||||
In the Glances client browser (accessible through the ``--browser``
|
||||
command line argument):
|
||||
|
||||
``ENTER``
|
||||
Run Glances client to the selected server
|
||||
@ -357,10 +368,11 @@ can ben logged using the -d option on the command line.
|
||||
|
||||
By default, the log file is under:
|
||||
|
||||
:Linux, \*BSD and OS X: ``/tmp/glances.log``
|
||||
:Linux, \*BSD, OS X: ``/tmp/glances.log``
|
||||
:Windows: ``%APPDATA%\Local\temp\glances.log``
|
||||
|
||||
If glances.log is not writable, a new file will be created and returned to the user console.
|
||||
If ``glances.log`` is not writable, a new file will be created and
|
||||
returned to the user console.
|
||||
|
||||
Anatomy Of The Application
|
||||
==========================
|
||||
@ -398,7 +410,8 @@ Disconnected:
|
||||
QuickLook
|
||||
---------
|
||||
|
||||
The quicklook plugin is only display on wide screen and propose a bar view for CPU and memory (virtual and swap).
|
||||
The ``quicklook`` plugin is only displayed on wide screen and propose a
|
||||
bar view for CPU and memory (virtual and swap).
|
||||
|
||||
.. image:: images/quicklook.png
|
||||
|
||||
@ -528,7 +541,9 @@ If a RAID controller is detected on you system, its status will be displayed:
|
||||
|
||||
.. image:: images/raid.png
|
||||
|
||||
By default, the plugin only display physical devices only (hard disks, USB keys) and ignore all others. To allow others FS type, you had to use the following section in the configuration file:
|
||||
By default, the plugin only displays physical devices (hard disks, USB
|
||||
keys) and ignore all others. To allow others FS type, you have to use the
|
||||
following section in the configuration file:
|
||||
|
||||
::
|
||||
|
||||
@ -550,8 +565,8 @@ temperature only.
|
||||
|
||||
There is no alert on this information.
|
||||
|
||||
*Note*: limit values and sensors alias names can be defined in the configuration
|
||||
file under the ``[sensors]`` section.
|
||||
*Note*: limit values and sensors alias names can be defined in the
|
||||
configuration file under the ``[sensors]`` section.
|
||||
|
||||
Processes List
|
||||
--------------
|
||||
@ -628,7 +643,8 @@ Process status legend:
|
||||
``Z``
|
||||
Zombie
|
||||
|
||||
In standalone mode, additionals informations are provided for the top process:
|
||||
In standalone mode, additional informations are provided for the top
|
||||
process:
|
||||
|
||||
.. image:: images/processlist-top.png
|
||||
|
||||
@ -637,7 +653,8 @@ In standalone mode, additionals informations are provided for the top process:
|
||||
* Open threads, files and network sessions (TCP and UDP)
|
||||
* IO nice level
|
||||
|
||||
The extended stats feature could be enabled using the --enable-process-extended option (command line) or the ``e`` key (curses interface).
|
||||
The extended stats feature could be enabled using the ``--enable-process-extended``
|
||||
option (command line) or the ``e`` key (curses interface).
|
||||
|
||||
*Note*: limit values can be overwritten in the configuration file under
|
||||
the ``[process]`` section.
|
||||
@ -725,16 +742,19 @@ Each alert message displays the following information:
|
||||
Docker
|
||||
------
|
||||
|
||||
If you use Docker, Glances can help you to monitor your container. Glances uses the Docker API through the Docker-Py library.
|
||||
If you use ``Docker``, Glances can help you to monitor your container.
|
||||
Glances uses the Docker API through the ``docker-py`` library.
|
||||
|
||||
.. image:: images/docker.png
|
||||
|
||||
Actions
|
||||
-------
|
||||
|
||||
Glances can trigger actions on events.
|
||||
Glances can trigger actions on events.
|
||||
|
||||
By action, we mean all shell command line. For example, if you want to execute the foo.py script if the last 5 minutes load are critical then add the action line to the Glances configuration file:
|
||||
By ``action``, we mean all shell command line. For example, if you want
|
||||
to execute the ``foo.py`` script if the last 5 minutes load are critical
|
||||
then add the action line to the Glances configuration file:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@ -742,7 +762,9 @@ By action, we mean all shell command line. For example, if you want to execute t
|
||||
critical=5.0
|
||||
critical_action=python /path/to/foo.py
|
||||
|
||||
All the stats are available in the command line through the use of the {{mustache}} syntax. Another example to create a log file containing used vs total disk space if a space trigger warning is reached:
|
||||
All the stats are available in the command line through the use of the
|
||||
``{{mustache}}`` syntax. Another example would be to create a log file
|
||||
containing used vs total disk space if a space trigger warning is reached:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@ -750,13 +772,15 @@ All the stats are available in the command line through the use of the {{mustach
|
||||
warning=70
|
||||
warning_action=echo {{mnt_point}} {{used}}/{{size}} > /tmp/fs.alert
|
||||
|
||||
*Note*: You can use all the stats for the current plugin (see https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to for the stats list)
|
||||
|
||||
*Note*: you can use all the stats for the current plugin (see
|
||||
https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to for
|
||||
the stats list)
|
||||
|
||||
Gateway to others services
|
||||
==========================
|
||||
|
||||
*CSV*
|
||||
CSV
|
||||
---
|
||||
|
||||
It is possible to export statistics to CSV file.
|
||||
|
||||
@ -768,9 +792,12 @@ CSV file description:
|
||||
- Stats description (first line)
|
||||
- Stats (others lines)
|
||||
|
||||
*InfluxDB*
|
||||
InfluxDB
|
||||
--------
|
||||
|
||||
You can export statistics to an InfluxDB server (time series server). The connection should be defined in the Glances configuration file as following:
|
||||
You can export statistics to an ``InfluxDB`` server (time series server).
|
||||
The connection should be defined in the Glances configuration file as
|
||||
following:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@ -787,13 +814,17 @@ and run Glances with:
|
||||
|
||||
$ glances --export-influxdb
|
||||
|
||||
For Grafana users', Glances provides a dedicated `dashboard`_. Just import the file in your Grafana Web interface.
|
||||
For Grafana users, Glances provides a dedicated `dashboard`_. Just import
|
||||
the file in your ``Grafana`` web interface.
|
||||
|
||||
.. image:: images/grafana.png
|
||||
|
||||
*Statsd*
|
||||
Statsd
|
||||
------
|
||||
|
||||
You can export statistics to a Statsd server (welcome to Graphite !). The connection should be defined in the Glances configuration file as following:
|
||||
You can export statistics to a ``Statsd`` server (welcome to Graphite!).
|
||||
The connection should be defined in the Glances configuration file as
|
||||
following:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@ -802,7 +833,7 @@ You can export statistics to a Statsd server (welcome to Graphite !). The connec
|
||||
port=8125
|
||||
prefix=glances
|
||||
|
||||
Note: the prefix option is optionnal ('glances by default')
|
||||
*Note*: the prefix option is optional ('glances by default')
|
||||
|
||||
and run Glances with:
|
||||
|
||||
@ -820,9 +851,12 @@ Glances will generate stats as:
|
||||
'glances.load.min1': 0.19,
|
||||
...
|
||||
|
||||
*RabbitMQ*
|
||||
RabbitMQ
|
||||
--------
|
||||
|
||||
You can export statistics to an RabbitMQ server (AMQP Broker). The connection should be defined in the Glances configuration file as following:
|
||||
You can export statistics to an ``RabbitMQ`` server (AMQP Broker).
|
||||
The connection should be defined in the Glances configuration file as
|
||||
following:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@ -839,13 +873,13 @@ and run Glances with:
|
||||
|
||||
$ glances --export-rabbitmq
|
||||
|
||||
APIs documentation
|
||||
==================
|
||||
|
||||
APIs Documentations
|
||||
===================
|
||||
Glances includes a `XML-RPC server`_ and a `RESTFUL-JSON`_ API which can
|
||||
be used by another client software.
|
||||
|
||||
Glances includes a `XML-RPC server`_ and a `RESTFUL-JSON`_ API which and can be used by another client software.
|
||||
|
||||
APIs documentations are available at:
|
||||
APIs documentation is available at:
|
||||
|
||||
- XML-RPC: https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to
|
||||
- RESTFUL-JSON: https://github.com/nicolargo/glances/wiki/The-Glances-RESTFULL-JSON-API
|
||||
@ -853,7 +887,8 @@ APIs documentations are available at:
|
||||
Support
|
||||
=======
|
||||
|
||||
To post a question about Glances use case, please post it to the offical Q&A `forum`_.
|
||||
To post a question about Glances use cases, please post it to the
|
||||
official Q&A `forum`_.
|
||||
|
||||
To report a bug or a feature request use the bug tracking system at
|
||||
https://github.com/nicolargo/glances/issues.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user