Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=clean_macro_parameter
Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbookhtmltruefalse
scroll-eclipsehelpdocbooktrue
scroll-epubeclipsehelptrue
scroll-htmlepubtrue
Panel
titleSommaire

Table of Contents
stylenone

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

Panel

Image RemovedImage Added

Paramétrage

Le check utilise la ligne de commande suivante :

Scroll Title
title
Code Block
languagetext
themeEmacs
$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

Excerpt Include
Modèle shinken
Modèle shinken
nopaneltrue

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

Excerpt Include
Mode actif et mode passif
Mode actif et mode passif
nopaneltrue


Excerpt Include
Le Broker
Le Broker
nopaneltrue


Excerpt
Scroll Title
anchordata_for_check_sup_de_sup
title
NomModifiable
sur
sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
No Format
CHECK
NB_
SHINKEN
LINE_
TIMEOUT
UNAVAILABILITY

l'Hôte

( Onglet Données )

---
3
5
3

Temps maximum durant lequel les checks peuvent s'exécuter ( en secondes ).

Données spécifiques pour ce check

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 :

No Format
WEBUI_MODULE_NAME
NomModifiable sur UnitésDéfautValeur par défaut à l'installation de ShinkenDescription No FormatNB_LINE_UNAVAILABILITY

Modèle d'hôte

( Onglet Données )

---
5
WebUI
5Quantité de configurations présentent dans le résultat long
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 )

 

Excerpt Include
Modèle shinken-broker-module-visualisation-ui
Modèle shinken-broker-module-visualisation-ui
nopaneltrue

Données utilisées provenant du check

Pas de données spécifiques 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, vous pouvez il est bien sûr possible de reprendre cette même clé.

Données globales

Excerpt Include
Documentation sur les packs de supervision
Documentation sur les packs de supervision
nopaneltrue

Propriétés de l'hôte

Excerpt Include
Mise en place du Pack windows
Mise en place du Pack windows
nopaneltrue

Résultat

Exemple

Panel
Image Removed

Image Added

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, nous avons 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
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.

Panel

Image Removed

Le Graphite backend d'un royaume 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.

Panel

Image Removed

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.

Panel

Image Removed

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.

Panel

Image Removed

Un ou plusieurs royaumes ne sont pas gérés par le
Broker
Le check nous 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 : AllFrance, 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.

Panel

Image Removed

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

Panel

Le broker n'a pas reçu de configuration
Panel

Image Added

Métriques

Scroll Title
anchorparameter_check_metrics
title
NomUnitéDescription
No Format
languagetext
themeEmacs
nb_checks
---

Nombre de checks géré par la WebUI

No Format
languagetext
themeEmacs
nb_clusters
---

Nombre de clusters géré par la WebUI

No Format
languagetext
themeEmacs
nb_contacts
---

Nombre de contacts géré par la WebUI

No Format
languagetext
themeEmacs
nb_hosts
---

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

No Format
languagetext
themeEmacs
unavailability_time_per_minute
minute

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