Sommaire

Contexte

Le check Broker - $KEY$ - Module Visualisation UI va afficher l'état d'une WebUI ainsi que les dernières configurations qu'elle a reçues

Paramétrage

Le check utilise la ligne de commande suivante :

$PLUGINSDIR$/check_shinken_broker_module_visualisation_ui.py -H "$HOSTADDRESS$" -p "$ARG1$"  -w "$ARG2$" --shinkenversion "$SHINKENVERSION$" --timeout "$_HOSTCHECK_SHINKEN_TIMEOUT$" -n "$_HOSTNB_LINE_UNAVAILABILITY$"



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-broker-module-visualisation-ui


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.

Checks impactés :

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


Données spécifiques pour ce check

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

l'Hôte

( Onglet Données )

---55

Quantité de configurations présentent dans le résultat long.



Les données DFE ( Duplicate Foreach )

 

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

l'Hôte

( Onglet Données )

---broker-master-WebUI-webui$($_HOSTBROKER_PORT$)$$($_HOSTWEBUI_MODULE_NAME$)$broker-master-WebUI-webui$($_HOSTBROKER_PORT$)$$($_HOSTWEBUI_MODULE_NAME$)$

Nom de ou des Brokers à superviser ( séparés par une virgule ), leurs ports et le nom du module à superviser ( Ici la WebUI ), exemple "Broker-Master$(7772)$$(WebUI)$,Broker-Spare$(8772)$$(WebUI)$".

Check(s) impacté(s) :


Données utilisées provenant du check

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

Paramètre du check

  • Vu que le check est exécuté sur un Poller, il faut permettre à ce dernier d'accéder aux serveurs graphite en SSH.
    • D’où la nécessité de paramétrer les données SSH_KEY, SSH_KEY_PASSPHRASE, SSH_PORT, SSH_USER.
    • REMARQUE : il est obligatoire en l’état du check actuel que cette même clef soit autorisée sur tous les serveurs graphites surveillés.
  • Si un autre check Shinken a déjà été paramétré avec une clé SSH pour accéder au serveur graphite, il est bien sûr possible de reprendre cette même clé.

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

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

Le Graphite backend d'un royaume utilise un port non valide

CRITIQUE

Le Graphite backend d'un royaume utilise n'a pas d'adresse

CRITIQUE

Un ou plusieurs royaumes n'ont pas de Graphite backend

CRITIQUE

Le Graphite backend d'un royaume n'utilise pas un protocole valide

CRITIQUE

Un ou plusieurs royaumes n'est pas géré par le Broker

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

Renvoi au format texte : 

  • Si le module fonctionne correctement

Résultat Long

Ce check va afficher l'état d'une WebUI ainsi que les dernières configurations qu'elle a reçues

Pour chaque configuration qu'elle a reçue, il y a : 

  • La date de création de la configuration
  • Le nom de l'Arbiter ayant envoyé la configuration
  • Le nom de l'architecture 
  • UUID de la configuration
  • L'heure du début de l'indisponibilité de la WebUI
  • Parties de configuration de surveillance reçues
  • Le temps d'indisponibilité de la WebUI

Description des erreurs

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

Le broker n'a pas reçu de configuration

Métriques

NomUnitéDescription
nb_checks
---

Nombre de checks géré par la WebUI

nb_clusters
---

Nombre de clusters géré par la WebUI

nb_contacts
---

Nombre de contacts géré par la WebUI

nb_hosts
---

Nombre d'hôtes géré par la WebUI

unavailability_time_per_minute
minute

Le temps d'indisponibilités de la WebUI par minutes