Contexte
Le modèle shinken-broker-module-metrology-writer vous permet de superviser un hôte hébergeant le module Graphite-Perfdata d'un démon broker.
Description du modèle
Modèle d'hôte correspondant : shinken-broker-module-metrology-writer.
Afin de superviser le module Graphite-Perfdata d'un démon Broker, le modèle shinken-broker-module-metrology-writer appliqué à votre hôte, attachera un check qui vérifiera la santé et la performance de ce module. Un check shinken-broker-module-metrology-writer est créé pour chaque module webui présent sur le démon broker de l'élément supervisé.
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ée | Description | Valeur par défaut | Hérité d'un autre modèle ou locale |
|---|---|---|---|
| BROKER_PORT | Port utilisé pour établir la connexion avec le broker | 7772 | Locale |
| MODULE_METROLOGY_LIST | Liste de Broker (Multi-démon) | broker-master$($_HOSTBROKER_PORT$)$ | Locale - Duplicate For Each |
| CHECK_SHINKEN_TIMEOUT | Timeout utilisé pour établir la connexion avec le broker | 3 | shinken |
| SHINKEN_PROTOCOL | Protocole utilisé pour se connecter au serveur graphite | http | shinken |
| SSH_KEY | Clé SSH utilisée pour se connecter au serveur graphite | $SSH_KEY$ | Locale |
| SSH_KEY_PASSPHRASE | Passphrase de la clé SSH | $SSH_KEY_PASSPHRASE$ | Locale |
| SSH_PORT | Port SSH des serveurs graphite | $SSH_PORT$ | Locale |
| SSH_USER | Utilisateur ssh des serveurs graphite | $SSH_USER$ | Locale |
Le SSH est utilisé pour se connecter au serveur graphite afin de vérifier que le processus indiqué est bien en cours d'exécution et que le serveur dispose d'assez d'espace de stockage. |
Broker - $KEY$ - Module Metrology Writer
Mode de fonctionnement du graphite installé
Graphite configuré en mode "Cache"
Les données de métrologie sont stockées seulement un 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.
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 apercu des noeuds carbon-cache ( vous devez consulter les checks Shinken Graphite Status 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 à votre configuration par le listener Shinken ( voir Visualiser l'architecture de son installation Shinken - Présentation détaillée, où cette fonctionnalité est décrite en bas de page ). |
Détails du check d'un nœud d'un carbon-relay
Ajout des nouveaux hôtes
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ésultats 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.
|
Check Shinken Graphite Status
Une fois les hôtes ajoutés par l'export de l'architecture, les checks Shinken Graphite Status donnent les informations suivantes sur les hôtes :
- File permission : Si le
carbon-cachedispose de droits suffisants pour écrire sur le disque. - Metric reception : Des informations sur le service
carbon-cache. - Storate I/O statistics : Des informations sur l'utilisation du disque (espace disponible, lecture et écriture) par le service
carbon-cache.
Remarque: Il est possible de changer le type de cache utilisé, pensez à changer les variables GRAPHITE_CACHE_NAME par le nom du service de votre cache ( ou relay ) dans les hôtes concernés.
Dans le cas du relay, c'est la variable GRAPHITE_RELAY_NAME qu'il faut changer (valeurs par défaut respectives : carbon-cache et carbon-relay).
Erreur dans un check Shinken Graphite Status
Le check Shinken Graphite Status fait appel à deux services pour récupérer les données à afficher :
carbon-cache: On a besoin de savoir si il peut recevoir les métriques.shinken-gatherer: Utilisé pour avoir des informations sur l'utilisation ( lecture & écriture ) du disque de l'hôte.
Pour vérifier l'état de ces services
Si un service n'est pas trouvé, une solution peut être de tenter de le relancer sur l'hôte en question à l'aide des commandes suivante :
Relancer le shinken-gatherer :
service shinken-gatherer restart
Relancer le carbon-cache :
service carbon-cache restart
Remarque: Le check utilise le nom des services pour vérifier leurs états. Si un service n'est pas trouvé, il est possible que les noms indiqués dans les variables GRAPHITE_CACHE_NAME et GRAPHITE_RELAY_NAME des hôtes ne soient pas ceux des services (en fonction des implémentations utilisées).
Vérification des droits du répertoire "/opt/graphite/storage/whisper/"
Le check vérifie aussi que l'utilisateur "apache" possède les droits de lecture sur les métriques.
Paramètres des checks
Les checks du module Graphite-Perfdata peuvent être configurés via des données fournies par le modèle.
Les données suivantes sont disponibles :
| Nom de la donnée | Decription | Valeur par défaut | Hérité du modèle d'hôte ou locale |
|---|---|---|---|
| ADDRESS | Adresse de l'hôte | localhost | Hérité du modèle d'hôte |
| SSH_USER | Utilisateur utilisé pour la connexion SSH pour la vérification des services | shinken | Donnée globale |
| SSH_PORT | Port SSH de l'hôte | 22 | Donnée globale |
| SSH_KEY | Chemin ( relatif ou absolu ) vers la clé privée à utiliser pour la connexion SSH | ~/.ssh/id_rsa | Donnée globale |
| SSH_KEY_PASSPHRASE | Mot de passe de la clé privée SSH. | '' | Donnée globale |
| GRAPHITE_PORT | Port utilisé pour la connexion au Graphite. | 2003 | Hérité du modèle d'hôte |
| GRAPHITE_DATA_LOCATION | Emplacement des données sur les serveurs graphite | /opt/graphite/storage/whisper | Locale |
| GRAPHITE_CACHE_NAME | Nom du démon du cache ( Service ) | carbon-cache | Locale |
| GRAPHITE_RELAY_NAME | Nom du démon du relay ( Service ) | carbon-relay | Locale |
| GRAPHITE_STORAGE_CRITICAL | Limite en % pour passer le statut du check en critique lorsque l'espace de stockage atteint cette limite | 95 | Locale |
| GRAPHITE_STORAGE_WARNING | Limite en % pour passer le statut du check en avertissement lorsque l'espace de stockage atteint cette limite | 85 | Locale |
| GRAPHITE_USER | Utilisateur de graphite pour vérifier que les droits sont corrects | apache | Locale |
| GRAPHITE_DISKS_LOCATION | Filtre sur le nom du disque. Si une valeur est indiquée, seul ce disque sera pris en compte pour la vérification des I/O disques. | Absente, car c'est une donnée sans valeur par défaut. Il faut la rajouter dans les données locales pour l'utiliser |
Les ports et adresses des serveurs hébergeant le broker sont utilisés pour connaître l'état des modules Graphite-Perfdata (écriture) et WebUI (lecture). |
Détail des commandes
| Nom du check | Commande du check | Ligne de commande |
|---|---|---|
| Broker - $KEY$ - Module Metrology Writer | check_shinken_broker_module_metrology_writer!$VALUE1$ | $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 "$_HOSTGRAPHITE_DISKS_LOCATION$" -n "$_HOSTGRAPHITE_PROCESS_NAME$" -w "$_HOSTGRAPHITE_STORAGE_WARNING$" -c "$_HOSTGRAPHITE_STORAGE_CRITICAL$" --timeout "$_HOSTCHECK_SHINKEN_TIMEOUT$" |
| Shinken Graphite Status | check_shinken_graphite | $PLUGINSDIR$/check_shinken_graphite.py -H "$HOSTADDRESS$" -u "$_HOSTSSH_USER$" -p "$_HOSTSSH_PORT$" -i "$_HOSTSSH_KEY$" -P "$_HOSTSSH_KEY_PASSPHRASE$" -s "$_HOSTGRAPHITE_PORT$" -d "$_HOSTGRAPHITE_DATA_LOCATION$" -U "$_HOSTGRAPHITE_USER$" -w "$_HOSTGRAPHITE_STORAGE_WARNING$" -c "$_HOSTGRAPHITE_STORAGE_CRITICAL$" -n "$_HOSTGRAPHITE_CACHE_NAME$" -R "$_HOSTGRAPHITE_RELAY_NAME$" |
Métriques
Le module Metrology - Writer donne plusieurs métriques :
| Nom de la métrique | Description |
|---|---|
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. |
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. |
worker_X_last_minute_metrics_sent_nb | Nombre de métrique écrit sur la dernière minute sur la worker X |
worker_X_last_minute_work_time | Temps passé sur la dernière minute à écrire les métriques ( en seconde ) sur le worker X |