Broker - $KEY$ - Module Visualisation UI - Metrology Reader

Contexte

Le check Broker - $KEY$ - Module Visualisation UI - Metrology Reader affiche des statistiques concernant les métriques disponibles sur chaque serveur de métriques.

Il permet de vérifier que le module WebUI peut contacter les serveurs de métriques pour chacun des royaumes que la WebUI gère.

Pour chacun des serveurs graphite, le check va vérifier les points suivants :

• Est-ce que le module WebUI a accès au serveur graphite ?
• Combien d'hôtes sont hébergés sur le serveur ?
• Combien de métriques dispose le serveur ?
• Est-ce que le processus graphite fonctionne ?
• Est-ce que le serveur dispose d'assez d'espace disque ?
  
  

Paramétrage

Le check utilise la ligne de commande suivante :

$PLUGINSDIR$/check_shinken_broker_module_visualisation_ui_metrology_reader.py -H "$HOSTADDRESS$" -p "$ARG1$" -w "$ARG2$" --shinkenversion "$SHINKENVERSION$"  -P "$_HOSTSSH_PORT$" -i "$_HOSTSSH_KEY$" -u "$_HOSTSSH_USER$" -r "$_HOSTSSH_KEY_PASSPHRASE$" --timeout "$_HOSTCHECK_METROLOGY_READER_SHINKEN_TIMEOUT$"

Données utilisées provenant du modèle

Données communes pour les checks du modèle

Provenant du modèle shinken

Provenant du modèle shinken-broker-module-visualisation-ui

Données spécifiques pour ce check

Les données DFE ( Duplicate Foreach )

Données utilisées provenant du check

Pas de données spécifiques 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

Propriétés 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_METROLOGY_READER_SHINKEN_TIMEOUT
  • CHECK_SHINKEN_TIMEOUT
    
    

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

Les vérifications spécifiques

Résultat

Renvoi au format texte : 

• Si le serveur graphite fonctionne correctement
• et les statistiques des modules

Résultat Long

Rapport détaillé sur : 

• Accès du serveur graphite par le module WebUI
• Nombre d'hôtes sont hébergés sur le serveur
• Nombre de métriques dispose le serveur
• Fonctionnement du processus graphite
• Disponibilité de suffisamment d'espace disque pour le serveur

Description des erreurs

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

Si dans le graphite_backends d'une WebUI, une adresse utilise un port HTTP non valide, alors une erreur est remontée dans le check.

Par exemple, le graphite_backends suivant va remonter une erreur :

graphite_backends    *:127.0.0.1:80, Italie:192.168.1.26:80, Japon:127.0.0.1:invalid_port

Les métriques ne seront alors pas disponibles pour ce royaume.

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

Si dans la définition d'un Graphite backend d'un royaume, l'adresse (  ou l'IP   ) est manquante, alors une erreur est remontée.

Par exemple, le graphite_backends suivant va remonter une erreur :

graphite_backends    *:127.0.0.1:80, Italie::80, Japon:127.0.0.1:80

Les métriques ne seront alors pas disponibles pour ce royaume.

Un ou plusieurs royaumes n'ont pas de Graphite backend

Si dans la définition d'un graphite_backends, un ou plusieurs royaumes n'ont pas d'adresse définie, mais qu'ils sont quand même gérés par le Broker, alors une erreur sera remontée dans le check.

Par exemple, un Broker gère les royaumes suivants :  All, France, Italie, Japon

Maintenant, une des WebUI du Broker a le graphite_backends suivant :

graphite_backends    France:192.168.1.23:80

Alors, les royaumes "All, Italie et Japon" n'ont pas de Graphite backend défini par la WebUI, ce qui aura pour conséquence que les éléments de ces royaumes n'auront pas accès à leurs métriques.

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

Si la définition d'un Graphite backend utilise un protocole qui n'est pas valide, le check remonte une erreur pour le backend concerné.

Par exemple, le graphite_backends suivant va remonter une erreur :

graphite_backends    *:192.168.1.23:80, France:htt://192.168.1.23:80

Les métriques ne seront alors pas disponibles pour ce royaume.

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

Le check averti lorsqu'un royaume est présent dans la définition des graphite_backends de la WebUI et que celui-ci n'est pas géré par le Broker.

Par exemple, un Broker gère les royaumes :  All, France, Italie, Japon

Mais la définition d'une de ses WebUI est la suivante :

graphite_backends    *:127.0.0.1:80, Canada:192.168.1.44

Dans ce cas, le royaume Canada n'est pas géré par le Broker et sera donc ignoré.

Ce problème ne bloque pas le fonctionnement du module, il suffit juste d'enlever ou de corriger l'adresse de ce royaume dans la configuration de la WebUI pour enlever cet avertissement.

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