Sommaire

Concepts

Pour accéder à cette interface, vous devez pointer votre navigateur Web vers l'adresse affichée durant l'installation.

  • Par défaut, l'interface de visualisation est accessible sur le port dédié 7767 ( via le protocole HTTP ). Par exemple : http://172.16.0.1:7767

Ce chapitre explique comment paramétrer l'interface de Visualisation.

  • Le fichier /etc/shinken/modules/webui.cfg contient les paramètres de configuration. ( voir la page Module WebUI )
  • Ce fichier contient la définition du module WebUI, module qui permet l'affichage de l'interface de visualisation.
  • Grace aux paramètres du module WebUI, vous pouvez paramétrer : 
    • le SSL et certificats
    • le port d'écoute 
    • le système SSO (Single Sign On)
    • l'activation des modules
    • la langue

SSL et certificats

L'interface de visualisation peut être protégée par un accès HTTPS et des certificats.

Les paramètres se trouvent dans le fichier /etc/shinken/modules/webui.cfg.


    # 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


Activation du HTTPS

  • Pour activer le HTTPS:
    • la propriété est use_ssl
      • par défaut la valeur est à 0 ( pas de HTTPS )
      • mettre la valeur à 1 pour l'activer


Certificats

  • Activez les certificats en mettant à jour les 2 paramètres suivant:
    • ssl_cert=/etc/shinken/certs/server.cert
    • ssl_key=/etc/shinken/certs/server.key


Les fichiers par défaut /etc/shinken/certs/server.cert et /etc/shinken/certs/server.key sont justes des exemples qui sont fournis avec l'installation, mais ces certificats ne sont pas approuvés et valides, vous DEVEZ les changer avec vos propres certificats..

L'accès à l'interface se fera toujours via le port dédié par défaut 7767 (mais via le protocole HTTPS).

Le port d'écoute

Le port de l'interface de visualisation peut être modifié.

Le paramètre se trouve dans le fichier /etc/shinken/modules/webui.cfg.

    #======== 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

Pour changer le port il suffit de modifier la valeur 7767 de la propriété port.

Il est également possible de n'écouter que les IP de la propriété host. ( par défaut, toutes les IP peuvent communiquer avec l'interface de visualisation ).


Paramétrage SSO

L'interface de visualization peut être accessible via SSO ( Single SignOn ).

Les paramètres se trouvent dans le fichier /etc/shinken/modules/webui.cfg.


    # Remote application authentification
    # 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

Un exemple de paramétrage est disponible sur cette page Synchronizer - Authentification unique ( SSO ).


Modules

Les modules qui seront chargés par le module Webui exposant l'UI de Visualisation sont listés via la propriété modules.

Dans le fichier /etc/shinken/modules/webui.cfg,

    #======== 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


Pour activer un module :

    • utilisez le paramètre modules,
    • la liste des modules disponibles sont écrits en commentaire dans le fichier ( Cfg_password, auth-active-directory, Mongodb... ).


Langues

La langue de l 'interface de visualisation peut être changée.

Le paramètre se trouve dans le fichier /etc/shinken/modules/webui.cfg.


    #======== Lang =========
    # Select the lang that will be used by default on the UIs
    # Currently managed:
    # -en    (english)
    # -fr    (francais)
    lang                                fr


Pour activer une langue :

    • utilisez le paramètre lang
    • A ce jour, 2 langues sont supportées: l'anglais ( en ) et le francais ( fr )

Il est souhaitable que la sortie des démons soient également définies dans la même langue.

Pour cela, dans le fichier /etc/shinken/shinken.cfg

  • il faut dé-commenter ou rajouter la ligne 
    • language=fr
    • A ce jour, 2 langues sont supportées: l'anglais ( en ) et le francais ( fr )

Gestion des cookies

Les cookies sont chiffrés par l'interface afin que les utilisateurs ne puissent pas les forger et récupérer le compte d'un autre utilisateur. Pour cela, il utilise la clé de chiffrement contenue dans le paramètre

auth_secret

auth_secret  AUTH-SECRET-_O9ZyyQS-6ba9U0_ftOA41WIwt08tMvUEivMlrUUBnE8yNXhvqB6BOzcxVAk4XZ3Ku9YBQD4-jUmvAWOJ8fSFDY43uID0F83b8sgERemlyE4QtUjHraPvyj6IpSAGQ2WKyBhaUY8jrkuEf_ny1_pYLeAuHW7a3BM_5qKpyEOhs9QMkjyYZ2S7EFcdWNpApkq8I41svgcoPxUA-fJG2Lb9pqQyLyNAQ3-8nzEirFwwX4aKaBkIz7Sizr5Ah0lBbiI


Ce paramètre est généré lors de l'installation et n'a pas à être modifié par les administrateurs.
Ce paramètre doit rester le même que sur le daemon synchronizer si l'interface de visualisation est située sur le même serveur.

Configurer l'affichage

Pour configurer les paramètres d'affichage, il faut modifier le fichier au chemin suivant de la configuration centrale :

/etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg

Un fichier d'exemple permet de connaître les clés et valeurs disponibles au chemin correspondant de shinken-user-example :

/etc/shinken-user-example/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg

( voir la page Surcharge des paramètres du module ( webui_cfg_overload.cfg ) )

Affichage des tuiles

Il est possible de définir comment les tuiles des portails vont être affichées, selon si le statut, le contexte, ou le duo statut/contexte, veulent être mis en avant à l'utilisateur.

Ce paramétrage n'agit en rien sur les statuts ou contextes de vos éléments en supervision, il s'agit ici uniquement de personnaliser leur affichage. Ce paramétrage est global, et affectera la visualisation de l'ensemble des utilisateurs et administrateurs de Shinken.

