Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=same_as_next_version
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse
Panel
titleSommaire

Table of Contents
stylenone

Description

Explication

Le module WebUI est un module qui permet au Broker de générer l'interface de visualisation. Il

  • 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.
Configuration


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.

Le module WebUI a besoin de se connecter à une base MongoDB pour stocker les portails, tableaux de bords et favoris des utilisateurs. Le paramétrage pour la connexion à cette base Mongo est décrit dans la page du Module MongoDB

Voici le fichier CFG de configuration présent dans : 
  • 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":modules/webui.cfg

Code Block
languagejsbash
themeConfluence
define DEMON-TYPE {
    [...]
    modules#===============================================================================
# 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                 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



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



    #======== 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 =========
    # Multi-realm graphite parameter
    graphite_backends         *:127.0.0.1

    #======== Metrology access =========
    # Multi-realm graphite parameter
    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

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

}
Module 2, Module 3, WebUI 
    [...]
}


Pour prendre en compte le changement de configuration, redémarrer l'Arbiter:

Code Block
languagetext
themeEmacs
service shinken-arbiter restart