La configuration du module se trouve par défaut dans le fichier /etc/shinken/modules/webui .cfg
- Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/webui-example.cfg
Exemple de fichier de configuration
#================================================================================
# WebUI
#================================================================================
# Daemons that can load this module:
# - broker
# This module is the visualization interface
# CFG_FORMAT_VERSION 1
#================================================================================
define module {
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────────── MODULE IDENTITY ───────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Module name [ Must be unique ] [ MANDATORY ] ───
# ─── ───
module_name WebUI
# ─── Module type [ Do not edit ] [ MANDATORY ] ───
# ─── ───
module_type webui
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────── INTERFACE ACCESS OPTIONS ───────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─────────────── Listening address/port ──────────────────────────────────────────────────────────────────────────── #
# ─── IP address to listen to. ───
# ─── note: 0.0.0.0 = all interfaces ───
# ─── ───
host 0.0.0.0
# ─── Port to listen to. ───
# ─── ───
port 7767
# ─────────────────────── HTTPS ───────────────────────────────────────────────────────────────────────────────────── #
# ─── Enable HTTPS. ───
# ───
# Default : 0 => Use HTTP ───
# ... : 1 => Use HTTPS ───
# ───
use_ssl 0
# ─── SSL Certificates to use. ───
# ─── ───
ssl_cert /etc/shinken/certs/server.cert
# ─── SSL key to use. ───
# ─── ───
ssl_key /etc/shinken/certs/server.key
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────────────── SECURITY ───────────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Secret key used to crypt cookie. ───
# ─── note: must be the same as the configuration UI ───
# ─── ───
auth_secret THIS SHOULD BE CHANGED BEFORE PRODUCTION
# ─── Manage ACL. ───
# ───
# ... : 0 => Enable everything for everyone ───
# Default : 1 => Use users ACL ───
# ───
manage_acl 1
# ─── Remote application authentication. ───
# ───
# Default : 0 => Disable authentication using HTTP Header ───
# ... : 1 => Allow the user to be load from a HTTP Header ───
# ───
remote_user_enable 0
# ─── HTTP Header to use to get user name if remote_user_enable is set to 1. ───
# ─── ───
remote_user_variable X-Remote-User
# ─── Enable case sensitive for user name from remote_user_variable HTTP Header. ───
# ───
# ... : 0 => Disable case check on remote user login ───
# Default : 1 => Enable case check on remote user login ───
# ───
remote_user_case_sensitive 1
# ─── Maximum output length for plugin output ───
# ─── note: 0 = no limit ───
# ─── ───
max_output_length 0
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────────── INTERFACE OPTIONS ──────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ──────────────────────── Lang ───────────────────────────────────────────────────────────────────────────────────── #
# ─── Select the lang that will be used by default on the UIs. ───
# ─── Currently managed: ───
# ───
# ... : en => (english) ───
# ... : fr => (francais) ───
# ───
lang LANG
# ─────────────────────── Paths ───────────────────────────────────────────────────────────────────────────────────── #
# ─── Folder containing shared files (displayed UI icons) ───
# ─── ───
share_dir /var/lib/shinken/share
# ─── Folder containing pictures ───
# ─── ───
photo_dir /var/lib/shinken/photos
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────────────── MODULES ───────────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Modules loaded by the Visualisation interface. ───
# ─── Available: ───
# ───
# ... : Mongodb => [mandatory] use to save user data (hive, favorites, ...) ───
# ... : webui-enterprise => [mandatory] ───
# ... : sla => [mandatory] read sla from this module definition ───
# ... : Cfg_password => check password from the user configuration ───
# ... : event-manager-reader => activate the event manager page to show event ───
# (do not forget to activate the module in your broker to write data) ───
# ... : webui-module-authentication-LDAP => check password from LDAP server ───
# ... : webui-module-service-weather => activate the service weather module which allow to create ───
# external views of a service weather to look at service state ───
# from outside of Shinken ───
# ───
modules Mongodb, webui-enterprise, sla, Cfg_password, event-manager-reader
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────────── METROLOGY ACCESS ───────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── This parameter defines the graphite server addresses for each realm used to create the metrology data. ───
# ─── The address preceded by the character * corresponds to the default graphite. ───
# ─── You can specify an address for a specific realm. ───
# ─── To define multiple graphite backends addresses, values must be separated by a comma ───
# ─── Ex. : graphite_backends *:127.0.0.1, Paris:192.168.2.200:8080 ───
# ─── ───
graphite_backends *:127.0.0.1
# ─── Before a graphite query is done, the graphite server is tested ───
# ─── Timeout for the alive timeout (in seconds) ───
# ───
# Default : 10 (seconds) ───
# ───
metrology__ping_timeout 10
# ─── Timeout for graphite queries (in seconds) ───
# ───
# Default : 20 (seconds) ───
# ───
metrology__query_timeout 20
# ─── If the test does fail, the graphite server will be exclude during this time to avoid to lock query for timeouts ───
# ───
# Default : 120 (seconds) ───
# ───
metrology__after_error_wait_before_retry 120
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────────── BROKS GETTER IN WEBUI ────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT ───
# ─── These parameters allow some internal tuning in broks management in WebUI ───
# ─── Enable or disable late broks sets catchup ───
# ───
# ... : 0 => Disable ───
# Default : 1 => Enable ───
# ───
# webui__broks_getter__activate_late_set_catchup 1
# ─── Take extra broks sets to manage if more than this parameter sets are waiting ───
# ─── ───
# webui__broks_getter__nb_late_set_allowed_before_catchup 10
# ─── Stop taking extra broks sets in catchup when we reach this number of broks ───
# ─── ───
# webui__broks_getter__catchup_broks_managed_by_module_in_a_catchup_loop 200000
# ─── Continue catchup if too much late broks sets remains after ───
# ─── ───
# webui__broks_getter__catchup_run_endless_until_nb_late_set_allowed_reached 0
# ─── Take the lock as soon as getter thread has some broks to manage in order to ───
# ─── attempt to reduce concurrent usage of CPU ───
# ─── ───
# webui__broks_getter__include_deserialisation_and_catchup_in_lock 0
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────── EXTERNAL AUTHENTICATION LOG ─────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Log the webui authentication history in a file ───
# ─── Enable authentication log or not. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# Default : 0 => Disable ───
# ... : 1 => Enable ───
# ───
# webui__log_users__enabled 0
# ─── File used for log authentication history. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# ───
# webui__log_users__file_path /var/log/shinken/webui/log_users.log
# ─── Add user name to log. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# Default : 0 => Disable ───
# ... : 1 => Enable ───
# ───
# webui__log_users__add_user_name 0
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────── LIST CSV EXPORT OPTIONS ───────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT ───
# ─── Time (in minutes) to keep a list in cache for CSV export ───
# ───
# Default : 1 (minutes) ───
# ───
broker__module_webui__csv_export_cache__limit_time_to_keep_in_cache 1
# ─── RAM allowed (in megabytes) to the CSV export cache ───
# ───
# Default : 4000 (MB) ───
# ───
broker__module_webui__csv_export_cache__limit_memory_to_use_in_cache 4000
# ─── Number of items to send per CSV Export request ───
# ───
# Default : 25000 ───
# ───
broker__module_webui__csv_export_cache__number_of_items_per_part 25000
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────── INTERFACE DEFAULT NOTIFICATIONS OPTIONS ───────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─────────── Users Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Configure users sound notification volume ───
# ─── Format is in percent. ───
# ───
# ... : Min => 0 ( /!\ With this value, the sound notification is played, but is not audible. ) ───
# ... : Max => 100 ───
# ─── Format is in percent. ───
# ───
# Default : 50 ───
# ───
# broker__module_webui__default_notifications_settings__users__sound__volume_percent 50
# ─── Configure users visual blink notification ───
# ─── Visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 1 => Enable ( Visual notification is played ) ───
# ... : 0 => Disable ( Visual notification is not played ) ───
# ───
# broker__module_webui__default_notifications_settings__users__visual__blink__enabled 1
# ─── The parameters below allow users to change default configuration of notification for webui interfaces ───
# ───
# ... : Lists ( All elements / Root problems ) ───
# ... : Hives ───
# ─────────── Lists Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Lists sound notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 0 => Disable ( Sound notification in lists is not played ) ───
# ... : 1 => Enable ( Sound notification in lists is played ) ───
# ───
# broker__module_webui__default_notifications_settings__lists__sound__enabled 0
# ─── Lists visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 0 => Disable ( Visual notification in lists is not played ) ───
# ... : 1 => Enable ( Visual notification in lists is played ) ───
# ───
# broker__module_webui__default_notifications_settings__lists__visual__blink__enabled 0
# ─────────── Hives Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Hives sound notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 0 => Disable ( Sound notification in hives is not played ) ───
# ... : 1 => Enable ( Sound notification in hives is played ) ───
# ───
# broker__module_webui__default_notifications_settings__hives__sound__enabled 0
# ─── Hives visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 0 => Disable ( Visual notification in hives is not played ) ───
# ... : 1 => Enable ( Visual notification in hives is played ) ───
# ───
# broker__module_webui__default_notifications_settings__hives__visual__blink__enabled 0
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────── EXTENDED CONFIGURATION ────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── The first file ( in /etc/shinken/_default ) contains the default values provided by Shinken. This file : ───
# ─── will be erased each update/patch ───
# ─── must be present ───
# ─── must not be changed. ───
[OVERRIDE_FROM] /etc/shinken/_default/daemons/brokers/modules/webui.cfg
[OVERRIDE_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg
} |
Détails des sections composant le fichier de configuration
Identification du module
Il est possible de définir plusieurs instances de module de type "webui" dans votre architecture Shinken.
- Chaque instance devra avoir un nom unique.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | WebUI | Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir. Doit être unique. | |
| Texte | --- | webui | Ne peux être modifié. |
Configuration de l'interface et du port d'écoute
# ─────────────── Listening address/port ──────────────────────────────────────────────────────────────────────────── #
# ─── IP address to listen to. ───
# ─── note: 0.0.0.0 = all interfaces ───
# ─── ───
host 0.0.0.0
# ─── Port to listen to. ───
# ─── ───
port 7767 |
Il est possible de configurer l'interface réseau sur laquelle est mise à disposition l'interface de visualisation. Par exemple si l'interface de visualisation ne doit être accessible seulement via un réseau local, il est possible de n'écouter que les requêtes sur cette interface réseau.
Les paramètres suivants permettent de configurer l'accès à l'interface de visualisation :
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | Adresse IPv4 | 0.0.0.0 | L'interface réseau sur laquelle le module "WebUI" va écouter. | |
| Texte | Port réseau | 50100 | Port réseau sur lequel le module "WebUI" va écouter. |
Sécurisation de la communication avec le module
# ─────────────────────── HTTPS ───────────────────────────────────────────────────────────────────────────────────── #
# ─── Enable HTTPS. ───
# ───
# Default : 0 => Use HTTP ───
# ... : 1 => Use HTTPS ───
# ───
use_ssl 0
# ─── SSL Certificates to use. ───
# ─── ───
ssl_cert /etc/shinken/certs/server.cert
# ─── SSL key to use. ───
# ─── ───
ssl_key /etc/shinken/certs/server.key |
L'interface de visualisation est accessible via HTTP. Il est recommandé d'utiliser le protocole HTTPS pour chiffrer la communication avec le module.
Si pour des raisons de sécurité, cette interface de visualisation doit être accessible via HTTPS, il est possible de configurer les certificats avec les paramètres suivants :
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Booléen | --- | 0 | Permet d'activer ou non l'utilisation du protocole HTTPS.
| |
| Texte | Chemin | /etc/shinken/certs/server.cert | Chemin vers le certificat SSL utilisé par le protocole HTTPS. | |
| Texte | Chemin | /etc/shinken/certs/server.key | Chemin vers la clé SSL utilisée par le protocole HTTPS. |
Sécurité du module
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────────────── SECURITY ───────────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Secret key used to crypt cookie. ───
# ─── note: must be the same as the configuration UI ───
# ─── ───
auth_secret THIS SHOULD BE CHANGED BEFORE PRODUCTION
# ─── Manage ACL. ───
# ───
# ... : 0 => Enable everything for everyone ───
# Default : 1 => Use users ACL ───
# ───
manage_acl 1
# ─── Remote application authentication. ───
# ───
# Default : 0 => Disable authentication using HTTP Header ───
# ... : 1 => Allow the user to be load from a HTTP Header ───
# ───
remote_user_enable 0
# ─── HTTP Header to use to get user name if remote_user_enable is set to 1. ───
# ─── ───
remote_user_variable X-Remote-User
# ─── Enable case sensitive for user name from remote_user_variable HTTP Header. ───
# ───
# ... : 0 => Disable case check on remote user login ───
# Default : 1 => Enable case check on remote user login ───
# ───
remote_user_case_sensitive 1
# ─── Maximum output length for plugin output ───
# ─── note: 0 = no limit ───
# ─── ───
max_output_length 0 |
| Nom | Type | Unité | Défaut | Commentaire | |||
|---|---|---|---|---|---|---|---|
| Texte | --- | --- | Les cookies sont chiffrés par l'interface afin que les utilisateurs ne puissent pas les créer et récupérer le compte d'un autre utilisateur. Pour cela, il utilise la clé de chiffrement contenue dans ce paramètre .
| |||
| Booléan | --- | 1 | Gestion des droits d'exécution des utilisateurs sur l'exécution d'actions sur l'interface de visualisation ( ex: Forcer le statut, définir une période de maintenance ... ). Selon les droits définis sur l'utilisateur, certains boutons d'actions lui seront cachés. | |||
| Booléan | --- | 0 | Authentification de l'application à distance. Pour plus de détail sur l'utilisation de l'authentification unique, référez-vous à la page WebUI - Authentification unique ( SSO ). | |||
| Texte | X-REMOTE-USER | En-tête HTTP qui permettra d'obtenir le nom de l'utilisateur si le paramètre "remote_user_enable" est activé. Pour plus de détail sur l'utilisation de l'authentification unique, référez-vous à la page WebUI - Authentification unique ( SSO ). | ||||
| Booléan | 1 | Vérification de la casse sur le login de l'utilisateur distant seulement si le paramètre remote_user_enable est activé.
Pour plus de détail sur l'utilisation de l'authentification unique, référez-vous à la page WebUI - Authentification unique ( SSO ). | ||||
| Entier | --- | 0 | Défini la taille maximum des textes de sortie des plugins de la WebUI.
|
Langue
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────────── INTERFACE OPTIONS ──────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ──────────────────────── Lang ───────────────────────────────────────────────────────────────────────────────────── #
# ─── Select the lang that will be used by default on the UIs. ───
# ─── Currently managed: ───
# ───
# ... : en => (english) ───
# ... : fr => (francais) ───
# ───
lang LANG |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | en | Modification de la langue utilisée dans l'interface de visualisation.
|
Dossiers de fichiers partagés et de photos
# ─────────────────────── Paths ───────────────────────────────────────────────────────────────────────────────────── #
# ─── Folder containing shared files (displayed UI icons) ───
# ─── ───
share_dir /var/lib/shinken/share
# ─── Folder containing pictures ───
# ─── ───
photo_dir /var/lib/shinken/photos |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | /var/lib/shinken/share | Emplacement du dossier des fichiers partagés ( contiens les icônes affichées dans les listes de l'interface de configuration ). | |
| Texte | --- | /var/lib/shinken/photos | Emplacement du dossier des photos. |
Modules du module WebUI
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────────────── MODULES ───────────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Modules loaded by the Visualisation interface. ───
# ─── Available: ───
# ───
# ... : Mongodb => [mandatory] use to save user data (hive, favorites, ...) ───
# ... : webui-enterprise => [mandatory] ───
# ... : sla => [mandatory] read sla from this module definition ───
# ... : Cfg_password => check password from the user configuration ───
# ... : event-manager-reader => activate the event manager page to show event ───
# (do not forget to activate the module in your broker to write data) ───
# ... : webui-module-authentication-LDAP => check password from LDAP server ───
# ... : webui-module-service-weather => activate the service weather module which allow to create ───
# external views of a service weather to look at service state ───
# from outside of Shinken ───
# ───
modules Mongodb, webui-enterprise, sla, Cfg_password, event-manager-reader |
Plusieurs modules sont disponibles pour le module WebUI.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | Liste de noms de sous modules, séparés par des virgules. Par défaut, aucun sous module n'est activé. Voici la Les Modules de la WebUI pour ce module. |
Connexion à la base MongoDB
Le module WebUI a besoin de se connecter à une base MongoDB pour stocker les portails, tableaux de bord et favoris des utilisateurs. Le paramétrage pour la connexion à cette base Mongo est décrit dans la page du Module MongoDB.
Accès aux données de Métrologie
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────────── METROLOGY ACCESS ───────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── This parameter defines the graphite server addresses for each realm used to create the metrology data. ───
# ─── The address preceded by the character * corresponds to the default graphite. ───
# ─── You can specify an address for a specific realm. ───
# ─── To define multiple graphite backends addresses, values must be separated by a comma ───
# ─── Ex. : graphite_backends *:127.0.0.1, Paris:192.168.2.200:8080 ───
# ─── ───
graphite_backends *:127.0.0.1
# ─── Before a graphite query is done, the graphite server is tested ───
# ─── Timeout for the alive timeout (in seconds) ───
# ───
# Default : 10 (seconds) ───
# ───
metrology__ping_timeout 10
# ─── Timeout for graphite queries (in seconds) ───
# ───
# Default : 20 (seconds) ───
# ───
metrology__query_timeout 20
# ─── If the test does fail, the graphite server will be exclude during this time to avoid to lock query for timeouts ───
# ───
# Default : 120 (seconds) ───
# ───
metrology__after_error_wait_before_retry 120 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | Ce paramètre définit les adresses des serveurs graphite pour chaque royaume utilisé pour créer les données de métrologie. La syntaxe est la suivante : REALM:HOSTNAME:PORT.
Pour définir plusieurs graphite backend sur une WebUI, les adresses doivent être séparées par des virgules.
Dans cet exemple, le royaume France utilise l'adresse 192.168.100:8080 et tous les autres royaumes utilisent l'adresse 127.0.0.1 avec le port 80. | ||
| Entier | Secondes | 10 | Avant qu'une requête graphite soit effectuée, une vérification est faite pour s'assurer du bon fonctionnement du serveur graphite. | |
| Entier | Secondes | 20 | Temps maximum d'exécution des requêtes graphites. | |
| Entier | Secondes | 120 | Si la commande de vérification du bon fonctionnement du serveur graphite échoue, le module sera suspendu avant de relancer la vérification. |
Récupération des broks
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────────── BROKS GETTER IN WEBUI ────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT ───
# ─── These parameters allow some internal tuning in broks management in WebUI ───
# ─── Enable or disable late broks sets catchup ───
# ───
# ... : 0 => Disable ───
# Default : 1 => Enable ───
# ───
# webui__broks_getter__activate_late_set_catchup 1
# ─── Take extra broks sets to manage if more than this parameter sets are waiting ───
# ─── ───
# webui__broks_getter__nb_late_set_allowed_before_catchup 10
# ─── Stop taking extra broks sets in catchup when we reach this number of broks ───
# ─── ───
# webui__broks_getter__catchup_broks_managed_by_module_in_a_catchup_loop 200000
# ─── Continue catchup if too much late broks sets remains after ───
# ─── ───
# webui__broks_getter__catchup_run_endless_until_nb_late_set_allowed_reached 0
# ─── Take the lock as soon as getter thread has some broks to manage in order to ───
# ─── attempt to reduce concurrent usage of CPU ───
# ─── ───
# webui__broks_getter__include_deserialisation_and_catchup_in_lock 0 |
Ces paramètres sont dédiés au fonctionnement interne du module, il est fortement recommandé de ne pas les modifier sans votre support dédié. |
Le fonctionnement du thread de récupération des broks peut être configuré via certains paramètres, afin de modifier son "agressivité".
Pendant la mise à jour des données de supervision, le module ne peut pas répondre aux requêtes HTTP qu'il reçoit.
Principe de l'algorithme d'absorption des broks :
- Attente de broks à traiter.
- Récupération de broks en retard ( fonctionnalité de rattrapage ).
- Désérialisation des broks.
- Entrée en session critique ( les requêtes à l'API sont bloquées ).
- Traitement des broks.
- Libérer la session critique et attendre de nouveaux broks, ou continuer l'absorption de broks ( en cas de retard important, on repart à l'étape 1. en restant sur la session critique ).
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Booléen | --- | 1 | Utilisation de la fonctionnalité de rattrapage pour absorber des broks en retard.
| |
| Nombre | Nombre de broks set | 10 | Nombre de brok set en attente toléré. Au-dessus de ce nombre, les brok set sont immédiatement récupérés par l'algorithme de rattrapage pour être traités immédiatement. | |
| Nombre | Nombre de broks | 200000 | Nombre maximal de broks que l'algorithme de rattrapage récupère avant de lancer le traitement. | |
| Booléen | --- | 1 | Après traitement des broks, si le nombre de brok set en retard est trop élevé :
| |
| Booléen | --- | 0 | Dans le cas où vous voulez disposer d'un maximum de temps CPU pour traiter les broks en retard, vous pouvez activer ce paramètre afin de bloquer les requêtes à l'API dès la phase 2 ( Récupération de broks en retard ) puis une fois les broks rattrapés passés en Phase 5 ( Traitement des broks ). Deux valeurs possibles pour ce paramètre :
|
Log externe d'authentification
Les paramètres suivants permettent au module WebUI de créer un fichier de log pour y recenser toutes les tentatives de connexion qu'elles soient réussites ou non ainsi que les déconnexions.
Ces paramètres ne sont là que pour avertir l'utilisateur qu'ils peuvent être modifiés dans le fichier /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg.
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────── EXTERNAL AUTHENTICATION LOG ─────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Log the webui authentication history in a file ───
# ─── Enable authentication log or not. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# ───
# Default : 0 => Disable ───
# ... : 1 => Enable ───
# ───
# webui__log_users__enabled 0
# ─── File used for log authentication history. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# ─── ───
# webui__log_users__file_path /var/log/shinken/webui/log_users.log
# ─── Add user name to log. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# ───
# Default : 0 => Disable ───
# ... : 1 => Enable ───
# ───
# webui__log_users__add_user_name 0 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Booléen | --- | 0 | Permet d'activer ou de désactiver les logs d'authentifications :
| |
| Texte | --- | /var/log/shinken/webui/log_users.log | Défini le fichier utilisé pour écrire les logs. | |
| Booléen | --- | 0 | Permet d'activer ou de désactiver l'ajout du nom de l'utilisateur :
|
Les logs d'activité des utilisateurs ( authentification et session )
Les paramètres suivants permettent au module WebUI de créer un fichier de log pour y recenser toutes les tentatives de connexion qu'elles soient réussites ou non ainsi que les déconnexions.
Ces paramètres ne sont là que pour avertir l'utilisateur qu'ils peuvent être modifiés dans le fichier /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg.
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────── EXTERNAL AUTHENTICATION LOG ─────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Log the webui authentication and session history in a file ───
# ─── Enable authentication and session log or not. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# Default : 0 => Disable ───
# ... : 1 => Enable ───
# ───
# webui__log_users__enabled 0
# ─── File used for log authentication and session history. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# ───
# webui__log_users__file_path /var/log/shinken/webui/log_users.log
# ─── Add user name to log. ───
# ─── /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg ───
# Default : 0 => Disable ───
# ... : 1 => Enable ───
# ───
# webui__log_users__add_user_name 0 |
| Clé | Type | Valeur par défaut | Description | |
|---|---|---|---|---|
| Booléen | 0 | Active ou non le log de la connexion des utilisateurs dans un fichier de logs à part :
| |
| Texte | /var/log/shinken/webui/log_users.log | Précise le chemin vers le quel les logs vont être écrits. | |
| Booléen | 0 | Ajoute le nom des utilisateur dans les logs. Par défaut, seul un identifiant anonyme sera présent à la place.
|
Options pour l'export de la liste en CSV
Il est possible d'effectuer un export CSV depuis une liste dans l'interface de Visualisation. Pour des raisons de performances, ces exports, si ils sont trop importants, sont divisés en plusieurs parties. Ceci afin de ne pas faire tomber le navigateur. Il est possible de modifier ce comportement via les paramètres ci-dessous, afin de correspondre au mieux avec vos besoins.
Ces paramètres sont dédiés au fonctionnement interne du module, il est fortement recommandé de ne pas les modifier sans votre support dédié. |
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────── LIST CSV EXPORT OPTIONS ───────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT ───
# ─── Time (in minutes) to keep a list in cache for CSV export ───
# ───
# Default : 1 (minutes) ───
# ───
broker__module_webui__csv_export_cache__limit_time_to_keep_in_cache 1
# ─── RAM allowed (in megabytes) to the CSV export cache ───
# ───
# Default : 4000 (MB) ───
# ───
broker__module_webui__csv_export_cache__limit_memory_to_use_in_cache 4000
# ─── Number of items to send per CSV Export request ───
# ───
# Default : 25000 ───
# ───
broker__module_webui__csv_export_cache__number_of_items_per_part 25000 |
| Clé | Type | Valeur par défaut | Description | |
|---|---|---|---|---|
| Entier | 1 | Défini le temps maximum de rétention d'un cache d'export en RAM ( en minutes ). Ce temps est réinitialisé entre chaque requête. Si une partie d'un export est demandée, on remet à 0 le temps limite de rétention de l'export. | |
| Entier | 4000 | Défini la limite de RAM allouée au cache d'export. Si cette limite est dépassée au moment d'un nouvel export, celui-ci ne peut être effectué ( en mégaoctets ). | |
| Entier | 25000 | Défini le nombre d'éléments Shinken par part à envoyer lors de l'export CSV. Ceci défini plus globalement la taille des données envoyées à votre navigateur à chaque requête de l'interface de Visualisation. |
Options de notifications par défaut
Il est possible de choisir une notification sonore ainsi qu'une notification visuelle lorsqu'un élément change de statut ou de contexte.
Les valeurs de ces paramètres impacteront seulement les valeurs par défaut des interfaces suivantes :
- les listes ( Tous les éléments / Problèmes sources ),
- les portails.
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────── INTERFACE DEFAULT NOTIFICATIONS OPTIONS ───────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─────────── Users Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Configure users sound notification volume ───
# ─── Format is in percent. ───
# ───
# ... : Min => 0 ( /!\ With this value, the sound notification is played, but is not audible. ) ───
# ... : Max => 100 ───
# ─── Format is in percent. ───
# ───
# Default : 50 ───
# ───
# broker__module_webui__default_notifications_settings__users__sound__volume_percent 50
# ─── Visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 1 => Enable ( Visual notification is played ) ───
# ... : 0 => Disable ( Visual notification is not played ) ───
# ───
# broker__module_webui__default_notifications_settings__users__visual__blink__enabled 1
# ─── The parameters below allow users to change default configuration of notification for webui interfaces ───
# ───
# ... : Lists ( All elements / Root problems ) ───
# ... : Hives ───
# ─────────── Lists Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Lists sound notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 0 => Disable ( Sound notification in lists is not played ) ───
# ... : 1 => Enable ( Sound notification in lists is played ) ───
# ───
# broker__module_webui__default_notifications_settings__lists__sound__enabled 0
# ─── Lists visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 1 => Enable ( Visual notification in lists is played ) ───
# ... : 0 => Disable ( Visual notification in lists is not played ) ───
# ───
# broker__module_webui__default_notifications_settings__lists__visual__blink__enabled 1
# ─────────── Hives Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Hives sound notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 0 => Disable ( Sound notification in hives is not played ) ───
# ... : 1 => Enable ( Sound notification in hives is played ) ───
# ───
# broker__module_webui__default_notifications_settings__hives__sound__enabled 0
# ─── Hives visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 1 => Disable ( Visual notification in hives is played ) ───
# ... : 0 => Enable ( Visual notification in hives is not played ) ───
# ───
# broker__module_webui__default_notifications_settings__hives__visual__blink__enabled 1 |
Paramétrage des notifications pour les utilisateurs
# ─────────── Users Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Configure users sound notification volume ───
# ─── Format is in percent. ───
# ───
# ... : Min => 0 ( /!\ With this value, the sound notification is played, but is not audible. ) ───
# ... : Max => 100 ───
# ─── Format is in percent. ───
# ───
# Default : 50 ───
# ───
# broker__module_webui__default_notifications_settings__users__sound__volume_percent 50
# ─── Visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 1 => Enable ( Visual notification is played ) ───
# ... : 0 => Disable ( Visual notification is not played ) ───
# ───
# broker__module_webui__default_notifications_settings__users__visual__blink__enabled 1 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Entier | ( % ) | 50 | Ce paramètre permet de définir la valeur par défaut du volume des notifications sonores pour les utilisateurs dans toutes les interfaces de la webui et de ses modules. | |
| Texte | --- | 1 | Permet d'activer/désactiver la notification visuelle qui sera jouée lors d'une notification pour les utilisateurs.
|
Paramétrage des notifications pour les "Listes" ( Tous les éléments / Problèmes sources)
# ─────────── Lists Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Lists sound notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 0 => Disable ( Sound notification in lists is not played ) ───
# ... : 1 => Enable ( Sound notification in lists is played ) ───
# ───
# broker__module_webui__default_notifications_settings__lists__sound__enabled 0
# ─── Lists visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 1 => Enable ( Visual notification in lists is played ) ───
# ... : 0 => Disable ( Visual notification in lists is not played ) ───
# ───
# broker__module_webui__default_notifications_settings__lists__visual__blink__enabled 1 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | 0 | Permet d'activer/désactiver la notification sonore qui sera jouée lors d'une notification dans les listes.
| |
| Texte | --- | 1 | Permet d'activer/désactiver la notification visuelle qui sera jouée lors d'une notification dans les listes.
|
Paramétrage des notifications pour les "Portails"
# ─────────── Hives Notification Parameters ───────────────────────────────────────────────────────────────────────── #
# ─── Hives sound notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 0 => Disable ( Sound notification in hives is not played ) ───
# ... : 1 => Enable ( Sound notification in hives is played ) ───
# ───
# broker__module_webui__default_notifications_settings__hives__sound__enabled 0
# ─── Hives visual notification on element change ( Only for the status/context currently ) ───
# ───
# Default : 1 => Disable ( Visual notification in hives is played ) ───
# ... : 0 => Enable ( Visual notification in hives is not played ) ───
# ───
# broker__module_webui__default_notifications_settings__hives__visual__blink__enabled 1 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | 0 | Permet d'activer/désactiver la notification sonore qui sera jouée lors d'une notification dans les portails.
| |
| Texte | --- | 1 | Permet d'activer/désactiver la notification visuelle qui sera jouée lors d'une notification dans les portails.
|
Changement du son joué
Vous pouvez changer le son joué lors des notifications de changements ( voir la page Changer le son des notifications utilisé par l'Interface de visualisation )
Surcharge de la configuration
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────── EXTENDED CONFIGURATION ────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── The first file ( in /etc/shinken/_default ) contains the default values provided by Shinken. This file : ───
# ─── will be erased each update/patch ───
# ─── must be present ───
# ─── must not be changed. ───
[OVERRIDE_FROM] /etc/shinken/_default/daemons/brokers/modules/webui.cfg
[OVERRIDE_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | Ce paramètre permet de surcharger les paramètres de la webui. Il contient les paramètres de l'interface, qui peuvent être commun avec d'autres WebUI. Le premier fichier contient les valeurs livrées par défaut par Shinken. Il sera écrasé et mis à jour à chaque mise à jour et installation de patch. Il doit être présent et non modifié. Ce paramètre peut être utilisé plusieurs fois pour ajouter plusieurs fichiers. |