La propriété tiles_background accepte trois paramètres :

  • context, 
  • context_and_status,
  • status.

correspondant au 3 comportements décris ci-dessous.

Configuration par défaut "contexte avant tout" ( context )

  1. Si un contexte est défini :
    La couleur de fond est celui du context, violet pour Prise en compte ( Acknowledge ), gris foncé pour une période d’arrêt ( Downtime ), ...
    L'icône principale est celle du contexte, une icône complémentaire représentant le statut du tableau de bord est présent.


  2. Si aucun contexte n'est défini :
    Seule la couleur du statut est affiché (sur l'ensemble de la tuile).
    Et une seule icône centrale représente le statut du tableau de bord.

 

Configuration "contexte et statut" ( context_and_status )


  1. Si un contexte est défini :

    la couleur de fond de la tuile se divise en deux :

    • au dessus, la couleur du contexte violet pour Prise en compte ( Acknowledge ), gris foncé pour une période d’arrêt ( Downtime ), ...

    • en dessous, la couleur du statut ( rouge pour Critique, vert pour Ok, .... ).

    L'icône principale est celle du contexte, une icône complémentaire représentant le statut du tableau de bord est présent

  2. Si aucun contexte n'est défini :
    Seule la couleur du statut est affiché. (sur l'ensemble de la tuile)
    L’icône centrale représente le statut du tableau de bord, pas d'icône complémentaire.

 

Configuration "le statut avant tout" ( status )


  1. Si un contexte est défini :

    la couleur de fond est celui du statut ( rouge pour Critique, vert pour Ok, .... ).

    L'icône principale est celle du statut, une icône complémentaire représentant le contexte est présent

  2. Si aucun contexte n'est défini :
    Seul la couleur du statut est affiché. (sur l'ensemble de la tuile)
    L’icône centrale représente le statut du tableau de bord, pas d'icône complémentaire.

Choix des couleurs des graphiques

Il suffit de surcharger dans le fichier de surcharge de la configuration ( /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg ) la variable colors_graphics.

Vous pouvez rentrer autant de couleur que vous voulez il suffit de respecter les règles suivantes :

  1. mettre au format Hexadécimal (sans le #),
  2. séparer les couleurs par une virgule,
  3. ne pas mettre d'espace.

ex: colors_graphics=000000,000040,000080,0000FF,004000,004040,004080,008000,008040,008080,0080FF,00FF00,00FF80,00FFFF,400040,400080,800000,800040,800080,8000FF,804000,804000,804040,808000,808040,808080,8080C0,8080FF,80FF00,80FFFF,A0A0A0,A4C8F0,FF0000,FF0080,FF00FF,FF8000,FF8080,FF80C0,FF80FF,FFFF00,FFFF80

Paramétrage de l'onglet Historique/SLA

Dans l'onglet l'onglet Historique/SLA plusieurs éléments sont paramétrables dans le fichier : /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg

#==================================================================================
#======== history__nb_changes_displayed =========
                                                       # Number of changes displayed in change detail area of each days in History/SLA tab
                                                       # This number will be also used to display next changes went a user click on button "show more"
                                                       #
                                                       # Possible values ==> any positive integer
history__nb_changes_displayed=30

#======== history__size_sla_pane =========
                                                       # The default width of SLA column in History/SLA tab
                                                       # The width is define in px. If not set, the history column will be take 60% of the detail pane width
                                                       #
                                                       # Possible values ==> any positive integer
#history__size_sla_pane=250

#======== history__default_display_outputs =========
                                                       # The default status of the output display on the History/SLA tab for all new users (it still editable in UI)
                                                       #
                                                       # Possible values ==>
                                                       #      - 1 -> outputs will be display
                                                       #      - 0 -> outputs will be hidden
history__default_display_outputs=1

#======== history__default_collapse_outputs =========
                                                       # The default state of outputs folding in History/SLA tab for all new users (it still editable in UI)
                                                       #
                                                       # Possible values ==>
                                                       #      - 1 -> outputs will be fold
                                                       #      - 0 -> outputs will be unfold
history__default_collapse_outputs=0
#==================================================================================


Voici les éléments paramétrables : 

CléÉlément visuel impacté
history__nb_changes_displayedNombre des changements affichés pour chaque journée ( pour éviter le fait que les pages soient trop lourdes à l'ouverture. L'utilisateur pourra toujours en voir plus sur une journée, en utilisant le bouton approprié )
history__size_sla_paneTaille de la colonne SLA en pixel par défaut, lorsque les deux colonnes sont affichées.
history__default_display_outputsPermet de définir si par défaut le résultat et résultat long de chaque changement d'état est affiché.
(warning) Ce paramètre est un paramètre d’initialisation pour les nouveaux utilisateurs. Cette valeur peut être changer par chaque utilisateur quand celui-ci cliquer sur le bouton d'affichage ou cacher tous les résultats sur l'interface de visualisation.
history__default_collapse_outputsPermet de définir si par défaut les résultats sont affichés réduire ou d'étendre pour chaque changement.
(warning) Ce paramètre est un paramètre d’initialisation pour les nouveaux utilisateurs. Cette valeur peut être changer par chaque utilisateur quand celui-ci cliquer sur le bouton de réduire ou d'étendre tous les résultats sur l'interface de visualisation.

Paramétrage des notifications de changements

Valeur par défaut des vues

Vous pouvez changer la valeur des valeurs par défaut utilisées par les vues : 

Valeur par défaut des utilisateurs

Vous pouvez changer la valeur des valeurs par défaut utilisées par les utilisateurs ( voir la page Configuration du module WebUI ).

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 ).