diff options
author | Alessio Sergi <al3hex@gmail.com> | 2017-03-12 18:52:17 +0100 |
---|---|---|
committer | Alessio Sergi <al3hex@gmail.com> | 2017-03-12 18:52:17 +0100 |
commit | 937f2faf9aa0e3b362fac62dbb4dac7fb06c21fb (patch) | |
tree | be068e73be2e2fe184fa44efc5375087025a0714 /docs/aoa | |
parent | 23a65b56f2eac3a02074fd3f454f3a3bcf7ea64e (diff) |
Update doc
Diffstat (limited to 'docs/aoa')
-rw-r--r-- | docs/aoa/amps.rst | 75 | ||||
-rw-r--r-- | docs/aoa/gpu.rst | 35 | ||||
-rw-r--r-- | docs/aoa/header.rst | 4 | ||||
-rw-r--r-- | docs/aoa/irq.rst | 18 | ||||
-rw-r--r-- | docs/aoa/monitor.rst | 6 | ||||
-rw-r--r-- | docs/aoa/ports.rst | 5 | ||||
-rw-r--r-- | docs/aoa/ps.rst | 19 | ||||
-rw-r--r-- | docs/aoa/sensors.rst | 6 | ||||
-rw-r--r-- | docs/aoa/wifi.rst | 21 |
9 files changed, 107 insertions, 82 deletions
diff --git a/docs/aoa/amps.rst b/docs/aoa/amps.rst index 21c6ac65..6ea11083 100644 --- a/docs/aoa/amps.rst +++ b/docs/aoa/amps.rst @@ -3,16 +3,17 @@ Applications Monitoring Process =============================== -Thanks to Glances and it AMP module, you can add specific monitoring -to running process. AMP are defined in the Glances configuration file. +Thanks to Glances and its AMP module, you can add specific monitoring to +running processes. AMPs are defined in the Glances configuration file. -You can disable AMP using the --disable-amps option or pressing the `A` shortkey. +You can disable AMP using the ``--disable-amps`` option or pressing the +``A`` key. Simple AMP ---------- -For example, a simple AMP which monitor the CPU/MEM of all Python processes -can be define using: +For example, a simple AMP that monitor the CPU/MEM of all Python +processes can be defined as follows: .. code-block:: ini @@ -21,15 +22,17 @@ can be define using: regex=.*python.* refresh=3 -Every 3 seconds (*refresh*) and if the *enable* key is true, Glances will -filter the running processes list thanks to the .*python.* regular -expression (*regex*). The default behavor for an AMP is to display: -the number of matching processes, the CPU and MEM: +Every 3 seconds (``refresh``) and if the ``enable`` key is true, Glances +will filter the running processes list thanks to the ``.*python.*`` +regular expression (``regex``). + +The default behavior for an AMP is to display the number of matching +processes, CPU and MEM: .. image:: ../_static/amp-python.png -You can also define the minimum (*countmin*) and/or maximum (*countmax*) process -number. For example: +You can also define the minimum (``countmin``) and/or maximum +(``countmax``) process number. For example: .. code-block:: ini @@ -40,17 +43,19 @@ number. For example: countmin=1 countmax=2 -With this configuration, if the number of running Python script is higher than 2 -then the AMP is display with a purple color (red if < countmin): +With this configuration, if the number of running Python scripts is +higher than 2, then the AMP is displayed with a purple color (red if +less than countmin): .. image:: ../_static/amp-python-warning.png -User define AMP ---------------- +User defined AMP +---------------- -If you need to execute a specific command line, you can use the *command* option. -For example, if you want to display the Dropbox process status, you can define the -following section in the Glances configuration file: +If you need to execute a specific command line, you can use the +``command`` option. For example, if you want to display the Dropbox +process status, you can define the following section in the Glances +configuration file: .. code-block:: ini @@ -63,27 +68,29 @@ following section in the Glances configuration file: command=dropbox status countmin=1 -The *dropbox status* command line will be executed and displayed in the Glances UI: +The ``dropbox status`` command line will be executed and displayed in +the Glances UI: .. image:: ../_static/amp-dropbox.png -You can force Glances to display the result in one line setting the *one_line* to true. - -Embeded AMP ------------ +You can force Glances to display the result in one line setting +``one_line`` to true. -Glances provides some specifics AMP scripts (replacing the *command* line) hosted -in the glances/amps folder. You can write your own AMP script to fill yours needs. -AMP scripts are located in the glances/amps folder and should be names glances_*.py. -An AMP script define an Amp class (GlancesAmp) with a mandatory update method. -The update method call the set_result method to set the AMP return string. -The return string is a string with one or more line (\n between lines). +Embedded AMP +------------ -You can write your owns AMP and enable its from the configuration file. -The configuration file section should be named [amp_*]. +Glances provides some specific AMP scripts (replacing the ``command`` +line). You can write your own AMP script to fill your needs. AMP scripts +are located in the ``amps`` folder and should be named ``glances_*.py``. +An AMP script define an Amp class (``GlancesAmp``) with a mandatory +update method. The update method call the ``set_result`` method to set +the AMP return string. The return string is a string with one or more +line (\n between lines). To enable it, the configuration file section +should be named ``[amp_*]``. -For example, if you want to enable the Nginx AMP, the following definition -should do the job (NGinx AMP is provided by the Glances team as an example): +For example, if you want to enable the Nginx AMP, the following +definition should do the job (Nginx AMP is provided by the Glances team +as an example): .. code-block:: ini @@ -94,7 +101,7 @@ should do the job (NGinx AMP is provided by the Glances team as an example): one_line=false status_url=http://localhost/nginx_status -Here is the result: +Here's the result: .. image:: ../_static/amps.png diff --git a/docs/aoa/gpu.rst b/docs/aoa/gpu.rst index 738a7e3f..def9646e 100644 --- a/docs/aoa/gpu.rst +++ b/docs/aoa/gpu.rst @@ -3,23 +3,26 @@ GPU === -The GPU plugin is **only** compatible with NVIDIA GPU. You also need to -install the Python `pynvml`_ library on our system. +The GPU plugin is **only** compatible with ``NVIDIA`` GPUs. -The GPU stats are shown as a percentage or value and for the configured +.. note:: + You need to install the `nvidia-ml-py`_ library on your system. + +The GPU stats are shown as a percentage of value and for the configured refresh time. The total GPU usage is displayed on the first line, the memory consumption on the second one. .. image:: ../_static/gpu.png -If you click on the ``6`` short key, the per GPU view is displayed: +If you click on the ``6`` short key, the per-GPU view is displayed: .. image:: ../_static/pergpu.png -Note: you can also start Glances with the --meangpu option to display the -first view by default. +.. note:: + You can also start Glances with the ``--meangpu`` option to display + the first view by default. -You can change the thresolds limits in the configuration file: +You can change the threshold limits in the configuration file: .. code-block:: ini @@ -35,13 +38,13 @@ You can change the thresolds limits in the configuration file: Legend: -================= ============ -GPU (PROC/MEM) Status -================= ============ -``<50%`` ``OK`` -``>50%`` ``CAREFUL`` -``>70%`` ``WARNING`` -``>90%`` ``CRITICAL`` -================= ============ +============== ============ +GPU (PROC/MEM) Status +============== ============ +``<50%`` ``OK`` +``>50%`` ``CAREFUL`` +``>70%`` ``WARNING`` +``>90%`` ``CRITICAL`` +============== ============ -.. _pynvml: https://pypi.python.org/pypi/nvidia-ml-py +.. _nvidia-ml-py: https://pypi.python.org/pypi/nvidia-ml-py diff --git a/docs/aoa/header.rst b/docs/aoa/header.rst index 46a21b5f..c7313e41 100644 --- a/docs/aoa/header.rst +++ b/docs/aoa/header.rst @@ -11,8 +11,8 @@ Additionally, on GNU/Linux, it also shows the kernel version. In client mode, the server connection status is also displayed. -If you are hosted on an AWS EC2 instance, some additional information -can be displayed (AMI-ID, region). +If you are hosted on an ``AWS EC2`` instance, some additional +information can be displayed (AMI-ID, region). **Connected**: diff --git a/docs/aoa/irq.rst b/docs/aoa/irq.rst index 6969bdc6..07d86283 100644 --- a/docs/aoa/irq.rst +++ b/docs/aoa/irq.rst @@ -3,14 +3,20 @@ IRQ === +*Availability: Linux* + .. image:: ../_static/irq.png -Glances displays the top 5 interrupts rate. This plugin is only available on -GNU/Linux machine (stats are grabbed from the /proc/interrupts file). +Glances displays the top ``5`` interrupts rate. + +This plugin is only available on GNU/Linux (stats are grabbed from the +``/proc/interrupts`` file). -Note: /proc/interrupts file did not exist inside OpenVZ containers. +.. note:: + ``/proc/interrupts`` file doesn't exist inside OpenVZ containers. -How to read the informations: +How to read the information: -* The first Column is the IRQ number / name -* The Second column says how many times the CPU core has been interrupted during the last second +- The first column is the IRQ number / name +- The second column says how many times the CPU has been interrupted + during the last second diff --git a/docs/aoa/monitor.rst b/docs/aoa/monitor.rst index 16d81d4d..97b0a6dd 100644 --- a/docs/aoa/monitor.rst +++ b/docs/aoa/monitor.rst @@ -3,6 +3,6 @@ Monitored Processes List ======================== -The monitored processes list is deprecated. - -Please use the Application Monitoring Process (AMP). +.. warning:: + The monitored processes list feature has been removed. Use the new + Application Monitoring Process (AMP) instead. diff --git a/docs/aoa/ports.rst b/docs/aoa/ports.rst index 7e25a38b..4534dfa9 100644 --- a/docs/aoa/ports.rst +++ b/docs/aoa/ports.rst @@ -9,9 +9,10 @@ Ports This plugin aims at providing a list of hosts/port to scan. -You can define ICMP or TCP ports scan. +You can define ``ICMP`` or ``TCP`` ports scan. -The list should be define in the ``[ports]`` section of the Glances configuration file. +The list should be defined in the ``[ports]`` section of the Glances +configuration file. .. code-block:: ini diff --git a/docs/aoa/ps.rst b/docs/aoa/ps.rst index a1da1575..bf4c1945 100644 --- a/docs/aoa/ps.rst +++ b/docs/aoa/ps.rst @@ -52,22 +52,25 @@ Columns display ``VIRT`` Virtual Memory Size The total amount of virtual memory used by the - process. It includes all code, data and shared + process. + + It includes all code, data and shared libraries plus pages that have been swapped out and pages that have been mapped but not used. ``RES`` Resident Memory Size The non-swapped physical memory a process is - using (what's currently in the physical memory). + using (what's currently in the physical memory). ``PID`` Process ID ``USER`` User ID ``NI`` Nice level of the process ``S`` Process status The status of the process: + - ``R``: running or runnable (on run queue) - ``S``: interruptible sleep (waiting for an event) - - ``D``: uninterruptible sleep (usually IO) + - ``D``: uninterruptible sleep (usually I/O) - ``Z``: defunct ("zombie") process - ``T``: traced/stopped by job control signal - ``X``: dead (should never be seen) @@ -88,10 +91,12 @@ It's possible to filter the processes list using the ``ENTER`` key. Filter syntax is the following (examples): -- python > Filter processes name or command line starting with *python* (regexp) -- .*python.* > Filter processes name or command line containing *python* (regexp) -- username:nicolargo > Processes of nicolargo user (key:regexp) -- cmdline:\/usr\/bin.* > Processes starting by */usr/bin* +- ``python``: Filter processes name or command line starting with + *python* (regexp) +- ``.*python.*``: Filter processes name or command line containing + *python* (regexp) +- ``username:nicolargo``: Processes of nicolargo user (key:regexp) +- ``cmdline:\/usr\/bin.*``: Processes starting by */usr/bin* Extended info ------------- diff --git a/docs/aoa/sensors.rst b/docs/aoa/sensors.rst index 4b2aaaef..6f697dc4 100644 --- a/docs/aoa/sensors.rst +++ b/docs/aoa/sensors.rst @@ -7,10 +7,8 @@ Sensors .. image:: ../_static/sensors.png -Glances can displays the sensors information using ``PsUtil`` and ``hddtemp``. - -As of ``lm-sensors``, a filter is being applied in order to display -temperature and fan speed only. +Glances can displays the sensors information using ``psutil`` and/or +``hddtemp``. There is no alert on this information. diff --git a/docs/aoa/wifi.rst b/docs/aoa/wifi.rst index 69012735..9e44d062 100644 --- a/docs/aoa/wifi.rst +++ b/docs/aoa/wifi.rst @@ -1,18 +1,23 @@ .. _wifi: -Wifi +Wi-Fi ===== *Availability: Linux* .. image:: ../_static/wifi.png -Glances displays the Wifi hotspots' name and signal quality. -If Glances is ran as root, then all the available hotspots are displayed. +Glances displays the Wi-Fi hotspot names and signal quality. If Glances +is ran as root, then all the available hotspots are displayed. -In the configuration file, you can define signal quality thresholds. -"Poor" quality is between -100 and -85dBm, "Good" quality between -85 -and -60dBm, and "Excellent" between -60 and -40dBm. +.. note:: + You need to install the ``wireless-tools`` package on your system. + +In the configuration file, you can define signal quality thresholds: + +- ``"Poor"`` quality is between -100 and -85dBm +- ``"Good"`` quality between -85 and -60dBm +- ``"Excellent"`` between -60 and -40dBm It's also possible to disable the scan on a specific interface from the configuration file (``[wifi]`` section). For example, if you want to @@ -27,5 +32,5 @@ hide the loopback interface (lo) and all the virtual docker interfaces: warning=-75 critical=-85 -You can disable this plugin using the --disable-wifi option or by heating -the 'W' from the user interface. +You can disable this plugin using the ``--disable-wifi`` option or by +hitting the ``W`` key from the user interface. |