Page History

Concept

Le module webui--module-report-handler permet au module WebUI ( l'interface de visualisation ) du Broker de générer des rapports ( voir la pageLes rapports ) ou de déporter leur gestion.

Ce module est disponible que depuis la version 02.08.02-RC018.

Auparavant, c'est le module WebUI qui générait les rapports.

À partir de la 02.08.02-RC018 et module webui--module-report-handler est indispensable pour la génération des rapports.

Activation du module

Par défaut, l’installation ou la mise à jour de Shinken Entreprise va mettre à disposition une définition du module de type webui__module_report_handler

• La configuration de ce module se trouve par défaut dans le fichier : /etc/shinken/modules/webui--module-report-handler.cfg
• Vérifier que le nom "webui--module-report-handler" est présent dans le paramètre modules du fichier : /etc/shinken/modules/webui.cfg.
  • Ce module est présent dans la liste des modules livrés par défaut.

  • S'il n'y est pas ( car modifié ), il est possible de le rajouter pour qu'il soit de nouveau actif.
    
    Exemple :
    

    Code Block
    language js theme Confluence
    define module { [...] module_name webui [...] modules Module 1, Module 2, Module 3, webui--module-report-handler [...] }

    
    

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

service shinken-arbiter restart

Définir des modules de type webui__module_report_handler

Définir plusieurs modules de type webui__module_report_handler permet d'avoir une configuration différente pour chaque module de type webui.

En fonction du besoin, il n'est pas nécessaire de créer plusieurs modules de type webui__module_report_handler.

Exemple :

• Les modules de type webui génèrent leurs rapports directement : Il vaut mieux définir un seul module de type webui__module_report_handler puis le déclarer dans tous les modules de type webui.
• Les modules de type webui dans des royaumes différents génèrent leurs rapports en passant par des modules externes : Il vaut mieux définir plusieurs modules de type webui__module_report_handler ( par royaume ) afin d'avoir des configurations adaptées pour chaque module de type webui ( voir la page Partage de charge lors de la génération des rapports SLA depuis le module WebUI ).

Pour configurer un module de type webui__module_report_handler, il faut commencer par choisir un nom à lui donner.

• Dans cet exemple, le module s'appellera "webui--module-report-handler--Mon-Module".

Des fichiers de configuration d'exemple sont fournis pour donner une configuration basique qui pourra être reprise pour créer de nouveaux modules.

Pour cela, il faut :

• Copier le fichier de définition du module d'exemple : /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/webui__module_report_handler/webui--module-report-handler-example.cfg dans le répertoire de définition des modules /etc/shinken/modules/ et modifier son nom pour lui donner le nom choisi.
  
  Exemple : /etc/shinken/modules/webui--module-report-handler--Mon-Module.cfg

  Code Block
  language text theme Emacs
  cp /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/webui__module_report_handler/webui--module-report-handler-example.cfg /etc/shinken/modules/webui--module-report-handler--Mon-Module.cfg

• Dans ce nouveau fichier, changer le nom du module :

  Code Block
  language js theme Confluence
  ... # ─── Module name [ Must be unique ] [ MANDATORY ] ─── # ─── ─── module_name                                         webui--module-report-handler--Mon-Module ...

• Une fois que le fichier a été édité, vérifier que le fichier possède comme droits utilisateurs shinken. Si ce n'est pas le cas, effectuez la commande suivante : 

  Code Block
  language text theme Emacs
  chown shinken:shinken /etc/shinken/modules/webui--module-report-handler--Mon-Module.cfg

• Redémarrez l'Arbiter pour que le Broker puisse prendre en compte ce nouveau module.

  Code Block
  language text theme Emacs
  service shinken-arbiter restart