Versions Compared

Old Version 15

changes.mady.by.user Soubrié Grégoire

Saved on

compared with

New Version 16

changes.mady.by.user Soubrié Grégoire

Saved on

Key

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

Table of Contents
stylenone

Concept

Cette page détaille les différentes options de configuration des modules de type webui__module_report_handler.

Configuration

Si aucun module de type webui__module_report_handler n'a été personnalisé,  la configuration se trouve dans le fichier :

  • /etc/shinken/modules/webui--module-report-handler.cfg

Un exemple de configuration se trouve également dans :

  • /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/webui__module_report_handler/webui--module-report-handler-example.cfg

Exemple de fichier de configuration

Code Block
languagejs
themeConfluence
# CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE )

#================================================================================
# webui--module-report-handler
#================================================================================
# Modules that can load this module:
# - WebUI
# This module is used to handle reports generation on WebUI.
#================================================================================

define module {

    # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────────────    MODULE IDENTITY    ───────────────────────────────────────────── │ #
    # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must be unique ]                                                                    [ MANDATORY ] ───
    # ───                                                                                                                 ───
    module_name                                         webui--module-report-handler

    # ─── Module type [ Do not edit ]                                                                       [ MANDATORY ] ───
    # ───                                                                                                                 ───
    module_type                                         webui__module_report_handler

    # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────    REPORT BUILDER PARAMETERS    ──────────────────────────────────────── │ #
    # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ────────────────────  ConnectivityPDF Reports  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── #

    # ─── This parameter definesActivates the externalPDF serverreports. addresses to use to generate reports.                                ───
    # ─── Here is the syntax : <Protocol>://<Hostname>:<Port>                                     ───
    # ─── This option will add the PDF generation feature ( button in the reporting form, via URL ).  ───
    # ─── For now, the managed protocol are : http / https     ───
    # ───       /!\ The background task required to generate PDFs will consume up to 700 MB, PER WebUI MODULE AND         ───
    # ───           PER broker--module-report-builder MODULE, even when not in use.  ───
    #                                 ───
    # ───       /!\ This feature is NOT SUPPORTED on CentOS / RedHat 7.                                                   ───
    # ───      ───
    #           Default : empty ( The WebUI will generate the report itself. )                                            ───
    # ───       Example : http://127.0.0.1:24100, http://192.168.1.220:24100                      ───
    #                    ───
    #                                                                                             ───
    #           Default : 0 => Disable     ───
    # webui__module_report_handler__report_builder__backends 

    # ─── Token used to authenticate on the broker--module-report-builder modules                                         ───
    # ─── Must be the token set in "broker__module_report_builder__token" option      ───
    #           ...     : 1      => Enable         ───
    # ─── of the broker--module-report-builder modules.                                                                   ───
    # ───       /!\ This token is used globally for all the backends defined above!                                       ───
    # ───       /!\ This means that all the Broker modules must have the same authentication token.                       ───
    #    ───
    # webui__module_report_handler__report_builder__pdf_reports__enable 0

 Default : [empty] # ────────────────────  Connectivity  ───────────────────────────────────────────────────────────────────────────────── #

    # ─── This parameter defines the external server addresses to use to generate reports.                                ───
    # ─── Here is the syntax : <Protocol>://<Hostname>:<Port>                      ───
    #                                   ───
    # ─── For now, the managed protocol are : http /   https                                                                 ───
    # webui__module_report_handler__report_builder__token 

    # ──────────────────────  Timeouts  ─────────────────────────────────────────────────────────────────────────────────── #

    # ─── How many seconds to consider a node does not answer.                                                            ───
    #                          ───
    #           Default : empty ( The WebUI will generate the report itself. )                                            ───
    # ───       Example : http://127.0.0.1:24100, http://192.168.1.220:24100      ───
    #           Default : 3 ( seconds )                    ───
    #                                                           ───
    # ───                                                     ───
    # webui__module_report_handler__report_builder__backends 

    # ─── Token used to authenticate on the broker--module-report-builder modules                                         ───
    # webui ─── Must be the token set in "broker__module_report_handler__report_builder__timeout 3

token" option     # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────────    STATISTICS    ──────────────────────────────────────────────── │ #
    # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Ranges definition for the check "Broker - $KEY$───
 - Module Visualisation UI# -─── Reportof Handler - Performance"the broker--module-report-builder modules.       ───
    # ───       Example:                                                ───
    # ───       /!\ This token is used globally for all the backends defined above!                                       ───
    # ───       /!\ This means that -all Reportsthe writtenBroker inmodules lessmust thanhave 5the secondssame will be classified in the first category.authentication token.                       ───
    # ───           - Those made in less than 10 seconds will be in the second.                                           ───
    # ───           - etc.                              ───
    #                                                              ───
    #                                                   ───
    #           Default : [empty]                                                  ───
    #           Default : 5,10,20,30,60,120,300,600 ( seconds )                   ───
    # ───                                   ───
    # ───                                                                         ───
    # webui__module_report_handler__report_builder__token 

    # ──────────────────────  Timeouts  ─────────────────────────────────────────────────────────────────────────────────── #

    # ─── How many seconds to consider a node does not answer.         ───
    # webui__module_report_handler__exec_stats_ranges     5,10,20,30,60,120,300,600

}

