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
| Nom | Modifiable sur | Unité | Défaut | Valeur par défaut à l'installation de Shinken | Description |
|---|---|---|---|---|---|
CHECK_SHINKEN_TIMEOUT | l'Hôte ( Onglet Données ) | seconde | 3 | 3 | Temps maximum durant lequel le check va attendre une réponse du démon. |
Provenant du modèle shinken-broker-module-visualisation-ui
Nom Modifiable sur Unité Défaut Valeur par défaut à l'installation de Shinken Description l'Hôte ( Onglet Données ) Chemin vers la clé ssh de l'utilisateur shinken, sur le serveur hébergeant le Poller qui exécutera le check. Modèles définissant cette donnée : l'Hôte ( Onglet Données ) $SSH_KEY_PASSPHRASE$ $SSH_KEY_PASSPHRASE$ Phrase secrète utilisée pour déverrouiller la clé privée de l'utilisateur ( si celle-ci est protégée par une passphrase ). La clé privée déverrouillée est ensuite utilisée pour authentifier l'utilisateur. Modèles définissant cette donnée : similaire que SSH_KEY l'Hôte ( Onglet Données ) $SSH_PORT$ $SSH_PORT$ Port de connexion SSH. Modèles définissant cette donnée : similaire que SSH_KEY l'Hôte ( Onglet Données ) $SSH_USER$ $SSH_USER$ Nom de l'Utilisateur pour se connecter sur le serveur supervisé. Modèles définissant cette donnée : similaire que SSH_KEYSSH_KEY
--- $SSH_KEY$ $SSH_KEY$ SSH_KEY_PASSPHRASE
--- SSH_PORT
--- SSH_USER
---
| Nom | Modifiable sur | Unité | Défaut | Valeur par défaut à l'installation de Shinken | Description |
|---|---|---|---|---|---|
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 |
| Nom | Modifiable sur | Unité | Défaut | Valeur par défaut à l'installation de Shinken | Description |
|---|---|---|---|---|---|
NB_LINE_UNAVAILABILITY | l'Hôte ( Onglet Données ) | --- | 5 | 5 | Nombre des dernières configurations reçues, ainsi que le temps d'indisponibilité du module causé par leur réception à afficher dans le résultat long. Modèles définissant cette donnée : |
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. Modèles définissant cette donnée : |
Données spécifiques pour ce check
Pas de données spécifiques pour ce check.
Les données DFE ( Duplicate Foreach )
l'Hôte ( Onglet Données ) 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)$".Nom Modifiable sur Unité Défaut Valeur par défaut à l'installation de Shinken Description MODULE_UI_LIST
--- broker-master-WebUI-webui$($_HOSTBROKER_PORT$)$$($_HOSTWEBUI_MODULE_NAME$)$ broker-master-WebUI-webui$($_HOSTBROKER_PORT$)$$($_HOSTWEBUI_MODULE_NAME$)$
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
l'Hôte ( Onglet Général ) --- Adresse de l'hôteNom Modifiable sur Unité Défaut Valeur par défaut à l'installation de Shinken Description HOSTADDRESS
Nom de l'hôte Nom 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
- 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
| 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
| Nom | Unité | 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 |