| Scroll Ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Description
Le module WebUI est un module qui permet au Broker de générer l'interface de visualisation.
- Il permet de visualiser en temps réel le détail ainsi que le bon fonctionnement des éléments supervisés par Shinken.
- Il est possible de modifier les paramètres (Langue de l'interface, port d'écoute) via le fichier de configuration ci-dessous.
| Warning |
|---|
Ce module est obligatoire pour pouvoir accéder à l'interface de visualisation. |
Activation du module
Le module WebUI est un module qui peut être activé seulement sur le démon Broker.
- L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du démon Broker.
- Pour ce faire, ouvrer le fichier de configuration du Broker à l'emplacement /etc/shinken/brokers/nom_du_broker.cfg, et ajouter le nom de votre module "
WebUI".
Exemple: par défaut, nous livrons un module dont le nom est "WebUI":
| Code Block | ||
|---|---|---|
| ||
define DEMON-TYPE {
[...]
modules Module 1, Module 2, Module 3, WebUI
[...]
} |
Pour prendre en compte le changement de configuration, redémarrer l'Arbiter:
| Code Block |
|---|
service shinken-arbiter restart |
Configuration
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.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 AUTH-SECRET-22316-4472-3256CHANGED 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 authentification # if 1: allow the user to be load from a HTTP Header remote_user_enable 10 # which HTTP header to get user name if remote_user_enable is 1 remote_user_variable X-ForwardedRemote-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 frLANG #======== 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 # - event-manager-reader : activate the event manager page to show event (do not forget to activate the module in your broker to write data) # - 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, event-manager-reader #======== Metrology access ========= # Multi-realm graphite parameter graphite_backends# The character * means all realm and *:127.0.0.1 # Before a graphite query is done, the graphite server is tested # Timeout for the alive timeoutsubrealms that the broker manage. If you want to specify only one realm you can replace * by the realm name. # default:For 10 (seconds) metrology__ping_timeout 10 multiple realms, add them separated by a comma # TimeoutEx. for: graphite_backends queries # default: 20 (seconds)France:127.0.0.1, Bordeaux:192.168.1.100, Paris:192.168.2.200 metrology__query_timeoutgraphite_backends 20*:127.0.0.1 # IfBefore a thegraphite testquery doesis faildone, the graphite server will be exclude during this timeis tested # toTimeout avoidfor tothe lock query for timeoutsalive timeout # default: 12010 (seconds) metrology__after_error_wait_before_retryping_timeout 12010 #======== Broks getter in WebUI ========= Timeout for graphite queries # Thesedefault: parameters allow some internal tuning in broks management in WebUI 20 (seconds) metrology__query_timeout 20 # EnableIf orthe disabletest latedoes broksfail, setsthe catchup graphite server will be # webui__broks_getter__activate_late_set_catchup exclude during this time # to avoid to lock query for timeouts # default: 120 (seconds) metrology__after_error_wait_before_retry 120 1 #======== Broks getter in WebUI ========= # TakeThese extraparameters broksallow setssome tointernal managetuning ifin morebroks thanmanagement thisin parameterWebUI sets are waiting # Enable or disable late broks sets catchup # webui__broks_getter__nbactivate_late_set_allowed_before_catchupcatchup 10 1 # Stop takingTake extra broks sets into catchupmanage whenif wemore reachthan this numberparameter sets ofare brokswaiting # webui__broks_getter__catchupnb_brokslate_managedset_byallowed_modulebefore_in_a_catchup_loop 200000 10 # ContinueStop taking extra broks sets in catchup ifwhen toowe muchreach latethis broksnumber setsof remains afterbroks # webui__broks_getter__catchup_runbroks_endlessmanaged_untilby_nbmodule_latein_seta_allowed_reachedcatchup_loop 1200000 # TakeContinue thecatchup lockif as 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_deserializationdeserialisation_and_catchup_in_lock 0 #======== Extended configuration ======== [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
Identification du module
Il est possible de définir plusieurs instances de module de type webui. 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. | ||
| 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 50100 |
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 les requêtes que 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
| 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.
| ||
| 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
| Code Block | ||
|---|---|---|
| ||
#======== Security =========
# auth_secret: secret key used to crypt cookie.
# note: must be the same as the configuration UI
auth_secret AUTH-SECRET-22316-4472-3256
# 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 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
# Maximum output length for plugin output, 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éés 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 | --- | 0 | Autorise les caratères HTML dans le retour des plugins de l'interface de visualisation | ||||||
| Booléan | --- | 1 | Gestion des droits des utilisateurs sur les actions de l'interface de visualisation :
| ||||||
| ||||||||||
| ||||||||||
| ||||||||||
|
Récupération des broks
| Anchor | ||||
|---|---|---|---|---|
|
| 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 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.
| 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 à 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 :
|
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