2016-03-02 15:29:19 +03:00
|
|
|
.. _config:
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
=============
|
|
|
|
|
|
|
|
No configuration file is mandatory to use Glances.
|
|
|
|
|
|
|
|
Furthermore a configuration file is needed to access more settings.
|
|
|
|
|
|
|
|
Location
|
|
|
|
--------
|
|
|
|
|
2016-12-30 12:10:48 +03:00
|
|
|
A template is available in the /usr/local/share/doc/glances folder
|
|
|
|
(on GNU/Linux OS) or directly in the Github:
|
|
|
|
|
|
|
|
https://raw.githubusercontent.com/nicolargo/glances/master/conf/glances.conf
|
|
|
|
|
2017-01-08 13:08:58 +03:00
|
|
|
You can put your own ``glances.conf`` file in the following locations:
|
2016-03-02 15:29:19 +03:00
|
|
|
|
|
|
|
=========== ============================================================
|
2017-01-08 13:08:58 +03:00
|
|
|
``Linux`` ~/.config/glances ($XDG_CONFIG_HOME environment variable) or /etc/glances
|
|
|
|
``*BSD`` ~/.config/glances or /usr/local/etc/glances
|
2017-01-18 22:00:21 +03:00
|
|
|
``macOS`` ~/Library/Application Support/glances or /usr/local/etc/glances
|
2017-01-08 13:08:58 +03:00
|
|
|
``Windows`` %APPDATA%\\glances
|
2016-03-02 15:29:19 +03:00
|
|
|
=========== ============================================================
|
|
|
|
|
|
|
|
On Windows XP, the ``%APPDATA%`` path is:
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
C:\Documents and Settings\<User>\Application Data
|
|
|
|
|
|
|
|
Since Windows Vista and newer versions:
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
C:\Users\<User>\AppData\Roaming
|
|
|
|
|
|
|
|
User-specific options override system-wide options and options given on
|
|
|
|
the command line override either.
|
|
|
|
|
|
|
|
Syntax
|
|
|
|
------
|
|
|
|
|
|
|
|
Glances reads configuration files in the *ini* syntax.
|
|
|
|
|
2016-05-14 00:17:25 +03:00
|
|
|
A first section (called global) is available:
|
|
|
|
|
|
|
|
.. code-block:: ini
|
|
|
|
|
|
|
|
[global]
|
|
|
|
# Does Glances should check if a newer version is available on Pypi ?
|
|
|
|
check_update=true
|
|
|
|
|
|
|
|
Each plugin, export module and application monitoring process (AMP) can have a
|
|
|
|
section. Below an example for the CPU plugin:
|
2016-03-02 15:29:19 +03:00
|
|
|
|
|
|
|
.. code-block:: ini
|
|
|
|
|
|
|
|
[cpu]
|
|
|
|
user_careful=50
|
|
|
|
user_warning=70
|
|
|
|
user_critical=90
|
|
|
|
iowait_careful=50
|
|
|
|
iowait_warning=70
|
|
|
|
iowait_critical=90
|
|
|
|
system_careful=50
|
|
|
|
system_warning=70
|
|
|
|
system_critical=90
|
|
|
|
steal_careful=50
|
|
|
|
steal_warning=70
|
|
|
|
steal_critical=90
|
|
|
|
|
2016-05-14 00:17:25 +03:00
|
|
|
an InfluxDB export module:
|
|
|
|
|
|
|
|
.. code-block:: ini
|
|
|
|
|
|
|
|
[influxdb]
|
|
|
|
# Configuration for the --export-influxdb option
|
|
|
|
# https://influxdb.com/
|
|
|
|
host=localhost
|
|
|
|
port=8086
|
|
|
|
user=root
|
|
|
|
password=root
|
|
|
|
db=glances
|
|
|
|
prefix=localhost
|
|
|
|
#tags=foo:bar,spam:eggs
|
|
|
|
|
|
|
|
or a NGinx AMP:
|
|
|
|
|
|
|
|
.. code-block:: ini
|
|
|
|
|
|
|
|
[amp_nginx]
|
|
|
|
# Nginx status page should be enable (https://easyengine.io/tutorials/nginx/status-page/)
|
|
|
|
enable=true
|
|
|
|
regex=\/usr\/sbin\/nginx
|
|
|
|
refresh=60
|
|
|
|
one_line=false
|
|
|
|
status_url=http://localhost/nginx_status
|
|
|
|
|
2016-03-02 15:29:19 +03:00
|
|
|
Logging
|
|
|
|
-------
|
|
|
|
|
|
|
|
Glances logs all of its internal messages to a log file.
|
|
|
|
|
|
|
|
``DEBUG`` messages can been logged using the ``-d`` option on the command
|
|
|
|
line.
|
|
|
|
|
2016-12-27 21:49:37 +03:00
|
|
|
By default, the ``glances-USERNAME.log`` file is under the temporary directory:
|
2016-03-02 15:29:19 +03:00
|
|
|
|
2017-01-18 22:00:21 +03:00
|
|
|
====================== ==================================================
|
|
|
|
``Linux, *BSD, macOS`` /tmp
|
|
|
|
``Windows`` %APPDATA%\\Local\\temp
|
|
|
|
====================== ==================================================
|
2016-03-02 15:29:19 +03:00
|
|
|
|
2016-10-22 14:37:23 +03:00
|
|
|
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 a glances.json
|
|
|
|
file with (for example) the following content (JSON format):
|
|
|
|
|
|
|
|
.. code-block:: json
|
|
|
|
|
|
|
|
{
|
|
|
|
"version": 1,
|
|
|
|
"disable_existing_loggers": "False",
|
|
|
|
"root": {
|
|
|
|
"level": "INFO",
|
|
|
|
"handlers": ["file", "console"]
|
|
|
|
},
|
|
|
|
"formatters": {
|
|
|
|
"standard": {
|
|
|
|
"format": "%(asctime)s -- %(levelname)s -- %(message)s"
|
|
|
|
},
|
|
|
|
"short": {
|
|
|
|
"format": "%(levelname)s: %(message)s"
|
|
|
|
},
|
|
|
|
"free": {
|
|
|
|
"format": "%(message)s"
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"handlers": {
|
|
|
|
"file": {
|
|
|
|
"level": "DEBUG",
|
|
|
|
"class": "logging.handlers.RotatingFileHandler",
|
|
|
|
"formatter": "standard",
|
|
|
|
"filename": "/var/tmp/glances.log"
|
|
|
|
},
|
|
|
|
"console": {
|
|
|
|
"level": "CRITICAL",
|
|
|
|
"class": "logging.StreamHandler",
|
|
|
|
"formatter": "free"
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"loggers": {
|
|
|
|
"debug": {
|
|
|
|
"handlers": ["file", "console"],
|
|
|
|
"level": "DEBUG"
|
|
|
|
},
|
|
|
|
"verbose": {
|
|
|
|
"handlers": ["file", "console"],
|
|
|
|
"level": "INFO"
|
|
|
|
},
|
|
|
|
"standard": {
|
|
|
|
"handlers": ["file"],
|
|
|
|
"level": "INFO"
|
|
|
|
},
|
|
|
|
"requests": {
|
|
|
|
"handlers": ["file", "console"],
|
|
|
|
"level": "ERROR"
|
|
|
|
},
|
|
|
|
"elasticsearch": {
|
|
|
|
"handlers": ["file", "console"],
|
|
|
|
"level": "ERROR"
|
|
|
|
},
|
|
|
|
"elasticsearch.trace": {
|
|
|
|
"handlers": ["file", "console"],
|
|
|
|
"level": "ERROR"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
and start Glances using the following command line:
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
|
|
|
|
LOG_CFG=<path>/glances.json glances
|
|
|
|
|
|
|
|
Note: Replace <path> by the folder where your glances.json file is hosted.
|