Page History

Concept

Le check Broker - $KEY$ - Module Visualisation UI - Report Handler - Performance permet de suivre l'utilisation qui est faite du module webui--module-report-handler ( voir la page Module webui--module-report-handler ) au niveau de l'Interface de Visualisation ( voir la page Module WebUI ) du démon Broker ( voir la page Le Broker ).

Paramétrage

Le check utilise la ligne de commande suivante :

$PLUGINSDIR$/check_shinken_broker_module_visualisation_ui_report_handler.py -H "$HOSTADDRESS$" -p "$ARG1$" -w "$ARG2$" -r "$ARG3$" -m "$ARG4$" --timeout "$_HOSTCHECK_SHINKEN_TIMEOUT$" --shinkenversion "$SHINKENVERSION$"

Données utilisées provenant du modèle

Données communes pour les checks du modèle

Provenant du modèle shinken

Données spécifiques pour ce check

Provenant du modèle shinken-by-API__broker__module-visualisation-ui__report-handler

Données spécifiques pour ce check

Pas de données spécifiques pour ce check.

Les données DFE ( Duplicate Les données DFE ( Duplicate Foreach )

MODULE_UI_REPORT_HANDLER_LIST

l'Hôte

( Onglet Données )

broker-master-WebUI-webui--module-report-handler$($_HOSTBROKER_PORT$)$

$($_HOSTWEBUI_MODULE_NAME$)$

$($_HOSTREPORT_HANDLER_MODULE_NAME$)$

$($_HOSTWEBUI_MODULE_NAME$)$

$($_HOSTREPORT_HANDLER_MODULE_NAME$)$

Données utilisées provenant du check

Données globales

Propriétés de l'hôte

Résultat

Exemple

Sans module de génération des rapports

Avec des modules de génération des rapports

Interprétation

Statut

Il peut prendre les valeurs  OK / CRITIQUE  / ATTENTION  /  INCONNU .

• Le statut va dépendre du retour de sonde et de la configuration spécifique du check pour les données suivantes :
  • CHECK_SHINKEN_TIMEOUT
    
    

• Voici un tableau récapitulatif du statut attendu suivant le retour de sonde :

Les vérifications spécifiques

Résultat

Sans module de génération des rapports

Le check affiche dans son résultat court :

Un texte indiquant si le module fonctionne correctement.

Un tableau affichant un résumé statistique de fonctionnement contenant :

• L'occupation du module sur la dernière minute ;
• Le nombre de rapports en attente de génération ;
  • Le temps d'attente moyen, sur les dernières 24 heures, avant de commencer la génération d'un rapport ;
• Le nombre de rapports générés sur les dernières 24 heures ;
  •  Le temps moyen passé pour générer un rapport ;
    
    

Avec des modules de génération des rapports

Le check affiche dans son résultat court :

Un texte précisant : 

• Si le module fonctionne correctement ;
• La date de dernière mise à jour des statistiques des modules de génération des rapports ;
• Le temps passé pour récupérer les statistiques des modules de génération des rapports ;
  
  

Un tableau affichant un résumé statistique de fonctionnement contenant :

• Sur le module de gestion des rapports :
  • Le nombre de demandes de rapports en attente, non envoyées à un module de génération des rapports
  • La durée moyenne, sur les dernières 24 heures, que les demandes de rapports ont passées en file d'attente avant d'être envoyées à un module de génération des rapports.
• Sur les modules de génération des rapports :
  • Le nombre de demandes en attente sur les modules de génération des rapports ;
  • Le nombre de rapports générés sur les dernières 24 heures,
    • La durée moyenne des générations des rapports
  • L'occupation moyenne  

Un tableau affichant des informations sur les modules de génération des rapports ( un par ligne )  :

• Le Broker sur lequel se trouve le module de génération des rapports ;
• Le nom du module de génération des rapports ;
• L'URL d'accès au module de génération des rapports ;
• Des informations sur les demandes de génération de rapport en attente de traitement :
  • Le nombre actuellement en attente ;
  • Le temps d'attente moyen sur les dernières 24 heures ;
• Des informations sur les rapports générés sur les dernières 24 heures :
  • Leur nombre ;
  • La durée moyenne des générations de rapport ;
• L'occupation du module sur la dernière minute.
  
  

Résultat Long

Sans module de génération des rapports

Ce check va afficher deux tableaux dans le résultat long :

• un top 5 des demandes de rapports,
• un récapitulatif des durées de génération des rapports sur les dernières 24 heures.

Le top 5 des demandes va indiquer :

• l'utilisateur à l'initiative de la demande de rapport,
• le format demandé ( WEB ou CSV ),
• le type de rapport demandé ( History, SLA ou History & SLA ),
• la requête de filtrage,
• l'intervalle de recherche,
• le nombre d'éléments trouvés,
• le temps d'attente (  entre l'heure de la demande et le début effectif de la génération  ),
• le temps de génération du rapport,
• la date de génération du rapport.
  
  

Le récapitulatif des durées de génération des rapports va regrouper les temps mis pour créer les rapports selon les intervalles définis dans la configuration du module ( voir la page Configuration du module webui--module-report-handler  ) pour les dénombrer.

Avec des modules de génération des rapports

Ce check va afficher, dans le résultat long, un tableau contenant un top 5 des demandes de rapports, en précisant :

• l'utilisateur à l'initiative de la demande de rapport,
• le format demandé ( WEB ou CSV ),
• le type de rapport demandé ( History, SLA ou History & SLA ),
• la requête de filtrage,
• l'intervalle de recherche,
• le nombre d'éléments trouvés,
• le temps d'attente (  entre l'heure de la demande et le début effectif de la génération  ),
• le temps de génération du rapport,
• la date de génération du rapport.
  
  

Description des erreurs

Le module n'a pas été trouvé sur le Broker

Lorsqu'il est impossible de trouver un module nommé dans les paramètres du check, le check le remonte comme une erreur :

Aucun des modules de génération des rapports n'est accessible

Un des modules de rapport a une configuration incorrecte

Certains modules de génération des rapports sont inaccessibles

Le Broker est en cours d'arrêt

Lorsque le Broker est en cours d'arrêt, le check le signale, et les informations relatives au module ne sont plus disponibles

Métriques

Sans module de génération des rapports

Si le module n'utilise pas de module de génération des rapports, il génère lui-même les rapports, les métriques suivantes sont alors également disponibles ( telles que définies dans sa configuration, voir la page Configuration du module webui--module-report-handler ).

reports_per_generation_time_X_Y_s

reports_per_generation_time_X_s_and_more

Exemple

Avec la configuration suivante pour le module :

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

    # ─── Ranges definition for the performance check                                                                     ───
    #                                                                                                                     ───
    #           Default : 5,10,20,30,60,120,300,600 ( seconds )                                                           ───
    # ───                                                                                                                 ───
    webui__module_report_handler__exec_stats_ranges     90, 180, 240

Les métriques suivantes seront générées :

reports_per_generation_time_0_90_s

reports_per_generation_time_90_180_s

reports_per_generation_time_180_240_s

reports_per_generation_time_240_s_and_more