Versions Compared

Old Version 1

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

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=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 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 va afficher l'état d'une WebUI ainsi que les dernières configurations qu'elle a reçues

Panel

Image Added

Panel

Image Removed

Paramétrage

Le check utilise la ligne de commande suivante :

Scroll Title
title​
Code Block
languagetext
themeEmacs
$PLUGINSDIR$/check_shinken_broker_module_
metrology
visualisation_
writer
ui.py -H "$HOSTADDRESS$" -p "$ARG1$"
--shinkenversion
"$SHINKENVERSION$" 
-
P
w "
$_HOSTSSH_PORT$
$ARG2$" -
i "$_HOSTSSH_KEY$" -u "$_HOSTSSH_USER$" -r "$_HOSTSSH_KEY_PASSPHRASE$" -d "$_HOSTGRAPHITE_DATA_LOCATION$" -U
-shinkenversion "$SHINKENVERSION$" --timeout "$_
HOSTGRAPHITE_USER$" -D "$_HOSTGRAPHITE_DISKS_LOCATION$
HOSTCHECK_SHINKEN_TIMEOUT$" -n "$_
HOSTGRAPHITE
HOSTNB_
PROCESS_NAME$" -w "$_HOSTGRAPHITE_STORAGE_WARNING$" -c "$_HOSTGRAPHITE_STORAGE_CRITICAL$" --timeout "$_HOSTCHECK_SHINKEN_TIMEOUT$"
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​
Données spécifiques pour ce check
NomModifiable sur 
Unités
UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
No Format
BROKER
NB_LINE_
PORT
UNAVAILABILITY
Modèle d

l'

hôte

Hôte

( Onglet Données )

---
7772
5
7772

Configuration du port de communication avec le Broker.

Autres check(s) impacté(s) :

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

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

Modèle d'hôte

( Onglet Données )

---/opt/graphite/storage/whisper/opt/graphite/storage/whisper

L'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 FormatGRAPHITE_USER
Modèle d'hôte
 ( Onglet Données ) 
---
apache
WebUI
apache
 WebUI 
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
 No Format
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
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. 
 No Format
SSH_USER
Modèle d'hôte
 ( Onglet Données ) 
---
$SSH_USER$$SSH_USER$Utilisateur SSH des serveurs Graphite
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 provenant du check 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, 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 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 :
        GRAPHITE_STORAGE_CRITICAL,
      • GRAPHITE_STORAGE_WARNING,
      •  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
    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 %     )
    Situation
      Statut  
       CRITIQUE   
    En fonction du pourcentage d'espace disque utilisé :
    • Si c'est supérieur à GRAPHITE_STORAGE_WARNING (   par défaut : 85 %     )
    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 démon module 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.
    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
     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 ).
     PanelImage 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
    Métriques
    Image Added
    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
    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.
    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
    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.
    nb_contacts
    		---
    Nombre de contacts géré par la WebUI
     No Format
    languagetext
    themeEmacs
    worker_X_last_minute_metrics_sent_nb
    nb_hosts
    		---
    Nombre 
     de métriques écrit sur la dernière minute sur la worker X
    d'hôtes géré par la WebUI
     No Format
    languagetext
    themeEmacs
    worker
    unavailability_
    X
    time_
    last
    per_minute
    _work_time
    secondeTemps passé sur la dernière minute à écrire les métriques sur le worker X
    minute
    Le temps d'indisponibilités de la WebUI par minutes