Sommaire

Description

Le fichier webui_cfg_overload.cfg permettra de modifier des comportements sur tous les modules WebUI ( qui implémente ce fichier -  voir le chapitre surcharge de la configuration de la page Configuration du module WebUI

De plus, les fichiers de configuration des paramètres du module Webui peuvent être modifiés par des commandes d'installation de Shinken.

Il est donc préférable d'ajuster les paramètres nécessaires dans ce fichier.

Les paramètres définis dans ce fichier vont écraser ( seront prioritaires ) sur ceux dans les fichiers de configuration des modules WebUI.

Pour plus de détails sur les paramètres, référez-vous à la page suivante : Configuration du module WebUI


Adresse par défaut du ficher : /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg


Exemple : Surcharge de la configuration de l'interface Web

    # ─────────────────────────────────────────────────────────────────────────────────────────────────────── #
    # This comment is used by Shinken to recognize this file, please do not edit or remove it.
    # If done so, several parts of Shinken, like sanitize, may not work properly.
    # __OVERRIDE_TYPE__ webui_cfg_overload
    # ─────────────────────────────────────────────────────────────────────────────────────────────────────── #

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────    HIVE    ──────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ────────────────  default grid layout  ──────────────────────────────────────────────────────────────── #

    # ─── default_tiles_format                                                                              ───
    # ─── Describe how the tiles are displayed in the hive                                                  ───
    #                                                                                                       ───
    #           ...     : context_and_status => Tile color is split by status and context when there is one ───
    #           ...     : status => Tile color matches the status, context displayed  by a secondary icon   ───
    #           Default : context => Tile color matches the context if one, else matches the status         ───
    # ───                                                                                                   ───
    tiles_background                                    context_and_status

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────    PAGE DETAIL    ──────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ──────────────────────  Graphics  ───────────────────────────────────────────────────────────────────── #

    # ─── Colors for graphics                                                                               ───
    # ─── Give the list of color format hexadecimal (without the #) separate by comma                       ───
    #                                                                                                       ───
    #           ...     : X => infinite number of any existing color                                        ───
    # ───                                                                                                   ───
    colors_graphics                                     6cc4b9,4485aa,314293,329347,72a82c,ef7c14,d82e2e,931616,FF00FF,000000

    # ──────────────────────  Historic  ───────────────────────────────────────────────────────────────────── #

    # ─── history__nb_changes_displayed                                                                     ───
    # ─── Number of changes displayed in change detail area of each days in History/SLA tab                 ───
    # ─── in History/SLA tab                                                                                ───
    # ─── This number will be also used to display next changes went                                        ───
    # ─── a user click on button "show more"                                                                ───
    #                                                                                                       ───
    #           ...     : X => 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                                                              ───
    #                                                                                                       ───
    #           ...     : X => 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)                                                   ───
    #                                                                                                       ───
    #           ...     : 0 => outputs will be hidden                                                       ───
    #           Default : 1 => outputs will be display                                                      ───
    # ───                                                                                                   ───
    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)                                                   ───
    #                                                                                                       ───
    #           ...     : 1 => outputs will be fold                                                         ───
    #           Default : 0 => outputs will be unfold                                                       ───
    # ───                                                                                                   ───
    history__default_collapse_outputs                   0

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────────    REPORTS    ────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Synthesis                                                                                         ───
    # ─── These parameters are used to configure the Synthesis (or "Wall") menu.                            ───
    #                                                                                                       ───
    #           ...     : 0 => disabled                                                                     ───
    #           Default : 1 => enabled                                                                      ───
    # ───                                                                                                   ───
    broker__module_webui__synthesis__report__enable     1

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────    LOGS    ──────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Webui Authentication External Log                                                                 ───
    # ─── Log the webui authentication history in a file                                                    ───
    #                                                                                                       ───
    #           ...     : 1 => enabled                                                                      ───
    #           Default : 0 => disabled                                                                     ───
    # ───                                                                                                   ───
    broker__module_webui__log_users__enabled            0

    # ─── File use for log authentication history                                                           ───
    # ───                                                                                                   ───
    broker__module_webui__log_users__file_path          /var/log/shinken/webui/log_users.log

    # ─── Add user name to log                                                                              ───
    #                                                                                                       ───
    #           ...     : 1 => enabled                                                                      ───
    #           Default : 0 => disabled                                                                     ───
    # ───                                                                                                   ───
    broker__module_webui__log_users__add_user_name      0

    # ─── The log files will be rotated daily, up to the number of days configured.                         ───
    # ─── All log files older than the configured number of days will be deleted automatically.             ───
    #                                                                                                       ───
    #           Default : 7 (days)                                                                          ───
    # ───                                                                                                   ───
    broker__module_webui__log_users__logs_rotation__nb_days_before_deletion 7

      
        
          

Détails des sections composant le fichier de configuration

Portail

