| Scroll Ignore |
|---|
| scroll-pdf | true |
|---|
| scroll-office | true |
|---|
| scroll-chm | true |
|---|
| scroll-docbook | true |
|---|
| scroll-eclipsehelp | true |
|---|
| scroll-epub | true |
|---|
| scroll-html | true |
|---|
|
|
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
| Code Block |
|---|
|
#===============================================================================
# WebUI
#===============================================================================
# Daemons that can load this module:
# - broker
# This module is the visualization interface
#===============================================================================
define module {
# Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
_SE_UUID core-module-2e0f08c45adc11e59a90080027f08538
_SE_UUID_HASH 99215795c7e21b658e7c34989e872fcc
# End of Shinken Enterprise part
#======== Module identity =========
# Module name. Must be unique
module_name WebUI
# Module type (to load module code). Do not edit.
module_type webui
#======== Listening address =========
# host: IP address to listen to.
# note: 0.0.0.0 = all interfaces.
host 0.0.0.0
# port to listen
port 7767
# HTTPs part, enable if you want to set the visualisation interface listen in HTTPs mode
# disabled by default. Set your own certificates.
use_ssl 0
ssl_cert /etc/shinken/certs/server.cert
ssl_key /etc/shinken/certs/server.key
#======== Security =========
# auth_secret: secret key used to crypt cookie.
# note: must be the same as the configuration UI
auth_secret THIS SHOULD BE CHANGED BEFORE PRODUCTION
# Allow or not HTML chars in plugins output
allow_html_output 0
# Use users ACL or enable all for everyone
manage_acl 1
# Remote application authentication
# if 1: allow the user to be load from a HTTP Header
remote_user_enable 0
# which HTTP header to get user name if remote_user_enable is 1
remote_user_variable X_Remote_User
# if remote_user_enable is 1,
# http_remote_user_case_sensitive to 1 enable case check on remote user login
# http_remote_user_case_sensitive to 0 disable case check on remote user login
# default value : 1, login is case sensitive
remote_user_case_sensitive 1
# Maximum output length for plugin output, 0=no limit
max_output_length 0
#======== Lang =========
# Select the lang that will be used by default on the UIs
# Currently managed:
# -en (english)
# -fr (francais)
lang LANG
#======== Paths =========
share_dir /var/lib/shinken/share
photo_dir /var/lib/shinken/photos
#======== Modules =========
# Modules loaded by the Visualisation interface
# Available:
# - Cfg_password : check password from the user configuration
# - auth-active-directory : check password from active directory
# - Mongodb : [mandatory] use to save user data (hive, favorites, ...)
# - webui-enterprise : [mandatory]
# - sla : [mandatory] read sla from this module definition
modules Cfg_password, Mongodb,webui-enterprise, sla
#======== 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 France:127.0.0.1, Bordeaux:192.168.1.100:8080
# 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
# default: 10 (seconds)
metrology__ping_timeout 10
# Timeout for graphite queries
# 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 =========
# These parameters allow some internal tuning in broks management in WebUI
# Enable or disable late broks sets catchup
# 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
#======== Webui ExtendedAuthentication External configurationLog =========
# TheLog line [OVERLOAD_FROM] /etc/shinken/_default/daemons/brokers/modules/webui.cfg must be present and must not be changed !the webui authentication history in a file
# Enable authentication log or not.
# by default: 0 (disabled)
# You can overload value /!\ Need be change in the webui_cfg_overload.cfg.
file [OVERLOAD_FROM] /etc/shinken/_default/daemons/brokers/modules/webuiwebui_cfg_overload.cfg
[OVERLOAD_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/# webui__log_users__enabled=0
# File use for log authentication history
# /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg
}
|
Détails des sections composant le fichier de configuration
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
| Code Block |
|---|
|
#======== Listening address =========
# host: IP address to listen to.
# note: 0.0.0.0 = all interfaces.
host 0.0.0.0
# port to listen
port 7767 |
# webui__log_users__file_path=/var/log/shinken/webui/log_users.log
# Add user name to log.
# by default: 0 (disabled)
# /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg
# webui__log_users__add_user_name=0
#======== Extended configuration ========
# The line [OVERLOAD_FROM] /etc/shinken/_default/daemons/brokers/modules/webui.cfg must be present and must not be changed !
# You can overload value in the webui_cfg_overload.cfg.
[OVERLOAD_FROM] /etc/shinken/_default/daemons/brokers/modules/webui.cfg
[OVERLOAD_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg
}
|
Détails des sections composant le fichier de configuration
Il est possible de définir plusieurs instances de module de type "webui" dans votre architecture Shinken.
- Chaque instance devra avoir un nom unique.
Il est possible de configurer l'interface réseau sur laquelle est mise à disposition l'interface de visualisation. Si par exemple 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 | 7767 | Port réseau sur lequel le module "WebUI" va écouter. | Sécurisation de la communication avec le module
| Code Block |
|---|
|
# HTTPs part, enable if you want to set the visualisation interface listen in HTTPs mode
# disabled by default. Set your own certificates.
use_ssl 0
ssl_cert /etc/shinken/certs/server.cert
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 |
|---|
| Code Block |
|---|
usemodule_sslname |
| BooléenTexte | --- | 0 | Permet d'activer ou non WebUI | Nous vous conseillons de choisir un nom en fonction de l'utilisation du | protocole HTTPS.0 : Désactivé ( utilise HTTP )1 : Activé ( utilise HTTPS )module pour que votre configuration soit simple à maintenir. Doit être unique. |
| ssl | cert | 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. |
| --- | webui | Ne peux être modifié. |
Configuration de l'interface et du port d'écoute
| Code Block |
|---|
|
#= |
| Code Block |
|---|
|
#======== Listening Securityaddress =========
# auth_secrethost: secretIP keyaddress used to cryptlisten cookieto.
# note: must be the same as the configuration UI
auth_secret AUTH-SECRET-22316-4472-3256
# Use users ACL or enable all for everyone
manage_acl 1
# Remote application authentification
# if 1: allow the user to be load from a HTTP Header
remote_user_enable 1
# which HTTP header to get user name if remote_user_enable is 1
remote_user_variable X-Forwarded-User
# if remote_user_enable is 1,
# http_remote_user_case_sensitive to 1 enable case check on remote user login
# http_remote_user_case_sensitive to 0 disable case check on remote user login
# default value : 1, login is case sensitive
remote_user_case_sensitive 1 |
| 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.
Cette clé de chiffrement est une chaîne de caractères aléatoire.
Il vous est possible de créer votre propre clé en mettant des caractères aléatoires les uns à la suite des autres.
Plus votre clé sera longue, plus votre cookie sera sécurisé.
Pour cela, il utilise la clé de chiffrement contenue dans ce paramètre .
| Warning |
|---|
Ce paramètre est généré lors de l'installation et n'a pas à être modifié par les administrateurs. |
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. | | Code Block |
|---|
remote_user_enable |
Booléan | --- | 0 | Authentification de l'application à distance.
C'est une authentification unique ( SSO ). Elle est souvent activée pour permettre de se connecter de manière centralisée à des services.
Pour plus de détail sur l'utilisation de l'authentification unique, référez-vous à la page WebUI - Authentification unique ( SSO ).
| Code Block |
|---|
remote_user_variable |
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 ). | | Code Block |
|---|
remote_user_case_sensitive |
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é - 1 : Active la vérification
- 0 : Désactive la vérification
Pour plus de détail sur l'utilisation de l'authentification unique, référez-vous à la page WebUI - Authentification unique ( SSO ). | 0.0.0.0 = all interfaces.
host 0.0.0.0
# port to listen
port 7767 |
Il est possible de configurer l'interface réseau sur laquelle est mise à disposition l'interface de visualisation. Si par exemple 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 | 7767 | Port réseau sur lequel le module "WebUI" va écouter. |
Sécurisation de la communication avec le module
| Code Block |
|---|
|
# HTTPs part, enable if you want to set the visualisation interface listen in HTTPs mode
# disabled by default. Set your own certificates.
use_ssl 0
ssl_cert /etc/shinken/certs/server.cert
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. - 0 : Désactivé ( utilise HTTP )
- 1 : Activé ( utilise 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. |
| Code Block |
|---|
|
|
| Code Block |
|---|
|
#======== LangSecurity =========
# Select the lang that willauth_secret: secret key used to crypt cookie.
# note: must be usedthe bysame defaultas onthe theconfiguration UIsUI
auth_secret # Currently managed:
# -en (english)AUTH-SECRET-22316-4472-3256
# -frUse users ACL or (francais)enable all for everyone
langmanage_acl 1
LANG |
| Nom | Type | Unité | Défaut | Commentaire |
|---|
Texte | --- | en | Modification de la langue utilisée dans l'interface de visualisation. À ce jour, deux langues sont disponibles - en ( Anglais )
- fr ( Français )
| Dossiers de fichiers partagés et de photos
| Code Block |
|---|
|
#======== Paths =========
share_dir# Remote application authentification
# if 1: allow the user to be load from a HTTP Header
remote_user_enable 1
# which HTTP header /var/lib/shinken/share
photo_dir to get user name if remote_user_enable is 1
remote_user_variable X-Forwarded-User
# /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 | | Code Block |
|---|
|
#======== Modules =========if remote_user_enable is 1,
# http_remote_user_case_sensitive to 1 enable case check on remote user login
# Modules loaded by the Visualisation interface
# Available:http_remote_user_case_sensitive to 0 disable case check on remote user login
# - Cfg_password default value : 1, login is case sensitive
: check password from the user configuration
# - auth-active-directory : check password from active directory
# - Mongodb : [mandatory] use to save user data (hive, favorites, ...)
# - webui-enterprise : [mandatory]
# - sla : [mandatory] read sla from this module definition
modules Cfg_password, Mongodb, webui-enterprise, sla |
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é. | remote_user_case_sensitive 1 |
| 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. Cette clé de chiffrement est une chaîne de caractères aléatoire. Il vous est possible de créer votre propre clé en mettant des caractères aléatoires les uns à la suite des autres. Plus votre clé sera longue, plus votre cookie sera sécurisé. Pour cela, il utilise la clé de chiffrement contenue dans ce paramètre .
| Warning |
|---|
Ce paramètre est généré lors de l'installation et n'a pas à être modifié par les administrateurs. |
|
| 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. |
| Code Block |
|---|
remote_user_enable |
| Booléan | --- | 0 | Authentification de l'application à distance. C'est une authentification unique ( SSO ). Elle est souvent activée pour permettre de se connecter de manière centralisée à des services. Pour plus de détail sur l'utilisation de l'authentification unique, référez-vous à la page WebUI - Authentification unique ( SSO ).
|
| Code Block |
|---|
remote_user_variable |
| 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 ). |
| Code Block |
|---|
remote_user_case_sensitive |
| 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é - 1 : Active la vérification
- 0 : Désactive la vérification
Pour plus de détail sur l'utilisation de l'authentification unique, référez-vous à la page WebUI - Authentification unique ( SSO ). |
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
| Code Block |
|---|
|
#======== Metrology accessLang =========
# ThisSelect parameter defines the graphitelang serverthat addresseswill forbe eachused realmby useddefault toon create the metrology data.UIs
# TheCurrently addressmanaged:
preceded by the character# *-en corresponds to the default graphite. (english)
# You-fr can specify an address(francais)
for a specific realm.
lang # To define multiple graphite backends addresses, values must be separated by a comma
# Ex. : graphite_backends France:127.0.0.1, Bordeaux:192.168.1.100:8080, Paris:http://192.168.2.200:200
# 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
# default: 10 (seconds)
metrology__ping_timeout 10
# Timeout for graphite queries
# default: 20 (seconds)
metrology__query_timeout 20
# If the test does fail, the graphite server will be exclude during this time LANG |
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| Texte | --- | en | Modification de la langue utilisée dans l'interface de visualisation. À ce jour, deux langues sont disponibles - en ( Anglais )
- fr ( Français )
|
Dossiers de fichiers partagés et de photos
| Code Block |
|---|
|
#======== Paths =========
share_dir /var/lib/shinken/share
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 |
| Code Block |
|---|
|
#======== Modules =========
# Modules loaded by the Visualisation interface
# Available:
# to- avoidCfg_password to lock query for timeouts
# default: 120 (seconds)
check password from the user configuration
metrology__after_error_wait_before_retry 120
|
| Clé | Type | Défaut | Description |
|---|
| Code Block |
|---|
graphite_backends |
Liste | --- | 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 - REALM : Nom du royaume :
- permet de définir un royaume précis,
- la valeur par défaut ( * ) regroupe les royaumes non définis explicitement.
- HOSTNAME : Nom de l'hôte ou adresse IP du serveur Graphite ;
- PORT : Port du service Graphite, configurable dans le fichier /etc/httpd/conf.d/graphite.conf. Si le port n'est pas précisé, c'est le port 80 qui sera utilisé ( par défaut ).
Pour définir plusieurs graphite_backend sur une WebUI, les adresses doivent être séparées par des virgules - Exemple : grapite_backends *:127.0.0.1, France:192.168.100:8080
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. | | Code Block |
|---|
metrology__ping_timeout |
Entier | 10 | Avant qu'une requête graphite soit effectuée, une vérification est faite pour s'assurer du bon fonctionnement du serveur graphite. Ce paramètre définit le temps maximum d'exécution de la requête de vérification. | | Code Block |
|---|
metrology__query_timeout |
Entier | 20 | Temps maximum d'exécution des requêtes graphites. | | Code Block |
|---|
metrology__after_error_wait_before_retry |
Entier | 120 | # - auth-active-directory : check password from active directory
# - Mongodb : [mandatory] use to save user data (hive, favorites, ...)
# - webui-enterprise : [mandatory]
# - sla : [mandatory] read sla from this module definition
modules Cfg_password, Mongodb, webui-enterprise, sla |
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é. |
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
| Code Block |
|---|
|
#======== 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 France:127.0.0.1, Bordeaux:192.168.1.100:8080, Paris:http://192.168.2.200:200
# 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
# default: 10 (seconds)
metrology__ping_timeout 10
# Timeout for graphite queries
# 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
|
| Clé | Type | Défaut | Description |
|---|
| Code Block |
|---|
graphite_backends |
| Liste | --- | 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 - REALM : Nom du royaume :
- permet de définir un royaume précis,
- la valeur par défaut ( * ) regroupe les royaumes non définis explicitement.
- HOSTNAME : Nom de l'hôte ou adresse IP du serveur Graphite ;
- PORT : Port du service Graphite, configurable dans le fichier /etc/httpd/conf.d/graphite.conf. Si le port n'est pas précisé, c'est le port 80 qui sera utilisé ( par défaut ).
Pour définir plusieurs graphite_backend sur une WebUI, les adresses doivent être séparées par des virgules - Exemple : grapite_backends *:127.0.0.1, France:192.168.100:8080
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. |
| Code Block |
|---|
metrology__ping_timeout |
| Entier | 10 | Avant qu'une requête graphite soit effectuée, une vérification est faite pour s'assurer du bon fonctionnement du serveur graphite. Ce paramètre définit le temps maximum d'exécution de la requête de vérification. |
| Code Block |
|---|
metrology__query_timeout |
| Entier | 20 | Temps maximum d'exécution des requêtes graphites. |
| Code Block |
|---|
metrology__after_error_wait_before_retry |
| Entier | 120 | Si la commande de vérification du bon fonctionnement du serveur graphite échoue, le module sera suspendu avant de relancer la vérification. Ce paramètre correspond au temps d'attente avant de relancer la vérification. |
| Code Block |
|---|
|
#======== Broks getter in WebUI =========
# These parameters allow some internal tuning in broks management in WebUI
# Enable or disable late broks sets catchup
# 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 1
# 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_deserialization_and_catchup_in_lock 0 |
Le fonctionnement du mécanisme 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.
| Warning |
|---|
Une mauvaise configuration de ces paramètres peut compromettre le bon fonctionnement du module, se rapprocher du support si vous avez le moindre doute |
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 HTTP 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)
Si la commande de vérification du bon fonctionnement du serveur graphite échoue, le module sera suspendu avant de relancer la vérification. Ce paramètre correspond au temps d'attente avant de relancer la vérification. | | Anchor |
|---|
RECUPBROKS | RECUPBROKS | Récupération des broks| Code Block |
|---|
|
#======== Broks getter in WebUI =========
# These parameters allow some internal tuning in broks management in WebUI
# Enable or disable late broks sets catchup
# 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
# | Clé | Type | Valeur par défaut | Description |
|---|
| Code Block |
|---|
webui__broks_getter__include_deserialization_and_catchup_in_lock
|
| Booléen | 0 | Entrer en session critique après la récupération d'un premier brok set. La récupération des broks en retard, et la dé-sérialisation se font alors dans la session critique (Locké) pour disposer d'un maximum de temps CPU |
| Code Block |
|---|
webui__broks_getter__activate_late_set_catchup
|
| Booléen | 1 | Utilisation de la fonctionnalité de rattrapage pour absorber des broks en retard : |
| Code Block |
|---|
webui__broks_getter__nb_late_set_allowed_before_catchup
|
| Entier | 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 maintenant |
|
webui__broks_getter__catchup_ |
|
runendlessuntilnblate_set_allowed_reached 1
# Take the lock as soon as getter thread has some broks to manage
# in order to attempt to reduce concurrent usage of CPU
# | Entier | 200000 | Nombre maximal de broks que l'algorithme de rattrapage récupère avant de lancer le traitement Ce paramètre permet de borner la consommation mémoire et le temps d'exécution d'un tour de boucle de traitement |
| Code Block |
|---|
webui__broks_getter__ |
|
include_deserialization_and_catchup_in_lock 0catchup_run_endless_until_nb_late_set_allowed_reached
|
| Booléen | 1 | Après traitement des broks, si le nombre de brok set en retard est trop élevé, - 1 continuer le rattrapage et absorber des broks en retard (en restant sur la session critique, ou "avec le lock")
- 0 arrêter l'absorption de brok et libérer la session critique (rendre le lock)
|
| Code Block |
|---|
webui__broks_getter__include_deserialisation_and_catchup_in_lock
|
|
|
| Dans le cas ou vous voulez disposer d'un maximum de temps CPU pour traiter les broks en retard, vous pouvez inclure la phase 2 ( Récupération de broks en retard ) et Phase 3 ( Dé-sérialisation des broks ) dans la phase Critique ( Phase 4 ) La récupération des broks en retard, et la dé-sérialisation se font alors dans la session critique (Locké) pour |
Log de la connexion des utilisateurs
Il est possible d'activer le log des utilisateurs dans un fichier à part du fichier de log habituel avec ces paramètres :
| Code Block |
|---|
|
#======== Webui Authentication External Log =========
# Log the webui authentication history in a file
# Enable authentication log or not.
# by default: 0 (disabled)
# /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg
# webui__log_users__enabled=0
# File use 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.
# by default: 0 (disabled)
# /!\ Need be change in the file [OVERLOAD_FROM] webui_cfg_overload.cfg
# webui__log_users__add_user_name=0 |
| Clé | Type | Valeur par défaut | Description |
|---|
| Code Block |
|---|
webui__log_users__enabled |
| Booléen | 0 | Active ou non le log de la connexion des utilisateurs dans un fichier de logs à part :
|
| Code Block |
|---|
webui__log_users__file_path |
| Booléen | /var/log/shinken/webui/log_users.log | Précise le chemin vers le quel les logs vont être écrits. |
| Code Block |
|---|
webui__log_users__add_user_name |
| Booléen | 0 | Ajoute le nom des utilisateur dans les logs. Par défaut, seul un identifiant anonyme sera présent à la place. - 1 : Nom d'utilisateurs visibles
- 0 : Nom d'utilisateurs remplacés par des identifiants anonymes
|
Le fonctionnement du mécanisme 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.
| Warning |
|---|
Une mauvaise configuration de ces paramètres peut compromettre le bon fonctionnement du module, se rapprocher du support si vous avez le moindre doute |
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 HTTP 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)
| Clé | Type | Valeur par défaut | Description |
|---|
| Code Block |
|---|
webui__broks_getter__include_deserialization_and_catchup_in_lock
|
Booléen | 0 | Entrer en session critique après la récupération d'un premier brok set. La récupération des broks en retard, et la dé-sérialisation se font alors dans la session critique (Locké) pour disposer d'un maximum de temps CPU | | Code Block |
|---|
webui__broks_getter__activate_late_set_catchup
|
Booléen | 1 | Utilisation de la fonctionnalité de rattrapage pour absorber des broks en retard : | | Code Block |
|---|
webui__broks_getter__nb_late_set_allowed_before_catchup
|
Entier | 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 maintenant | | Code Block |
|---|
webui__broks_getter__catchup_broks_managed_by_module_in_a_catchup_loop
|
Entier | 200000 | Nombre maximal de broks que l'algorithme de rattrapage récupère avant de lancer le traitement Ce paramètre permet de borner la consommation mémoire et le temps d'exécution d'un tour de boucle de traitement | | Code Block |
|---|
webui__broks_getter__catchup_run_endless_until_nb_late_set_allowed_reached
|
Booléen | 1 | Après traitement des broks, si le nombre de brok set en retard est trop élevé, - 1 continuer le rattrapage et absorber des broks en retard (en restant sur la session critique, ou "avec le lock")
- 0 arrêter l'absorption de brok et libérer la session critique (rendre le lock)
| | Code Block |
|---|
webui__broks_getter__include_deserialisation_and_catchup_in_lock
|
Dans le cas ou vous voulez disposer d'un maximum de temps CPU pour traiter les broks en retard, vous pouvez inclure la phase 2 ( Récupération de broks en retard ) et Phase 3 ( Dé-sérialisation des broks ) dans la phase Critique ( Phase 4 )
La récupération des broks en retard, et la dé-sérialisation se font alors dans la session critique (Locké) pour
1 : Activer0 Désactiver |
Surcharge de la configuration
| Code Block |
|---|
|
#======== Extended configuration ========
# The line [OVERLOAD_FROM] /etc/shinken/_default/daemons/brokers/modules/webui.cfg must be present and must not be changed !
# You can overload value in the webui_cfg_overload.cfg.
[OVERLOAD_FROM] /etc/shinken/_default/daemons/brokers/modules/webui.cfg
[OVERLOAD_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg |
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| Code Block |
|---|
[OVERLOAD_FROM] |
| 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. |