Sommaire

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

NomModifiable surUnitéDéfaut

Valeur par défaut

à l'installation de Shinken

Description
CHECK_SHINKEN_TIMEOUT

l'Hôte

( Onglet Données )

seconde

33

Temps maximum durant lequel le check va attendre une réponse du démon.

​

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

NomModifiable sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
BROKER_PORT

l'Hôte

( Onglet Données )

---7772 7772

Configuration du port de communication avec le Broker.

Modèles définissant cette donnée : 

Note : Cette valeur remplacera la valeur $ARG1$ dans la commande


​

NomModifiable sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
WEBUI_MODULE_NAME

Modèle d'hôte

( Onglet Données )

---
WebUI
 WebUI

Configuration du nom du module de l'Interface de Visualisation qui porte le module à superviser.


REPORT_HANDLER_MODULE_NAME

Modèle d'hôte

( Onglet Données )

---webui--module-report-handler webui--module-report-handler

Configuration du nom du module à superviser.


​



Données spécifiques pour ce check

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

Les données DFE ( Duplicate Foreach )

 

NomModifiable sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
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$)$

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

$($_HOSTWEBUI_MODULE_NAME$)$

$($_HOSTREPORT_HANDLER_MODULE_NAME$)$

Liste de modules de type webui__module_report_handler à superviser sur le Broker ( donc doit correspondre aux nombres de Webui présentent sur le Broker ).

Check(s) impacté(s) :

​




Données utilisées provenant du check

 Pas de données provenant du check pour ce check.

Données globales

Nom

Modifiable sur

Unité

Défaut

Valeur par défaut à l'installation de Shinken

Description

PLUGINSDIR

Non modifiable

( Sauf Admin Shinken )

---/var/lib/shinken/libexec/var/lib/shinken/libexec

Chemin absolu du dossier contenant la sonde ( non modifiable ).

SHINKENVERSION

Non modifiable

---------

Numéro de version du shinken utilisé pour la comparaison avec le shinken surveillé.

​

Propriétés de l'hôte

NomModifiable surUnitéDéfautValeur par défaut à l'installation de ShinkenDescription
HOSTADDRESS

l'Hôte

( Onglet Général )

---

Nom de l'hôteNom de l'hôte

Adresse 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

Situation

Statut

Un des modules donné en paramètre ( Interface de visualisation ou module de gestion des rapports ) n'a pas été trouvé.

CRITIQUE

Aucun des modules de génération des rapports configurés ne peut être joint.

CRITIQUE

Un des modules de génération des rapports utilisé est mal configuré.

CRITIQUE

Certains modules de génération des rapports configurés ne peuvent être joints. 

ATTENTION

Le Broker est en cours d'arrêt.

ATTENTION

Si la sonde n'a pas eu de réponse avant le temps maximum :

  • Si supérieur à CHECK_SHINKEN_TIMEOUT (  par défaut : 3 sec )
INCONNU

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

NomUnitéDescription
nb_pending_requests_on_webui
---

Nombre de demandes de rapport en attente.

pending_requests_wait_time_on_webui
seconde

Durée depuis laquelle la plus ancienne des demandes de rapports à générer est enregistrée dans la liste d'attente d'envoi aux modules de génération des rapports.

average_pending_requests_wait_time_on_webui_in_last_24h
seconde

Durée moyenne, sur les dernières 24 heures, que les demandes de rapports passent dans la file d'attente avant d'être traitée.

total_nb_pending_reports_on_builders
---

Nombre de demandes de rapport en attente sur les différents modules de génération.

total_nb_done_reports_in_last_24h
---

Nombre de rapports générés sur les dernières 24 heures.

total_nb_done_reports_in_last_minute
---

Nombre de rapports générés sur la dernière minute.

older_pending_report_wait_time_on_builders
seconde

Durée depuis laquelle la plus ancienne des demandes de rapports à générer est enregistrée dans la liste d'attente d'un des modules de génération des rapports.

average_report_generation_time_in_last_24h
seconde

Moyenne des durées de génération des rapports sur les dernières 24 heures.

average_work_load_on_builders
%

Occupation moyenne des modules de génération des rapports sur une minute.

work_load_on_webui_in_last_minute
%

Occupation moyenne du module de gestion des rapports, sur la dernière minute, quand il n'y a pas de module de génération des rapports configurés.

​

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 ).

NomUnitéDescription
reports_per_generation_time_X_Y_s
reports_per_generation_time_X_s_and_more
---

Ces métriques représentent la répartition du temps de génération de rapports. Le nombre de métriques générées va dépendre de la configuration du module, comme expliqué dans l'onglet Résultat Long.

  • X est un entier positif, définissant le début d'un intervalle de temps.
  • Y est un entier positif, définissant la fin de l'intervalle de temps.
  • _s définit l'unité ( seconde ).
  • _and_more définit un intervalle comprenant toutes les valeurs supérieures à X.
​

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 :

NomUnitéDescription
reports_per_generation_time_0_90_s
---

Nombre de rapports dont la génération a pris moins de 90 secondes.

reports_per_generation_time_90_180_s
---

Nombre de rapports dont la génération a pris entre 90 secondes et 180 secondes.

reports_per_generation_time_180_240_s
---

Nombre de rapports dont la génération a pris entre 180 secondes et 240 secondes.

reports_per_generation_time_240_s_and_more
---

Nombre de rapports dont la génération a pris plus de 240 secondes.

​