Versions Compared

Old Version 40

changes.mady.by.user Quentin Soubeyrol

Saved on

compared with

New Version Current

changes.mady.by.user Soubrié Grégoire

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=same_as_next_version
Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
Panel
titleSommaire

Table of Contents
stylenone

Contexte

Le modèle shinken-broker-module-visualisation-ui vous permet de superviser un hôte hébergeant le module WebUI d'un démon Broker ( voir la page Le Broker )

Description du modèle

Modèle d'hôte correspondant : shinken-broker-module-visualisation-ui

Afin de superviser le module WebUI d'un démon Broker, le modèle shinken-broker-module-visualisation-ui appliqué à votre l'hôte, attachera un des check qui vérifiera vérifieront la santé et la performance de ce module.

Paramétrage du modèle

Sommaire des checks

Nom

Description

Broker - $KEY$ - Module Visualisation UI

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

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

Affiche des statistiques concernant les métriques disponibles sur chaque serveur de métriques.

Les données

Les données communes pour tous les checks

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 Include
Broker - $KEY$ - Module Visualisation UI
Broker - $KEY$ - Module Visualisation UI
nopaneltrue

Les données spécifiques

Pour le check "Broker - $KEY$ - Module Visualisation UI - Metrology Reader"

Excerpt Include
Broker - $KEY$ - Module Visualisation UI - Metrology Reader
Broker - $KEY$ - Module Visualisation UI - Metrology Reader
nopaneltrue

Les données DFE ( Duplicate Foreach )

Excerpt

Le modèle est paramétrable via des données fournies par le modèle.

Les données sont les suivantes : 

Nom de la donnéeDescriptionValeur par défautHérité du modèle d'hôte ou locale
No Format
SHINKEN_PROTOCOL
Protocole utilisé pour établir la connexion avec le Brokerhttpshinken
No Format
CHECK_SHINKEN_TIMEOUT
Timeout utilisé pour l'établissement de la connexion avec Broker3shinken
No Format
BROKER_PORT
Port utilisé pour établir la connexion avec le broker7772Locale
No Format
SSH_KEY
Clé SSH utilisée pour se connecter au serveurs graphites$SSH_KEY$Locale
No Format
SSH_KEY_PASSPHRASE
Passphrase de la clé SSH$SSH_KEY_PASSPHRASE$Locale
No Format
SSH_PORT
Port SSH des serveur graphites$SSH_PORT$Locale
No Format
SSH_USER
Utilisateur SSH des serveurs graphite$SSH_USER$Locale
No Format
CHECK_METROLOGY_READER_SHINKEN_TIMEOUT
Timeout utilisé pour établir la connexion avec le broker25Locale
No Format
NB_LINE_UNAVAILABILITY
Quantité de configurations présentes dans le résultat long5Locale

Ainsi que des données DFE ( Duplicate Foreach ) :

Excerpt
NomUnités
Scroll Title
anchordata_for_check_sup_de_sup
title​
NomModifiable sur Unité
DéfautValeur par défaut à l'installation de ShinkenDescription
No Format
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

le

la WebUI ), exemple "Broker-Master$(7772)$$(WebUI)$,Broker-Spare$(8772)$$(WebUI)$".

Check(s) impacté(s) :

Anchorcheckcheck Description des checks

Broker - $KEY$ - Module Visualisation UI

Description du check

Ce check va afficher l'état d'une WebUI ainsi que les dernieres configuration qu'elle a reçue

Pour la WebUI référencé dans la duplicate foreach, nous avons :

  • Son statut

Pour chaque configurations qu'elle a reçues, nous avons : 

  • 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.
  • Si la configuration a été reçu en totalité.
  • Le temps d'indisponibilité de la WebUI.
Panel

Image Removed

Description des métriques

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

Paramètre du check

Le paramétrage de ce check s'effectue via les données de paramétrage du modèle ( voir ci-dessus le chapitre "Paramétrage du modèle"  )

  • Il n'est nécessaire de donner la liste des WebUI à vérifier.
  • En revanche, vu que le check est exécuté sur un Poller, il faut permet à 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 bien sûr reprendre cette même clé.

    Détail des commandes

    Nom du checkCommande du checkLigne de commandeBroker - broker-master - Module Visualisation UI - Metrology Readercheck_shinken_broker_module_visualisation_ui!$VALUE1$!$VALUE2$!$PLUGINSDIR$/check_shinken_broker_module_visualisation_ui.py -H "$HOSTADDRESS$" -p "$ARG1$" -w "$ARG2$" --shinkenversion "$SHINKENVERSION$" --timeout "$_HOSTCHECK_SHINKEN_TIMEOUT$" -n "$_HOSTNB_LINE_UNAVAILABILITY$"

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

    Description du check

    Ce check 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 ?
    Panel

    Image Removed

    Description des métriques

    Dans cette dernière partie sous les tableaux se trouvent les informations des métriques du check. Voici les informations affichées:

    • nb_metrics : Nombre de métrique gérée par le serveur graphite

    Paramètre du check

    Le paramétrage de ce check s'effectue via les données de paramétrage du modèle ( voir ci-dessus le chapitre "Paramétrage du modèle"  )

    Comment appliquer un modèle d'hôte à un hôte

    Excerpt Include
    Comment appliquer un modèle d'hôte à un hôte - Pack shinken
    Comment appliquer un modèle d'hôte à un hôte - Pack shinken
    nopaneltrue

  • Il n'est nécessaire de donner la liste des serveurs graphites à vérifier, car le check interroge via le broker la configuration de la Webui pour obtenir cette liste.
  • En revanche, vu que le check est exécuté sur un Poller, il faut permet à 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 bien sûr reprendre cette même clé.

    Détail des commandes

    Nom du checkCommande du checkLigne de commandeBroker - broker-master - Module Visualisation UI - Metrology Readercheck_shinken_broker_module_visualisation_ui_metrology_reader!$VALUE1$$PLUGINSDIR$/check_shinken_broker_module_visualisation_ui_metrology_reader.py -H "$HOSTADDRESS$" -p "$ARG1$" --shinkenversion "$SHINKENVERSION$" -P "$_HOSTSSH_PORT$" -i "$_HOSTSSH_KEY$" -u "$_HOSTSSH_USER$" -r "$_HOSTSSH_KEY_PASSPHRASE$" --timeout "$_HOSTCHECK_METROLOGY_READER_SHINKEN_TIMEOUT$"

    Les cas d'erreur dans le retour du check

    Un ou plusieurs royaumes n'est pas géré 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 : All, France, Italie, Japon

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

    No Format
    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

    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'il 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 :

    No Format
    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 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 :

    No Format
    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 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 :

    No Format
    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

    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 :

    No Format
    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

    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

    Image Removed

    Le broker n'a pas reçu de configuration

    PanelImage Removed