Affichage des tuiles

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────    HIVE    ──────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ────────────────  default grid layout  ──────────────────────────────────────────────────────────────── #

    # ─── default_tiles_format                                                                              ───
    # ─── Describe how the tiles are displayed in the hive                                                  ───
    #                                                                                                       ───
    #           ...     : context_and_status => Tile color is split by status and context when there is one ───
    #           ...     : status => Tile color matches the status, context displayed  by a secondary icon   ───
    #           Default : context => Tile color matches the context if one, else matches the status         ───
    # ───                                                                                                   ───
    tiles_background                context_and_status


     
NomTypeUnitéDéfautCommentaire
tiles_background
Texte--- context_and_status

Modifie l'affichage des tuiles du portail

  • context  :  S'il y a un contexte, la tuile à la couleur du contexte, sinon la couleur du statut.
  • statut :  la tuile a toujours la couleur du statut.
  • context_and_status : le tuile a un double affichage ( moitié statut et moitié contexte ).

( voir la page  Paramétrage de l'interface de Visualisation )


Page détail

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────    PAGE DETAIL    ──────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ──────────────────────  Graphics  ───────────────────────────────────────────────────────────────────── #

    # ─── Colors for graphics                                                                               ───
    # ─── Give the list of color format hexadecimal (without the #) separate by comma                       ───
    #                                                                                                       ───
    #           ...     : X => infinite number of any existing color                                        ───
    # ───                                                                                                   ───
    colors_graphics                 6cc4b9,4485aa,314293,329347,72a82c,ef7c14,d82e2e,931616,FF00FF,000000

    # ──────────────────────  Historic  ───────────────────────────────────────────────────────────────────── #

    # ─── history__nb_changes_displayed                                                                     ───
    # ─── Number of changes displayed in change detail area of each days in History/SLA tab                 ───
    # ─── in History/SLA tab                                                                                ───
    # ─── This number will be also used to display next changes went                                        ───
    # ─── a user click on button "show more"                                                                ───
    #                                                                                                       ───
    #           ...     : X => 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                                                              ───
    #                                                                                                       ───
    #           ...     : X => 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)                                                   ───
    #                                                                                                       ───
    #           ...     : 0 => outputs will be hidden                                                       ───
    #           Default : 1 => outputs will be display                                                      ───
    # ───                                                                                                   ───
    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)                                                   ───
    #                                                                                                       ───
    #           ...     : 1 => outputs will be fold                                                         ───
    #           Default : 0 => outputs will be unfold                                                       ───
    # ───                                                                                                   ───
    history__default_collapse_outputs 0         

L'onglet Graphiques

NomTypeUnitéDéfautCommentaire
colors_graphics
Texte--- 6cc4b9,4485aa,314293,329347,72a82c,ef7c14,d82e2e,931616,FF00FF,000000s

Choix des couleurs des graphiques

( voir la page  Paramétrage de l'interface de Visualisation )

L'onglet Historique/SLA

NomTypeUnitéDéfautCommentaire
history__nb_changes_displayed
Entier--- 30

Limite le nombre d'entrées ( changements ) pour chaque journée dans l'onglet Historique/SLA ( permet d'é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é "Voir Plus" )

( voir la page  Paramétrage de l'interface de Visualisation )

history__size_sla_pane
Entier--- 250

Taille de la colonne SLA en pixel par défaut, lorsque les deux colonnes sont affichées

( voir la page  Paramétrage de l'interface de Visualisation )

history__default_display_outputs
Entier--- 1

Permet de définir si par défaut le résultat et le résultat long de chaque changement d'état sont affichés.

  • 0  : Caché
  • 1  : Visible

(warning) Ce paramètre est un paramètre d’initialisation pour les nouveaux utilisateurs. Cette valeur peut être changée par chaque utilisateur quand celui-ci clique sur le bouton d'affichage ou cache tous les résultats sur l'interface de visualisation.

( voir la page  Paramétrage de l'interface de Visualisation )

history__default_collapse_outputs
Entier--- 0

Permet de définir si par défaut les résultats sont affichés en réduit ou en totalité.

  • 0  : affichage total
  • 1  : affichage réduit


(warning) Ce paramètre est un paramètre d’initialisation pour les nouveaux utilisateurs. Cette valeur peut être changée par chaque utilisateur quand celui-ci clique sur le bouton de réduire ou d'étendre  tous les résultats sur l'interface de visualisation.

( voir la page  Paramétrage de l'interface de Visualisation )

Propriétés expliquées dans la page "Configuration du module WebUI"

Pour toutes les propriétés suivantes, l'explication est dans la page Configuration du module WebUI

Nom


 broker__module_webui__synthesis__report__enable     
broker__module_webui__log_users__enabled
broker__module_webui__log_users__file_path
broker__module_webui__log_users__add_user_name
broker__module_webui__log_users__logs_rotation__nb_days_before_deletion