diff options
Diffstat (limited to 'docs/config.rst')
| -rw-r--r-- | docs/config.rst | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/config.rst b/docs/config.rst index 8aa3250e..4bc30ac2 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -5,7 +5,7 @@ Configuration No configuration file is mandatory to use Glances. -Furthermore a configuration file is needed to access more settings. +Furthermore, a configuration file is needed to access more settings. Location -------- @@ -14,7 +14,7 @@ Location A template is available in the ``/usr{,/local}/share/doc/glances`` (Unix-like) directory or directly on `GitHub`_. -You can put your own ``glances.conf`` file in the following locations: +You can place your ``glances.conf`` file in the following locations: ==================== ============================================================= ``Linux``, ``SunOS`` ~/.config/glances/, /etc/glances/, /usr/share/docs/glances/ @@ -26,13 +26,13 @@ You can put your own ``glances.conf`` file in the following locations: - On Windows XP, ``%APPDATA%`` is: ``C:\Documents and Settings\<USERNAME>\Application Data``. - On Windows Vista and later: ``C:\Users\<USERNAME>\AppData\Roaming``. -User-specific options override system-wide options and options given on -the command line override either. +User-specific options override system-wide options, and options given on +the command line overrides both. Syntax ------ -Glances reads configuration files in the *ini* syntax. +Glances read configuration files in the *ini* syntax. A first section (called global) is available: @@ -41,7 +41,7 @@ A first section (called global) is available: [global] # Refresh rate (default is a minimum of 2 seconds) # Can be overwritten by the -t <sec> option - # It is also possible to overwrite it in each plugin sections + # It is also possible to overwrite it in each plugin section refresh=2 # Should Glances check if a newer version is available on PyPI ? check_update=false @@ -53,8 +53,8 @@ A first section (called global) is available: # (see <install-dir>glances/plugins for details) # plugin_dir=/home/user/dev/plugins -Each plugin, export module and application monitoring process (AMP) can -have a section. Below an example for the CPU plugin: +Each plugin, export module, and application monitoring process (AMP) can +have a section. Below is an example for the CPU plugin: .. code-block:: ini @@ -94,16 +94,16 @@ or a Nginx AMP: .. code-block:: ini [amp_nginx] - # Nginx status page should be enable (https://easyengine.io/tutorials/nginx/status-page/) + # Nginx status page should be enabled (https://easyengine.io/tutorials/nginx/status-page/) enable=true regex=\/usr\/sbin\/nginx refresh=60 one_line=false status_url=http://localhost/nginx_status -With Glances 3.0 or higher it is also possible to use dynamic configuration -value using system command. For example, if you to set the prefix of an -InfluxDB export to the current hostname, use: +With Glances 3.0 or higher, you can use dynamic configuration values +by utilizing system commands. For example, if you want to set the prefix +of an InfluxDB export to the current hostname, use: .. code-block:: ini @@ -127,14 +127,14 @@ Glances logs all of its internal messages to a log file. ``DEBUG`` messages can be logged using the ``-d`` option on the command line. -The location of the Glances log file depends of your operating system. You can -display the full path of the Glances log file full path using the``glances -V`` +The location of the Glances log file depends on your operating system. You can +display the full path of the Glances log file using the ``glances -V`` command line. The file is automatically rotated when its size exceeds 1 MB. If you want to use another system path or change the log message, you -can use your own logger configuration. First of all, you have to create +can use your logger configuration. First of all, you have to create a ``glances.json`` file with, for example, the following content (JSON format): @@ -206,7 +206,7 @@ and start Glances using the following command line: LOG_CFG=<path>/glances.json glances .. note:: - Replace ``<path>`` by the folder where your ``glances.json`` file + Replace ``<path>`` with the directory where your ``glances.json`` file is hosted. .. _GitHub: https://raw.githubusercontent.com/nicolargo/glances/master/conf/glances.conf |