Contexte

Le check Broker - $KEY$ - Module Visualisation UI - Report Handler - Running Well permet de contrôler le bon fonctionnement 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

Données spécifiques pour ce check

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

Modèle d'hôte

( Onglet Données )

---7772 7772

Configuration du port de communication avec le Broker.

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-handlerwebui--module-report-handler

Configuration du nom du module à superviser.

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 à superviser sur le Broker


Données utilisées provenant du check

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

Données globales

Propriétés de l'hôte

Résultat

Exemple

Le module gère lui même la génération des rapports

Pas de rapport en cours de génération

Un rapport est en cours de génération

Le module délègue la génération des rapports

Pas de rapport en cours de génération

Un rapport est en cours de génération

Interprétation

Statut

Il peut prendre deux 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

Le Broker est en cours d'arrêt

ATTENTION

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

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

Renvoi : 

  • Si le module fonctionne correctement
  • un tableau récapitulatif sur le rapport en cours génération ( s'il y en a un )

Résultat Long

Ce check va afficher la liste des modules de génération des rapports et leur disponibilité.

Pour chaque module, les informations suivantes sont présentées : 

  • Le Broker qui porte le module de génération des rapports
  • Le nom du module
  • L'URL d'accès au module
  • L'accessibilité du module ( si le module de gestion des rapports peut s'y connecter )
  • La disponibilité du module ( s'il est déjà en train de générer un rapport ou pas )
  • Les messages remontés par le module


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

Le jeton configuré est incorrect

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

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

Métriques

NomUnitéDescription
nb_report_builder_total
---

Nombre de modules de génération des rapports configurés.

nb_report_builder_idle
---

Nombre de modules de génération des rapports disponibles ( en attente, prêt à traiter des requêtes )

nb_report_builder_busy
---

Nombre de modules de génération des rapports occupés ( en train de générer des rapports )

nb_report_builder_unreachable
---

Nombre de modules de génération des rapports inaccessibles