Détail des sections composant le fichier de configuration

Identification du module

Code Block
languagejs
themeConfluence
    # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────────────    MODULE IDENTITY    ───────────────────────────────────────────── │ #
    # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must be unique ]───
    #                                                                [ MANDATORY ] ───
    # ───                                             ───
    #           Default : 3 ( seconds )                                                ───
    module_name                               ───
    # ───     webui--module-report-handler

     # ─── Module type [ Do not edit ]                                                                       [ MANDATORY ] ───
    # ───                ───
    # webui__module_report_handler__report_builder__timeout 3

    # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────────    STATISTICS    ──────────────────────────────────────────────── │ #
    # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Ranges definition for the check "Broker - $KEY$ - Module Visualisation UI - Report Handler - Performance"       ───
    # ───       Example:                      ───
    module_type                                                                        ───
    #        webui__module_report_handler───           - Reports written in less than 5 seconds will be classified in the first category.                    ───
    # ───           - Those made in less than 10 seconds will be in the second.                                           ───
    # ───           - etc.                                                                                                ───
    #                                                                                                                     ───
    #           Default : 5,10,20,30,60,120,300,600 ( seconds )                                                           ───
    # ───                                                                                                                 ───
    # webui__module_report_handler__exec_stats_ranges     5,10,20,30,60,120,300,600

}

Détail des sections composant le fichier de configuration

Identification du module

Code Block
languagejs
themeConfluence
    # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────────────    MODULE IDENTITY    ───────────────────────────────────────────── │ #
    # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must be unique ]                                                                    [ MANDATORY ] ───
    # ───                                                                                                                 ───
    module_name                                         webui--module-report-handler

    # ─── Module type [ Do not edit ]                                                                       [ MANDATORY ] ───
    # ───                                                                                                                 ───
    module_type                                         webui__module_report_handler

Il est possible de définir plusieurs instances de module de type webui__module_report_handler dans une architecture Shinken.

  • Chaque instance devra avoir un nom unique.

Scroll Title
anchorparameter_cfg
title​
NomTypeUnitéDéfautDescription
No Format
module_name
Texte---webui--module-report-handler

Shinken conseille de choisir un nom en fonction de l'utilisation du module pour que la configuration soit simple à maintenir.

Doit être unique.

No Format
module_type 
Texte---webui__module_report_handlerNe peut être modifié.

Paramètres de génération de rapport

Génération des rapports PDF
Code Block
languagejs
themeConfluence
    # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────    REPORT BUILDER PARAMETERS    ──────────────────────────────────────── │ #
    # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ────────────────────  PDF Reports  ────────────────────────────────────────────────────────────────────────────────── #

    # ─── Activates the PDF reports.                                                                                      ───
    # ─── This option will add the PDF generation feature ( button in the reporting form, via URL ).                      ───
    # ───       /!\ The background task required to generate PDFs will consume up to 700 MB, PER WebUI MODULE AND         ───
    # ───           PER broker--module-report-builder MODULE, even when not in use.                                       ───
    # ───       /!\ This feature is NOT SUPPORTED on CentOS / RedHat 7.                                                   ───
    # ───                                                                                                                 ───
    #                                                                                                                     ───
    #           Default : 0 => Disable                                                                                    ───
    #           ...     : 1 => Enable                                                                                     ───
    # ───                                                                                                                 ───
    # webui__module_report_handler__report_builder__pdf_reports__enable 0
Scroll Title

Il est possible de définir plusieurs instances de module de type webui__module_report_handler dans une architecture Shinken.

Chaque instance devra avoir un nom unique.
Scroll Title
anchorparameter_cfg
title​
_nameNe peut être modifié
NomTypeUnitéDéfautDescription
No Format
webui__module
Texte---webui--module-report-handler

Shinken conseille de choisir un nom en fonction de l'utilisation du module pour que la configuration soit simple à maintenir.

Doit être unique.

No Format
module_type 
Texte---webui__module_report_handler
_report_handler__report_builder__pdf_reports__enable
Texte---

Cette option permet d'activer la fonctionnalité de génération de rapport PDF.

L'option sera alors disponible dans le sélecteur de format dans le formulaire de génération de rapport et la route API /reporting-pdf sera actif sur la WebUI.

