Sommaire

Contexte

Le check Broker - $KEY$ - Module Metrology Writer vérifie le bon fonctionnement du module Graphite-Perfdata d'un démon Broker ( voir la page Module Graphite-Perfdata )

Paramétrage

Le check utilise la ligne de commande suivante :

$PLUGINSDIR$/check_shinken_module_metrology_writer.py -H "$HOSTADDRESS$" -p "$ARG1$" --shinkenversion "$SHINKENVERSION$" -P "$_HOSTSSH_PORT$" -i "$_HOSTSSH_KEY$" -u "$_HOSTSSH_USER$" -r "$_HOSTSSH_KEY_PASSPHRASE$" -d "$_HOSTGRAPHITE_DATA_LOCATION$" -U "$_HOSTGRAPHITE_USER$" -D "$_HOSTGRAPHITEDISKS_LOCATION$" -n "$_HOSTGRAPHITE_PROCESS_NAME$" -w "$_HOSTGRAPHITE_STORAGE_WARNING$" -c "$_HOSTGRAPHITE_STORAGE_CRITICAL$" --timeout "$_HOSTCHECK_SHINKEN_TIMEOUT$"

Données utilisées provenant du modèle

Données communes pour les checks du modèle

Provenant du modèle shinken

NomModifiable surUnitéDéfaut

Valeur par défaut

à l'installation de Shinken

Description
CHECK_SHINKEN_TIMEOUT

l'Hôte

( Onglet Données )

seconde

33

Temps maximum durant lequel le check va attendre une réponse du démon.

Provenant du modèle shinken-broker-module-metrology-writer

Nom

Modifiable sur 

Unité

Défaut

Valeur par défaut à l'installation de Shinken

Description

SSH_KEY

l'Hôte

( Onglet Données )

---$SSH_KEY$$SSH_KEY$

Chemin vers la clé ssh de l'utilisateur shinken, sur le serveur hébergeant le Poller qui exécutera le check. 

  • Cette clé doit être présente dans les clefs autorisées du compte utilisateur utilisé pour se connecter sur le serveur supervisé ( voir la donnée SSH_USER si dessous ).

Modèles définissant cette donnée : 

SSH_KEY_PASSPHRASE

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

SSH_PORT

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

SSH_USER

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_KEY





NomModifiable sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
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


Données spécifiques pour ce check

NomModifiable sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
GRAPHITE_DATA_LOCATION

l'Hôte

( Onglet Données )

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

L'endroit où sont stockées les métriques reçues.

GRAPHITE_PROCESS_NAME

l'Hôte

( Onglet Données )

---carbon-cachecarbon-cache

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

GRAPHITE_STORAGE_CRITICAL

l'Hôte

( Onglet Données )

%

9595

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

GRAPHITE_STORAGE_WARNING

l'Hôte

( Onglet Données )

%

8585

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

GRAPHITE_USER

l'Hôte

( Onglet Données )

---

apacheapache

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

GRAPHITE_DISKS_LOCATION

l'Hôte

( Onglet Données )

---

------

Liste des disques dont les données sont remontées par le check. Si la donnée n'existe pas, l’ensemble des disques est pris en compte.


La donnée n'est pas présente dans le pack livré par Shinken. Pour pouvoir l'utilisée, il faut la rajouter sur l'Hôte.



Les données DFE ( Duplicate Foreach )

 

NomModifiable sur UnitésDéfautValeur par défaut à l'installation de ShinkenDescription
MODULE_METROLOGY_LIST

l'Hôte

( Onglet Données )

---broker-master$($_HOSTBROKER_PORT$)$ broker-master$($_HOSTBROKER_PORT$)$

Liste de Broker (  Multi-démon   )

Check(s) impacté(s) :


Données utilisées provenant du check

 Pas de données provenant du check pour ce check.

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

NomModifiable surUnitéDéfautValeur par défaut à l'installation de ShinkenDescription
HOSTADDRESS

l'Hôte

( Onglet Général )

---

Nom de l'hôteNom de l'hôte

Adresse de l'hôte



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.

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.

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

Le check donne :

  • du détail sur le relai
  • et un aperçu des nœuds carbon-cache.

Consulter les checks Shinken Graphite Status ( voir la page Modèle shinken-graphite ) 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

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

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 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, le céer manuellement en y accrochant le modèle d'hôte shinken-graphite.

Pour plus d'informations sur ce check, se référer à la page du modèle correspondant Modèle shinken-graphite.

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


Situation

Statut

Démon bloqué et qui doit être redémarré

CRITIQUE

Démon spare non assigné sur un démon master

CRITIQUE

Problème de conflits d'Arbiters

CRITIQUE

Les serveurs ne sont pas à la même heure

CRITIQUE

Erreur de surcharge des disques de logs

ATTENTION 

Démon qui bloque une tentative de chargement d'objet malveillant

ATTENTION 

Démon est en cours d'arrêt

ATTENTION 

Dernière connexion de l'Arbiter remonte à trop longtemps

ATTENTION 

Le démon a chargé une configuration enregistrée, en attendant d'être contacté par l'Arbiter

ATTENTION


Les vérifications spécifiques

Situation

Statut

En fonction du pourcentage d'espace disque utilisé :

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

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 : 

  • L'état de fonctionnement du démon,
  • la version installée,
  • 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

Échec de la connexion aux nœuds

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. Dans le cas où certains paramètres ont été modifiés sur l'hôte ( comme les ports SSH et/ou Graphite ),il faut répercuter ces changements dans le modèle d'hôte shinken-broker-module-metrology-writer et le check Broker - $KEY$ - Module Metrology Writer.

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 conseillé d'essayer de résoudre ce problème. Pour avoir plus d'informations sur le problème remonté par le nœud, se référer au check Shinken Graphite Status du nœud correspondant ( voir la page Modèle shinken-graphite ).

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

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

Métriques

NomUnitéDescription
IP_HOST_graphite_disk_sda_IO
%

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

IP_HOST_graphite_storage_size
%

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

worker_X_last_minute_metrics_sent_nb
---

Nombre de métriques écrites sur la dernière minute sur le worker X

worker_X_last_minute_work_time
seconde

Temps passé sur la dernière minute à écrire les métriques sur le worker X