Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
Panel
titleSommaire

Table of Contents
stylenone

Contexte

Le check Broker - $KEY$ - Module

Metrology Writer vérifie que le bon fonctionnement du module Graphite-Perfdata d'un démon broker ( voir la page Module Graphite-Perfdata )

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 ?

Panel

Image Added

Panel

Image Removed

Paramétrage

Le check utilise la ligne de commande suivante :

Code Block
languagetext
themeEmacs
$PLUGINSDIR$/check_shinken_broker_module_visualisation_ui_metrology_writerreader.py -H "$HOSTADDRESS$" -p "$ARG1$" 
-w "$ARG2$" --shinkenversion "$SHINKENVERSION$" 
 -P "$_HOSTSSH_PORT$" -i "$_HOSTSSH_KEY$" -u "$_HOSTSSH_USER$" 
-r "$_HOSTSSH_KEY_PASSPHRASE$" -d "$_HOSTGRAPHITE_DATA_LOCATION$" 
-U-timeout "$_HOSTGRAPHITE_USER$" -D "$_HOSTGRAPHITE_DISKS_LOCATION$" -n "$_HOSTGRAPHITE_PROCESS_NAME$" -w "$_HOSTGRAPHITE_STORAGE_WARNING$" 
-c "$_HOSTGRAPHITE_STORAGE_CRITICAL$" --timeout "$_HOSTCHECK_HOSTCHECK_METROLOGY_READER_SHINKEN_TIMEOUT$"

Données utilisées provenant du modèle

Données communes pour les checks du modèle

Excerpt Include
Modèle shinken
Modèle shinken
nopaneltrue

Données spécifiques pour ce check

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

Modèle d'hôte

( Onglet Données )

---77727772

Configuration du port de communication avec le Broker.

Autres check(s) impacté(s) :

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

No Format
GRAPHITE_DATA_LOCATION

Modèle d'hôte

( Onglet Données )

---/opt/graphite/storage/whisper/opt/graphite/storage/whisperL'endroit où sont stockées les métriques reçues.

No Format
GRAPHITE_PROCESS_NAME

Modèle d'hôte

( Onglet Données )

---carbon-cachecarbon-cache

Le nom du service utilisé pour le cache de Graphite.

No Format
GRAPHITE_STORAGE_CRITICAL

Modèle d'hôte

( Onglet Données )

%

9595

Le seuil d'espace disque utilisé pour lequel on veut lever une alerte critique 

No Format
GRAPHITE_STORAGE_WARNING

Modèle d'hôte

( Onglet Données )

%

8585

Le seuil d'espace disque utilisé pour lequel on veut lever un avertissement.

No Format
GRAPHITE_USER

Modèle d'hôte

( Onglet Données )

---

apacheapache

Le nom d'utilisateur utilisé pour se connecter à la base Graphite.

No Format
SSH_KEY

Modèle d'hôte

( Onglet Données )

---

$SSH_KEY$$SSH_KEY$Clé SSH utilisée pour se connecter au serveur Graphite
noformat
SSH_KEY_PASSPHRASE

Modèle d'hôte

( Onglet Données )

---

$SSH_KEY_PASSPHRASE$$SSH_PASSPHRASE$Le mot de passe de la clé SSH
No Format
SSH_PORT

Modèle d'hôte

( Onglet Données )

---

$SSH_PORT$$SSH_PORT$Port SSH des serveurs Graphite
No Format
SSH_USER

Modèle d'hôte

( Onglet Données )

---

$SSH_USER$$SSH_USER$Utilisateur SSH des serveurs Graphite
CHECK_METROLOGY_READER_SHINKEN_TIMEOUT

Modèle d'hôte

( Onglet Données )

---

2525Timeout utilisé pour établir la connexion avec le broker

Les données DFE ( Duplicate Foreach )

 

Excerpt Include
Modèle shinken-broker-module-metrologyvisualisation-writerui
Modèle shinken-broker-module-metrologyvisualisation-writerui
nopaneltrue

Données utilisées provenant du check

Pas de données spécifiques pour ce check.

Données globales

Excerpt IncludeDocumentation sur les packs de supervisionDocumentation sur les packs de supervisionnopaneltrue

Propriétés de l'hôte

