| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Concept
Cette page détaille les différentes options de configuration des modules de type webui__module_report_handler.
Activation du module
Le module webui--module-report-handler peut uniquement être activé sur un module de type webui.
L'activation du module d'effectue en ajoutant le nom de ce module dans le fichier de configuration du module WebUI/.
- Ouvrir le fichier de configuration du module WebUI ( exemple: /etc/shinken/modules/webui.cfg )
- trouver la ligne du paramètre "modules"
- et ajouter le nom du module "webui--module-report-handler"
La présence de ce module rend disponible la section Rapports dans le menu Les Synthèses de l'Interface de Visualisation.
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 | ||||
|---|---|---|---|---|
| ||||
# 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 ──────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ──────────────────── 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
# ─── How many second to consider statistics data transfer to be failed ───
# ───
# Default : 120 ( seconds ) ───
# ─── ───
# webui__module_report_handler__report_builder__data_timeout 120
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────────── STATISTICS ──────────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Ranges definition for the performance check ───
# ───
# 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 | ||||
|---|---|---|---|---|
| ||||
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────────── 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.
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| 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. | ||
| Texte | --- | webui__module_report_handler | Ne peut être modifié. |
Connexion aux modules externes de génération des rapports
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────── 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
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────────── STATISTICS ──────────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Ranges definition for the performance check ───
# ───
# 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
} |
| Nom | Type | Unité | Défaut | Commentaire | ||||
|---|---|---|---|---|---|---|---|---|
| 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 Partage de charge lors de la génération des rapports SLA depuis le module WebUI pour plus d'information. Valeurs possibles :
| |||||
| 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
| |||||
| Nombre | Seconde | 3 | 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 |
Statistiques ( pour la supervision )
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Liste de nombres | Seconde | 5,10,20,30,60,120,300,600 | Regroupe le nombre de rapports effectué sur les dernières 24h selon leur durée d'exécution, à des fins statistiques pour la supervision. |