summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/aoa/docker.rst7
-rw-r--r--docs/aoa/fs.rst4
-rw-r--r--docs/aoa/ps.rst3
-rw-r--r--docs/aoa/sensors.rst3
-rw-r--r--docs/cmds.rst2
-rw-r--r--docs/conf.py5
-rw-r--r--docs/config.rst8
-rw-r--r--docs/docker.rst1
-rw-r--r--docs/gw/influxdb.rst50
-rw-r--r--docs/gw/json.rst2
-rw-r--r--docs/gw/rabbitmq.rst1
-rw-r--r--docs/man/glances.115
12 files changed, 86 insertions, 15 deletions
diff --git a/docs/aoa/docker.rst b/docs/aoa/docker.rst
index 484dcd14..c21dc850 100644
--- a/docs/aoa/docker.rst
+++ b/docs/aoa/docker.rst
@@ -20,6 +20,13 @@ under the ``[docker]`` section:
.. code-block:: ini
[docker]
+ disable=False
+ # Only show specific containers (comma separeted list of container name or regular expression)
+ show=thiscontainer,andthisone,andthoseones.*
+ # Hide some containers (comma separeted list of container name or regular expression)
+ hide=donotshowthisone,andthose.*
+ # Define the maximum docker size name (default is 20 chars)
+ max_name_size=20
# Global containers' thresholds for CPU and MEM (in %)
cpu_careful=50
cpu_warning=70
diff --git a/docs/aoa/fs.rst b/docs/aoa/fs.rst
index 37dae695..23d4eecd 100644
--- a/docs/aoa/fs.rst
+++ b/docs/aoa/fs.rst
@@ -27,13 +27,13 @@ User disk space usage Status
By default, the plugin only displays physical devices (hard disks, USB
keys). To allow other file system types, you have to enable them in the
-configuration file. For example, if you want to allow the ``zfs`` file
+configuration file. For example, if you want to allow the ``shm`` file
system:
.. code-block:: ini
[fs]
- allow=zfs
+ allow=shm
Also, you can hide mount points as well (in the following ``/boot``):
diff --git a/docs/aoa/ps.rst b/docs/aoa/ps.rst
index 14906147..c9daacb2 100644
--- a/docs/aoa/ps.rst
+++ b/docs/aoa/ps.rst
@@ -128,6 +128,9 @@ The extended stats feature can be enabled using the
``--enable-process-extended`` option (command line) or the ``e`` key
(curses interface).
+In curses/standalone mode, you can select a process using ``UP`` and ``DOWN`` and press:
+- ``k`` to kill the selected process
+
.. note::
Limit for CPU and MEM percent values can be overwritten in the
configuration file under the ``[processlist]`` section. It is also
diff --git a/docs/aoa/sensors.rst b/docs/aoa/sensors.rst
index a5aa4965..b5efc65f 100644
--- a/docs/aoa/sensors.rst
+++ b/docs/aoa/sensors.rst
@@ -18,3 +18,6 @@ There is no alert on this information.
.. note::
This plugin is disabled by default in the configuration file.
+ To enable it just use the following option:
+
+ # glances --enable-plugin sensors
diff --git a/docs/cmds.rst b/docs/cmds.rst
index a4c88179..b97734ce 100644
--- a/docs/cmds.rst
+++ b/docs/cmds.rst
@@ -375,6 +375,8 @@ The following commands (key pressed) are supported while in Glances:
Enable/disable mean GPU mode
``/``
Switch between process command line or command name
+``F5``
+ Refresh stats in curses user interface
In the Glances client browser (accessible through the ``--browser``
command line argument):
diff --git a/docs/conf.py b/docs/conf.py
index 54b5bc00..ade53f17 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -54,7 +54,10 @@ master_doc = 'index'
# General information about the project.
project = 'Glances'
author = 'Nicolas Hennion'
-year = datetime.now().year
+try:
+ year = datetime.utcfromtimestamp(int(os.environ['SOURCE_DATE_EPOCH'])).year
+except (KeyError, ValueError):
+ year = datetime.now().year
copyright = '%d, %s' % (year, author)
# The version info for the project you're documenting, acts as replacement for
diff --git a/docs/config.rst b/docs/config.rst
index 00c54851..07f0efd5 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -17,10 +17,10 @@ Location
You can put your own ``glances.conf`` file in the following locations:
==================== =============================================================
-``Linux``, ``SunOS`` ~/.config/glances, /etc/glances
-``*BSD`` ~/.config/glances, /usr/local/etc/glances
-``macOS`` ~/Library/Application Support/glances, /usr/local/etc/glances
-``Windows`` %APPDATA%\\glances
+``Linux``, ``SunOS`` ~/.config/glances/glances.conf, /etc/glances/glances.conf
+``*BSD`` ~/.config/glances/glances.conf, /usr/local/etc/glances/glances.conf
+``macOS`` ~/Library/Application Support/glances/glances.conf, /usr/local/etc/glances/glances.conf
+``Windows`` %APPDATA%\\glances\glances.conf
==================== =============================================================
- On Windows XP, ``%APPDATA%`` is: ``C:\Documents and Settings\<USERNAME>\Application Data``.
diff --git a/docs/docker.rst b/docs/docker.rst
index c91cbf28..cfa25834 100644
--- a/docs/docker.rst
+++ b/docs/docker.rst
@@ -104,7 +104,6 @@ which will prompt you to answer the following questions:
after which you will need to kill the process by entering ``CTRL+C`` (potentially twice), before leaving the container:
.. code-block:: console
- ^C^C
exit
You will then need to copy the password file to your host machine:
diff --git a/docs/gw/influxdb.rst b/docs/gw/influxdb.rst
index 43db9df9..b8717c48 100644
--- a/docs/gw/influxdb.rst
+++ b/docs/gw/influxdb.rst
@@ -4,6 +4,10 @@ InfluxDB
========
You can export statistics to an ``InfluxDB`` server (time series server).
+
+InfluxDB (up to version 1.7.x)
+------------------------------
+
The connection should be defined in the Glances configuration file as
following:
@@ -16,6 +20,13 @@ following:
user=root
password=root
db=glances
+ # Prefix will be added for all measurement name
+ # Ex: prefix=foo
+ # => foo.cpu
+ # => foo.mem
+ # You can also use dynamic values
+ #prefix=`hostname`
+ prefix=localhost
# Tags will be added for all measurements
#tags=foo:bar,spam:eggs
# You can also use dynamic values
@@ -33,6 +44,45 @@ configuration file (no limit on columns number).
Note: if you want to use SSL, please set 'protocol=https'.
+
+InfluxDB v2 (from InfluxDB v1.8.x/Flux and InfluxDB v2.x)
+---------------------------------------------------------
+
+Note: The InfluxDB v2 client (https://pypi.org/project/influxdb-client/)
+is only available for Python 3.6 or higher.
+
+The connection should be defined in the Glances configuration file as
+following:
+
+.. code-block:: ini
+
+ [influxdb]
+ host=localhost
+ port=8086
+ protocol=http
+ org=nicolargo
+ bucket=glances
+ token=EjFUTWe8U-MIseEAkaVIgVnej_TrnbdvEcRkaB1imstW7gapSqy6_6-8XD-yd51V0zUUpDy-kAdVD1purDLuxA==
+ # Prefix will be added for all measurement name
+ # Ex: prefix=foo
+ # => foo.cpu
+ # => foo.mem
+ # You can also use dynamic values
+ #prefix=`hostname`
+ prefix=localhost
+ # Tags will be added for all measurements
+ #tags=foo:bar,spam:eggs
+ # You can also use dynamic values
+ #tags=system:`uname -s`
+
+and run Glances with:
+
+.. code-block:: console
+
+ $ glances --export influxdb2
+
+Note: if you want to use SSL, please set 'protocol=https'.
+
Grafana
-------
diff --git a/docs/gw/json.rst b/docs/gw/json.rst
index 0b086c7d..e85a4832 100644
--- a/docs/gw/json.rst
+++ b/docs/gw/json.rst
@@ -6,5 +6,5 @@ JSON
It's possible to export stats to a JSON file.
.. code-block:: console
+ $ glances --export json --export-json-file /tmp/glances.json
- $ glances --export json --export-json-file json /tmp/glances.json
diff --git a/docs/gw/rabbitmq.rst b/docs/gw/rabbitmq.rst
index 173b9b3c..30ff7911 100644
--- a/docs/gw/rabbitmq.rst
+++ b/docs/gw/rabbitmq.rst
@@ -15,6 +15,7 @@ following:
user=glances
password=glances
queue=glances_queue
+ #protocol=amqps
and run Glances with:
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index 54bd3bbf..b8ccf045 100644
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "GLANCES" "1" "Aug 19, 2020" "3.1.5" "Glances"
+.TH "GLANCES" "1" "Jan 23, 2021" "3.1.6" "Glances"
.SH NAME
glances \- An eye on your system
.
@@ -479,6 +479,9 @@ Enable/disable mean GPU mode
.TP
.B \fB/\fP
Switch between process command line or command name
+.TP
+.B \fBF5\fP
+Refresh stats in curses user interface
.UNINDENT
.sp
In the Glances client browser (accessible through the \fB\-\-browser\fP
@@ -520,25 +523,25 @@ _
T{
\fBLinux\fP, \fBSunOS\fP
T} T{
-~/.config/glances, /etc/glances
+~/.config/glances/glances.conf, /etc/glances/glances.conf
T}
_
T{
\fB*BSD\fP
T} T{
-~/.config/glances, /usr/local/etc/glances
+~/.config/glances/glances.conf, /usr/local/etc/glances/glances.conf
T}
_
T{
\fBmacOS\fP
T} T{
-~/Library/Application Support/glances, /usr/local/etc/glances
+~/Library/Application Support/glances/glances.conf, /usr/local/etc/glances/glances.conf
T}
_
T{
\fBWindows\fP
T} T{
-%APPDATA%\eglances
+%APPDATA%\eglancesglances.conf
T}
_
.TE
@@ -838,6 +841,6 @@ $ glances –browser
.sp
Nicolas Hennion aka Nicolargo <\fI\%contact@nicolargo.com\fP>
.SH COPYRIGHT
-2020, Nicolas Hennion
+2021, Nicolas Hennion
.\" Generated by docutils manpage writer.
.