Excerpt IncludeMise en place du Pack windowsMise en place du Pack windowsnopaneltrue

Mode de fonctionnement du graphite installé

Graphite configuré en mode "Cache"

Les données de métrologie sont stockées seulement dans un carbon-cache.

Il s'agit de la configuration avec laquelle Shinken est livrée.

  • Vérifie que le module Graphite-Perfdata peut contacter le serveur hébergeant le service graphite.
  • Vérifie que le service est disponible :
    • port réseau ouvert,
    • processus en cours d’exécution,
    • suffisamment d'espace disque,
    • permissions,
    • statistiques d'entrées/sorties disque pour écrire les données de métrologie.
  • Renvoie également les statistiques globales et pour chaque worker :
    • Nombre de données reçues,
    • volume et charge du module.

La charge du module est calculée à partir du temps de traitement utilisé par rapport au temps d’exécution que le module dispose pour traiter les données.

Panel

Image Removed

Graphite configuré en mode "relais"

Lorsque le service Graphite est configuré comme un relais vers d'autres nœuds de stockage, le check vérifie l'état du relais vers lequel le module Graphite-Perfdata envoie les métriques ; il se connecte également sur les nœuds vers lesquels le relais Graphite relaie les métriques.

Veuillez vous référer à la page Haute disponibilité de la base de métrologie (Graphite) pour la mise en place de cette architecture.

