| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
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 | ||||
|---|---|---|---|---|
| ||||
# 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 ──────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ──────────────────── PDF ConnectivityReports ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── #
# ─── This parameter definesActivates the external server addresses to use to generatePDF 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. ───
# ───
Default : [empty] # webui__module_report_handler__report_builder__pdf_reports__enable 0
# ──────────────────── 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 # ─── How many second to consider statistics data transfer to be failed ───
# ─── 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 Defaultmust :have 120the (same secondsauthentication )token. ───
# ─── ───
# ─── ───
# ───
# webui__module_report_handler__report_builder__data_timeout 120
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────────── STATISTICS ──────────────────────────────────────────────── │ #
# └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Ranges definition for the performance check ───
# 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 | ||||
|---|---|---|---|---|
| ||||
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ───────────────────────────────────────────── MODULE IDENTITY ───────────────────────────────────────────── │ # # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ─── Module name [ Must be unique ] ─── # Default : 3 ( seconds ) [ MANDATORY ] ─── # ─── ─── # ─── ─── module_name ─── # webui--__module-_report-handler_handler__report_builder__timeout 3 # ───┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ Module# type [ Do not# edit│ ]─────────────────────────────────────────────── STATISTICS ──────────────────────────────────────────────── │ # # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ─── Ranges definition for the check "Broker - $KEY$ - Module Visualisation UI - Report Handler - Performance" ─── # ─── Example: [ MANDATORY ] ─── # ─── ─── # ─── - Reports written in less than 5 seconds will be classified in the first category. ─── module_type# ─── - Those made in less than 10 seconds will be in the second. webui__module_report_handler |
Il est possible de définir plusieurs instances de module de type webui__module_report_handler dans une architecture Shinken.
| No Format |
|---|
module_name |
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 |
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. ─── # ─── - etc. ─── # ─── Here is the syntax : <Protocol>://<Hostname>:<Port> ─── # ─── For now, the managed protocol are : http / https ─── # Default : 5,10,20,30,60,120,300,600 ( seconds ) ─── # ─── # ─── ─── # Default : empty ( The WebUI will generate the report itself. ) ─── # ───webui__module_report_handler__exec_stats_ranges Example : http5,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 ]://127.0.0.1:24100, http://192.168.1.220:24100 ─── # [ MANDATORY ] ─── # ─── ─── # 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" optionname ───webui--module-report-handler # ─── ofModule the broker--module-report-builder modules. type [ Do not edit ] ─── # ─── [ MANDATORY ] ─── /!\ 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] ─── 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 | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
|
Paramètres de génération de rapport
Génération des rapports PDF
REMARQUE : l'activation du processus de génération de PDF nécessite l'activation d'un module qui consomme 700 MB de RAM, module de Webui ou par module de génération de rapport ( broker--module-report-builder ).
- Ce surtout est présent tant que la fonctionnalité est activée, même si aucun rapport n'est généré.
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ──────────────────────────────────────── REPORT BUILDER PARAMETERS ──────────────────────────────────────── │ # # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ──────────────────── PDF Reports ────────────────────────────────────────────────────────────────────────────────── # # ─── Activates the PDF reports. ─── # ─── # webui__module_report_handler__report_builder__token # ────────────────────── Timeouts ─────────────────────────────────────────────────────────────────────────────────── # # ─── How many seconds to consider a node does not answer. ─── # ─── # ─── 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 # ─── Default :# 3─── ( seconds ) PER broker--module-report-builder MODULE, even when not in use. ─── # ─── /!\ This feature is NOT SUPPORTED on CentOS / RedHat 7. ─── # ─── ─── # ─── ─── # webui__module_report_handler__report_builder__timeout 3 # ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ─────────────────────────────────────────────── STATISTICS ──────────────────────────────────────────────── │ # # └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ # ─── # ─── Ranges definition for the performance check ─── # ─── # Default : 0 => Disable ─── # Default : 5,10,20,30,60,120,300,600 ( seconds ) ─── # ... : 1 => Enable ─── # ─── ─── # ─── ─── # webui__module_report_handler__exec_stats_ranges 5,10,20,30,60,120,300,600 } |
─── # webui__module_report_handler__report_builder__pdf_reports__ |
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 :
- 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
enable 0 |
| Scroll Title | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Connexion aux modules externes de génération des rapports
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ──────────────────── 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 | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
Statistiques ( pour la supervision )
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ─── 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 ) ───
# ─── ───
# |
| No Format |
|---|
webui__module_report_handler__report_builder__token |
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. |
webui__module_report_handler__ |
exec_ |
stats_ranges 5,10,20,30,60,120,300,600 |
| Scroll Title | ||||
|---|---|---|---|---|
|
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.
|
|
|
|