Warning
La tâche en arrière-plan nécessaire à la génération des fichiers PDF consommera jusqu'à 700 Mo, par module WebUI ET par module broker-module-report-builder, même lorsqu'elle n'est pas utilisée.
Warning

Cette fonctionnalité n'est pas prise en charge sur CentOS / RedHat 7.

Connexion aux modules externes de génération des rapports
Code Block
languagejs
themeConfluence
    # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────    REPORT BUILDER PARAMETERS    ──────────────────────────────────────── │ #
    # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ────────────────────  Connectivity  ───────────────────────────────────────────────────────────────────────────────── #

    # ─── This parameter defines the external server addresses to use to generate reports.                                ───
    # ─── Here is the syntax : <Protocol>://<Hostname>:<Port>                                                             ───
    # ─── For now, the managed protocol are : http / https                                                                ───
    #                                                                                                                     ───
    #           Default : empty ( The WebUI will generate the report itself. )                                            ───
    # ───       Example : http://127.0.0.1:24100, http://192.168.1.220:24100                                              ───
    #                                                                                                                     ───
    # webui__module_report_handler__report_builder__backends

    # ─── Token used to authenticate on the broker--module-report-builder modules                                         ───
    # ─── Must be the token set in "broker__module_report_builder__token" option                                          ───
    # ─── of the broker--module-report-builder modules.                                                                   ───
    # ───       /!\ This token is used globally for all the backends defined above!                                       ───
    # ───       /!\ This means that all the Broker modules must have the same authentication token.                       ───
    #           Default : [empty]                                                                                         ───
    #                                                                                                                     ───
    # webui__module_report_handler__report_builder__token

    # ──────────────────────  Timeouts  ─────────────────────────────────────────────────────────────────────────────────── #

    # ─── How many seconds to consider a node does not answer.                                                            ───
    #                                                                                                                     ───
    #           Default : 3 ( seconds )                                                                                   ───
    # ───                                                                                                                 ───
    # webui__module_report_handler__report_builder__timeout 3
Scroll Title
anchorparameter_cfg
title​
NomTypeUnitéDéfautDescription
No Format
webui__module_report_handler__report_builder__backends
Texte---

Cette option permet de définir les paramètres d'accès  à une ( ou plusieurs ) ressources externes ( modules de type broker__module_report_builder  ) qui seront utilisées pour générer un rapport.

Voir la page Répartition de charge lors de la génération des rapports SLA depuis le module WebUI pour plus d'information.


Valeurs possibles :

  • Vide : Si aucune valeur n'est indiquée, le module générera lui-même les rapports.
  • URL : L'URL d'accès au module qui générera les rapports. Il est possible d'accéder à plusieurs modules en séparant les URLs par des virgules.
    • Exemple:  http://127.0.0.1:24100, https://192.168.1.220:24100
No Format
webui__module_report_handler__report_builder__token
Texte---

Cette option permet de définir un jeton ( token ) qui sera utilisé pour s'authentifier auprès des modules dont l'accès aura été configuré dans l'option webui__module_report_handler__report_builder__backends.

Warning

Cela signifie que tous les modules de Broker doivent avoir le même jeton d'authentification. 

No Format
webui__module_report_handler__report_builder__timeout
NombreSeconde3

Le nombre de secondes que le module attendra avant de considérer qu'un des modules dont l'accès  est défini dans l'option webui__module_report_handler__report_builder__backends ne répond pas.

Statistiques ( pour la supervision )

Code Block
languagejs
themeConfluence
     # ─── Ranges definition for the check "Broker - $KEY$ - Module Visualisation UI - Report Handler - Performance"       ───
    # ───       Example:                                                                                                  ───
    # ───           - Reports written in less than 5 seconds will be classified in the first category.                    ───
    # ───           - Those made in less than 10 seconds will be in the second.                                           ───
    # ───           - etc.                                                                                                ───
    #                                                                                                                     ───
    #           Default : 5,10,20,30,60,120,300,600 ( seconds )                                                           ───
    # ───                                                                                                                 ───
    # webui__module_report_handler__exec_stats_ranges     5,10,20,30,60,120,300,600
Scroll Title
anchorparameter_cfg
title​
NomTypeUnitéDéfautDescription
No Format
webui__module_report_handler__exec_stats_ranges
Liste de nombresSeconde5,10,20,30,60,120,300,600

Permet de définir des intervalles de temps dans lesquels seront regroupés les rapports qui ont été faits, en fonction de leur durée d'exécution, afin de les dénombrer.

Cela concernent tous les rapports effectués sur les dernières 24h glissantes.

Ces statistiques sont consultables dans le check Broker - $KEY$ - Module Report Builder - Performance
( voir la page Broker - $KEY$ - Module Visualisation UI - Report Handler - Performance ).