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 |
| GRAPHITE_DATA_LOCATION | L'endroit où est stocké les métriques reçues. | /opt/graphite/storage/whisper | Locale |
| GRAPHITE_PROCESS_NAME | Le nom du service utilisé pour le cache de Graphite. | carbon-cache | Locale |
| GRAPHITE_STORAGE_CRITICAL | Le seuil ( en pourcentage ) d'espace disque utilisé pour lequel on veut lever une alerte critique. | 95 | Locale |
| GRAPHITE_STORAGE_WARNING | Le seuil ( en pourcentage ) d'espace disque utilisé pour lequel on veut lever un avertissement. | 85 | Locale |
| GRAPHITE_USER | Le nom d'utilisateur utilisé pour se connecter à la base Graphite. | apache | Locale |
| CHECK_SHINKEN_TIMEOUT | Le temps en secondes pendant le quel le check essaye de se connecter à l'hôte. | 3 | shinken |
| SHINKEN_PROTOCOL | Protocole utilisé pour se connecter au serveur graphite. | http | shinken |
| MODULE_METROLOGY_LIST | Liste des modules de métrologie sur le quel lancer un check. | broker-master$($_HOSTBROKER_PORT$)$ | Locale - Duplicate For Each |
| 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 aperçu des nœuds carbon-cache ( vous devez consulter les checks Shinken Graphite Status ( détaillés ici : 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
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 ). |
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é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.
|
| Pour plus d'informations sur ce check, veuillez vous réferrer à la page du modèle correspondant : shinken-graphite ( Modèle d'hôte ). |
Paramètres du check
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 |
|---|---|---|---|
| PLUGINSDIR | Chemin vers les plugins du module. | /var/lib/shinken/libexec | Donnée globale |
| ADDRESS | Adresse de l'hôte. | localhost | Locale à l'hôte |
| SSH_USER | Utilisateur utilisé pour la connexion SSH pour la vérification des services | shinken | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| SSH_PORT | Port SSH de l'hôte | 22 | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| SSH_KEY | Chemin ( relatif ou absolu ) vers la clé privée à utiliser pour la connexion SSH | ~/.ssh/id_rsa | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| SSH_KEY_PASSPHRASE | Mot de passe de la clé privée SSH. | '' | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| GRAPHITE_DATA_LOCATION | Emplacement des données sur les serveurs graphite | /opt/graphite/storage/whisper | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| GRAPHITE_PROCESS_NAME | Nom du démon du cache ( Service ) | carbon-cache | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| GRAPHITE_STORAGE_CRITICAL | Limite en % pour passer le statut du check en critique lorsque l'espace de stockage atteint cette limite | 95 | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| GRAPHITE_STORAGE_WARNING | Limite en % pour passer le statut du check en avertissement lorsque l'espace de stockage atteint cette limite | 85 | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| GRAPHITE_USER | Utilisateur de graphite pour vérifier que les droits sont corrects | apache | Hérité du modèle d'hôte ( shinken-broker-module-metrology ) |
| CHECK_SHINKEN_TIMEOUT | Le temps en secondes pendant le quel on va tenter de contacter d'hôte. | 3 | Hérité du modèle d'hôte ( shinken-arbiter ) |
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$" |
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 |
Erreurs Remontés
Echec 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 ( à l'aide de cette 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.
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.