Le check donne :

  • du détail sur le relai
  • et un aperçu des nœuds carbon-cache.
    Vous devez consulter les checks Shinken Graphite Status ( voir la page shinken-graphite ( Modèle d'hôte ) ) de ces nœuds pour obtenir les détails.

Dans l'exemple ci-contre, le module envoie ses données à un relais ( 192.168.1.58:2013 ), qui transmet les données à deux nœuds "cache" :

  • 192.168.1.46:2004
  • 192.168.1.49:2004

    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 bien sûr 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 Added

    Info

    Les hôtes composant l'architecture Graphite sont automatiquement ajoutés à votre configuration par le listener Shinken ( voir la page Présentation détaillée où cette fonctionnalité est décrite en bas de page ).

    Panel

    Image Removed

    Vérifier le détail des carbon-caches

    Pour chaque nœud d'un carbon-relay , il est possible d'avoir plus de détails sur son état en allant vérifier le résultat des checks Shinken Graphite Status  pour chaque nœud correspondant. Ces checks sont présents sur des hôtes possédant le modèle d'hôte  shinken-graphite .

  • Si le module Module architecture-export de l'Arbiter est activé, les hôtes hébergeant les carbon-cache devraient être automatiquement ajoutés avec le modèle d'hôte shinken-graphite dans le Shinken Entreprise cible de l'architecture-export.
  • Sinon, vous devrez les créer manuellement en y accrochant le modèle d'hôte shinken-graphite.
    Panel

    Image Removed

    Info

    Pour plus d'informations sur ce check, veuillez vous référer à la page du modèle correspondant shinken-graphite ( Modèle d'hôte ).

    Envoi des données d'inventaire

    Données spécifiques au serveur d'inventaire de métrologie

    No Format
    NB_METROLOGY_INVENTORY_SERVER_REQUESTS_DISPLAYED

    Modèle d'hôte

    ( Onglet Données )

    ---1010

    Nombre de requêtes affiché

    No Format
    NB_METROLOGY_INVENTORY_SERVER_ERRORS_DISPLAYED

    Modèle d'hôte

    ( Onglet Données )

    ---55

    Nombre de requêtes en erreur affiché

    Exemple d'affichage du check lorsque tout est OK pour les serveurs d'inventaire de métrologie
    Panel

    Image Removed

    Différents cas d'erreur

    Le serveur d'inventaire de métrologie a reçu des requêtes avec une mauvaise clé d'authentification :

    Panel

    Image Removed

    Le serveur d'inventaire de métrologie n'est pas à jour par rapport à la configuration de l'Arbiter :

    Panel

    Image Removed

    Résultat

    Exemple

    Panel

    Image Removed

    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 :
      • GRAPHITECHECK_STORAGE_CRITICAL,GRAPHITE_STORAGE_WARNING,METROLOGY_READER_SHINKEN_TIMEOUT
      • CHECK_SHINKEN_TIMEOUT

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

    Les vérifications
    communes
    spécifiques
    Excerpt IncludeListe des événements sur les démons modifiant le résultat des checks

    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 connexion avec le Broker dépasse

    • Si supérieur àCHECK_METROLOGY_READER_SHINKEN_TIMEOUT (  par défaut : 25  sec )
    INCONNU
    Liste des événements sur les démons modifiant le résultat des checksnopaneltrue
    Les vérifications spécifiques

    En fonction du pourcentage d'espace disque utilisé :

    Si c'est supérieurà GRAPHITE_STORAGE_CRITICAL par défaut : 95 %  ) ATTENTION

    Situation

    Statut

    CRITIQUE

    En fonction du pourcentage d'espace disque utilisé :

    • Si c'est supérieur à GRAPHITE_STORAGE_WARNING (  par défaut : 85 %  )

    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 démon serveur graphite fonctionne correctement, la version installée et le temps qu'a pris le check pour établir la  communication avec le check.

    Résultat Long

    Précise le fonctionnement des modules du Broker, leur statut, le nombre de redémarrages lors des 24 dernières heures, la date de dernier redémarrage et les sous-modules

    Description des erreurs

    Echec de la connexion aux nœud

    Cette erreur arrive lorsque la configuration n'est pas correcte. Il peut y avoir plusieurs sources à ce problème :

  • Une erreur dans la configuration du relai et d'un ( ou plusieurs ) cache. Pensez à bien vérifier les adresses saisies dans les fichiers de configuration de ces éléments ( voir la page Haute disponibilité de la base de métrologie (Graphite) )
  • Une erreur dans les paramètres du check Broker - $KEY$ - Module Metrology Writer. Avec une installation par défaut du relai et des caches, cela ne devrait pas arriver, mais dans le cas où vous avez modifié certains paramètres sur l'hôte ( comme les ports SSH et/ou Graphite ), pensez à répercuter ces changements dans le modèle d'hôte shinken-broker-module-metrology-writer et le check Broker - $KEY$ - Module Metrology Writer.
    • 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 server

    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 Added
    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.

    Panel

    Image Added

    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 :

    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 Added

    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 Added

    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 :  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 Added

    Panel
    Image Removed
    Avertissement ou erreur dans un nœud

    Lorsqu'un ou plusieurs nœuds remontent un dysfonctionnement, celui-ci apparaît dans le check Broker - $KEY$ - Module Metrology Writer. Un avertissement signifie qu'il y a une erreur non bloquante au fonctionnement normal du cache. Il est tout même conseiller d'essayer de résoudre ce problème. Pour avoir plus d'informations sur le problème remonté par le nœud, veuillez vous référer au check Shinken Graphite Status du nœud correspondant ( voir la page shinken-graphite ( Modèle d'hôte ) ).

    Note

    Remarque : Lorsque plusieurs erreurs ( par exemple un avertissement et une erreur critique ) surgissent sur un même nœud, seule la plus importante ( ici l'erreur critique ) sera affichée dans le retour du check Broker - $KEY$ - Module Metrology Writer ( comme sur l'image suivante ).

    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

    Métriques

    NomUnitéDescription
    No Format
    languagetext
    themeEmacs
    IP_HOST_graphite_disk_sda_IO
    %

    Taille en pourcentage des entrées/sorties utilisé sur le disque de la machine ou graphite est installé. HOST_ADRESS correspond à l'adresse IP ou au DNS de l'hôte.

    No Format
    languagetext
    themeEmacs
    IP_HOST_graphite_storage_size
    %

    Taille en pourcentage de l'espace disque utilisé sur la machine ou graphite est installé. HOST_ADRESS correspond à l'adresse IP ou au DNS de l'hôte.

    No Format
    languagetext
    themeEmacs
    worker_X_last_minute_metrics_sent_nbnb_metrics
    ---

    Nombre de

    métriques écrit sur la dernière minute sur la worker X
    No Format
    languagetext
    themeEmacs
    worker_X_last_minute_work_time
    secondeTemps passé sur la dernière minute à écrire les métriques sur le worker X

    métrique gérée par le serveur graphite