Plugin Monitoring (Jeedom)

IMPORTANT

S’il n’y a pas d’information sur la mise à jour, c’est que celle-ci concerne uniquement de la mise à jour de documentation, de traduction ou de texte.

Auteurs

Merci à Phifi qui à l’origine du plugin Monitoring, repris depuis le 13 novembre 2023 par TiTidom.

Présentation

Ce plugin permet de récupérer des données système de différents équipements (en local pour monitorer votre Jeedom ou à distance via SSH) et de les afficher sur le Dashboard de Jeedom.

Initialement, ce plugin a été créé pour monitorer seulement les Jeedom Mini et Mini+. Mais pour répondre à une forte demande, il a été rendu compatible avec des Jeedom installés sur des VM (Machine Virtuelle), des Linux distants (Debian, Ubuntu, etc…) ou encore un NAS Synology.

Compatibilité

IMPORTANT

La version minimum du core de Jeedom requise pour le plugin est la version 4.2 (depuis le 13 décembre 2023)

Des retours des utilisateurs, voici une liste, non exhautive, des systèmes (hardware / distribution) compatibles :

• Jeedom Mini, Mini+, Atlas, Luna
• Raspberry Pi3, Pi4
• Cubieboard, Banana Pi
• Machine Virtuelle (VM)
• Linux (Debian 9, Debian 10, Debian 11, Debian 12, Ubuntu 20.04 LTS, Ubuntu 22.04 LTS, etc…)
• Distributions spécifiques : OpenELEC, LibreElec, RasPlex et OSMC.
• NAS Synology (DSM 6.x, 7.x)
• NAS Medion (Support partiel)
• Router Synology

Données visibles sur le Dashboard

• Distribution :
  • Nom et version du système d’exploitation (OS) Linux/Syno, architecture 32/64bits, et type de processeur
• Démarré depuis (uptime) :
  • Informe depuis combien de temps le système Jeedom/Linux/Syno est démarré
• Charge système :
  • “Load average” : 1 min / 5 min / 15 min (pour plus d’informations voir FAQ)
• Mémoire (RAM) :
  • Mémoire vive totale et libre (et % libre)
• Swap :
  • Swap Total, Utilisé et Disponible (et % disponible)
• Réseau :
  • Données transmises (TX) et reçues (RX) (et nom de la carte réseau en “tooltips” au passage de la souris sur l’icône)
• Espace disque (HDD) :
  • Espace disque “total” et “utilisé” de la carte SD du système ou du disque dur pour les VM et NAS Synology
• CPU :
  • Nombre de cœurs, Fréquence associée et température (température seulement si compatible)
• Commandes personnalisées (“perso1” et “perso2”) :
  • Permet de saisir des commandes personnalisées à lancer sur le système distant et d’afficher/historiser les résultats

Configuration

Dépendances

Depuis la version du 13 décembre 2023, il n’y a plus de dépendances à installer.

Version du Plugin

A chaque version du plugin qui sort, un numéro est attribué sous la forme “version_majeure.version_mineure.version_patch” (par ex. : “2.2.0”). Vous pouvez retrouver cette information sur la page de configuration du plugin. Pour toute demande sur le Community, merci de préciser dans vos messages ce numéro de version du plugin.

Configuration des Mises à jour Automatiques

A partir de la page du plugin, vous pouvez accéder à la Configuration du plugin qui se présente sous cette forme :

Par défaut :

• La mise à jour Equipement Local (1 min) est désactivée
• La mise à jour Equipements Distants (15 min) est activée

IMPORTANT

Sauf cas exceptionnel, vous n’avez aucune raison de désactiver les mises à jour automatiques faites toutes les 15 min !

Si vous souhaitez monitorer votre équipement Local (Votre Jeedom) plus régulièrement (Toutes les minutes), vous pouvez activer l’option “Equipement Local (1min)” et appuyer ensuite sur le bouton “Sauvegarder”.

Pensez dans ce cas à activer l’historique des commandes de cet équipement local et à changer le “Mode de lissage” de l’historique, car par défaut Jeedom lisse les valeurs à “5 minutes”, et vous perdriez le bénéfice de mettre à jours ces valeurs toutes les minutes !

A minima, je vous conseille (pour ces mises à jour toutes les minutes) d’activer l’hitorique sur la commande “Charge Système 1 min” et dans la configuration de cette commande, onglet “Configuration” de modifier les options d’historique comme ceci :

Configuration d’un équipement

Pour configurer un nouvel équipement :

• Retourner sur la page du plugin :

• Puis cliquer sur le bouton en haut à gauche “Ajouter”
• Puis saisir le nom de l’équipement (ex. “VM - Documentation”)

• Puis définir :
  • Objet parent
  • Catégorie (optionnelle)
• Cocher les options :
  • “Activer” (à cocher, sinon l’équipement ne sera pas utilisable)
  • “Visible” (optionel)

• Sélectionner la “Carte Réseau” :
  • “Auto (par défaut)” : détecte automatiquement la carte réseau du système.

• Si la carte réseau n’est pas détectée correctement via l’option “Auto”, alors selectionner une autre de ces options :
  • “1er port Ethernet” : utilise la carte réseau “eth0” sur le système (local ou distant)
  • “1er port Wi-Fi” : utilise la carte réseau “wlan0” sur le système (local ou distant)
  • “Autre” : permet de spécifier manuellement le nom de la carte réseau à utiliser
• Sélectionner si votre équipement est “Local” (par défaut) ou “Distant”
  • “Local” : permet de surveiller le Jeedom sur lequel est installé le plugin (localement)
  • “Distant (Mot de Passe)” : permet de monitorer un système Linux distant (installé sur une autre machine) via SSH (identifiant + mot de passe)
  • “Distant (Clé SSH)” : permet de monitorer un système Linux distant (installé sur une autre machine) via SSH (identifiant + clé SSH)

IMPORTANT

Pour des systèmes Linux monitorés à distance via SSH, vous devez choisir un compte (identifiant) avec des droits suffisants pour lancer les commandes (par ex. un utilisateur “sudo” ou bien à défaut le compte “root”).

Pour un NAS Synology, il faut utiliser un compte disposant des droits administrateurs.

Choix “Distant (Mot de passe)”

Après avoir sélectionné ce mode, 4 champs supplémentaires s’affichent :

• Adresse IP : Saisir l’adresse IP de la machine distante
• Port SSH : Saisir le numéro du port SSH (par défaut il s’agit du port 22)
• Identifiant : Saisir le nom d’utilisateur qui sera utilisé pour se connecter en SSH sur le système distant
• Mot de passe : Saisir le mot de passe qui est associé au nom d’utilisateur

Choix “Distant (Clé SSH)”

Après avoir sélectionné ce mode, 5 champs supplémentaires s’affichent :

• Adresse IP : Saisir l’adresse IP de la machine distante
• Port SSH : Saisir le numéro du port SSH (par défaut il s’agit du port 22)
• Identifiant : Saisir le nom d’utilisateur qui sera utilisé pour se connecter en SSH sur le système distant
• Passphrase : (Optionnel) Saisir la phrase secrète associée à la clé SSH, permettant de décoder celle-ci
• Clé SSH : Coller ici la clé privée SSH permettant de se connecter au système distant

IMPORTANT

Le plugin ne gère pas la génération de la clé SSH, ni la recopie de la clé publique sur le système distant (nécessaire pour permettre la connexion à ce système via une clé SSH).

Pour plus d’informations sur la génération d’une clé SSH, rendez-vous dans la FAQ.

Configuration spécifique pour un NAS Synology

Avant toute chose, pour pouvoir monitorer un NAS Synology, il faut que le service SSH soit activé dessus. c’est via ce protocole SSH que le plugin communique avec votre baie Synology.

Pour vous en assurer, rendez-vous dans le panneau de configuration de votre baie Syno, dans la partie “Terminal & SNMP” et assurez-vous que la case “Activer le service SSH” est bien cochée.

Vous pouvez ensuite configurer votre équipement :

Pour monitorer un NAS Synology, il faut cocher la case “Activer” du bloc “NAS Synology” situé sur la droite de la page de configuration de l’équipement. Cela permet de détecter correctement les informations systèmes spécifiques à votre NAS, comme le numéro de version, les volumes disques, etc…

Après avoir cliqué sur le bouton “Activer”, plusieurs options sont disponibles :

• Modèle (Alt) : Si le nom du modèle de votre Synology est mal détecté, cochez cette option pour utiliser une méthode alternative de détection
• Volume 2 : Si vous possédez un 2ème volume (HDD) dans votre NAS Synology, cochez cette option pour le monitorer
• HDD USB : Si vous possédez un disque dur externe connecté en USB sur votre NAS, cochez cette option pour le monitorer
• Temp (Alt) : Cette option fait apparaître une nouvelle zone de saisie Commande Temp
• Commande Temp : Cette option apparaît si vous avez séléctionné Temp (Alt). Elle vous permet de saisir une commande complète pour récupérer la température sur votre NAS

Configuration spécifique pour un Linux/Proxmox

Sur la page de configuration de votre équipement, vous avez un bloc spécifique (sur la droite) : “Linux/Proxmox” :

• Temp (Alt) : Cette option fait apparaître une nouvelle zone de saisie Commande Temp
• Commande Temp : Cette option apparaît si vous avez séléctionné Temp (Alt). Elle vous permet de saisir une commande complète pour récupérer la température sur votre Linux ou Proxmox et se substitue au niveau de l’affichage à la température CPU.

Si la température est mal détectée sur votre équipement, et que vous avez connaissance de la commande exacte qui permet de la récupérer, vous pouvez utiliser ce champ prévu à cet effet.

Configuration spécifique : Commandes ‘perso1’ et ‘perso2’

Pour chaque équipement, vous avez la possibilité de configurer 2 commandes personnalisées : “perso1” et “perso2”.

Saisissez toute commande Linux valide dans la zone prévue à cet effet, et indiquez si besoin l’unité. Vous pouvez également personnaliser le nom de la commande et l’icône à afficher sur le Dashboard.

Si la case “Afficher” est cochée pour les commandes “perso1” et/ou “perso2”, alors le résulat de ces commandes sera affiché sur le Dashboard.

Colorisation des valeurs

Pour permettre de les mettre en avant, il est possible de coloriser certaines valeurs (en vert, orange et rouge) suivant deux seuils définis. Les valeurs rentrées pour les différents seuils devront être dans la plage de celles que retourne la commande correspondante. Par exmple, si la commande retourne : 55°C ou 12%, il faudra alors saisir la valeur chiffrée (55, 12), sans le signe “%”, “°C”.

Il est possible de choisir des seuils pour les commandes suivantes :

• Charge Système 1 min / 5 min / 15 min (Load Average)
• Espace Disque Utilisé (Pourcentage)
• Mémoire Libre (Pourcentage)
• Swap Libre (Poucentage)
• Température CPU
• Commandes “Perso1” et “Perso2”

Informations sur les seuils de colorisation

Il existe deux types de colorisation : “Vert - Orange - Rouge” et “Rouge - Orange - Vert” suivant la donnée à représenter.

Ex. : Pour représenter un espace disque UTILISE, le modèle “Vert Orange Rouge” sera associé, alors que pour représenter une mémoire LIBRE on va utiliser le modèle inverse “Rouge Orange Vert”.

• Si la valeur de la commande est INFERIEURE à XX (Seuil BAS), celle-ci sera colorisée en VERT.
• Si la valeur de la commande est comprise ENTRE XX et YY, celle-ci sera colorisée en ORANGE.
• Si la valeur de la commande est SUPERIEURE à YY (Seuil HAUT), celle-ci sera colorisée en ROUGE.

• Si la valeur de la commande est INFERIEURE à XX (Seuil BAS), celle-ci sera colorisée en ROUGE.
• Si la valeur de la commande est comprise ENTRE XX et YY, celle-ci sera colorisée en ORANGE.
• Si la valeur de la commande est SUPERIEURE à YY (Seuil HAUT), celle-ci sera colorisée en VERT.

Valeurs par défaut pour les seuils de colorisation

Voici quelques valeurs qui pourront vous aider à calibrer les seuils de vos équipements (ils ne sont donnés qu’à titre d’exemple) :

Charge Système 1 min / 5 min / 15 min (Load Average) :

Cette valeur est un nombre décimal (1.17 par exemple), dont le minimum est 0.00 (système au repos)

• Seuil BAS : 0.50
• Seuil HAUT : 1.50

Pour se donner une idée de la charge réelle du système en pourcentage (%) à partir du Load Average 1 min, on peut faire ce calcul : (valeur / nombre de coeurs) * 100

• Un système possédant 4 coeurs, et ayant un load average sur 1 min de 0.50 est chargé à (0.50 / 4) * 100 = 12.5%

Espace Disque Utilisé (Pourcentage) :

Plus cette valeur est basse, mieux c’est ! L’unité est un pourcentage (%) compris entre 0% et 100%.

• Seuil BAS : 20
• Seuil HAUT : 80

Mémoire Libre (Pourcentage) :

Plus cette valeur est haute, mieux c’est ! L’unité est un pourcentage (%) compris entre 100% et 0%.

• Seuil BAS : 30
• Seuil HAUT : 60

Swap Libre (Pourcentage) :

Plus cette valeur est haute, mieux c’est ! L’unité est un pourcentage (%) compris entre 100% et 0%.

• Seuil BAS : 40
• Seuil HAUT : 80

Température CPU :

Plus cette valeur est basse, mieux c’est ! L’unité est en degré (°C).

• Seuil BAS : 45
• Seuil HAUT : 55

Historisation

Pour certaines valeurs, il est possible d’activer “Historiser” pour représenter, par une courbe, les variations de celles-ci.

Historiser est possible pour :

• Charge Système 1 min / 5 min / 15 min (Load Average)
• Espace Disque Utilisé (Pourcentage)
• Mémoire Libre (Pourcentage)
• Swap Libre (Poucentage)
• Température CPU
• Commandes “Perso1” et “Perso2”

A partir du moment où une commande est historisée, vous avez aussi la possibilité d’afficher un “graphique de fond de tuile” sur le dashboard (desktop ou mobile). Pour configurer cette option, rendez-vous dans la configuration de votre équipement, et cliquez sur le bouton “Configuration Avancée”, en haut à droite de la page.

• Choisissez l’information à afficher en graphique de fond (par ex. : “Charge système 1 min”)
• Choisissez la période d’affichage (par ex. : “Semaine”) et le Type d’affichage (par ex. : “Courbe”)
• Sauvegardez

Sur le dashboard, le graphique s’affichera alors en fond sur votre équipement :

Actions “redémarrage” et “extinction” de l’équipement

Mode Local

Il faut s’assurer que le compte avec lequel Jeedom travaille a bien le droit de lancer les commandes “reboot” et “poweroff” (c’est le cas dans les versions récentes de Jeedom).

Mode Distant

Il faut s’assurer, lors de la configuration de l’équipement, de choisir un compte (Identifiant) SSH qui a suffisamment de droits sur le système distant pour lancer les deux commandes reboot et poweroff (pour Linux) ou shutdown pour une baie Synology.

Si vous utilisez un compte qui est “sudo” sur l’équipement distant, connectez-vous dessus en SSH (cette action ne sera à faire qu’une seule fois), et rentrez la commande suivante pour ajouter le droit à l’utilisateur d’utiliser les commandes reboot et poweroff (Linux) ou shutdown (Synology) sans avoir à taper de mot de passe de confirmation.

IMPORTANT

Avant de rentrer la commande ci-dessous, remplacez MonUser (à deux endroits : Au début de la ligne de commande, mais aussi à la fin) par le nom d’utilisateur avec lequel vous vous connectez.

Lorsque vous aurez rentré la commande, le système vous demandera votre mot de passe pour confirmer (celui avec lequel vous vous êtes connectés dessus)

Pour un équipement Linux :

echo 'MonUser ALL= NOPASSWD: /usr/sbin/reboot, /usr/sbin/poweroff' | sudo tee /etc/sudoers.d/MonUser

Pour un équipement Synology :

echo 'MonUser ALL= NOPASSWD: /sbin/shutdown' | sudo tee /etc/sudoers.d/MonUser

FAQ

Quelle est la fréquence de rafraichissement des informations ?

• Le plugin actualise les informations toutes les 15 minutes (via un cron dédié, donc à 00 - 15 - 30 et 45 de chaque heure)

Quelle est la signification de Charge système 1min/5min/15min ?

• Pour plus d’informations : Wikipedia (Load Average)

Est-il possible de monitorer un “VMware ESXi” ?

• Non, ESXi n’utilise pas les commandes linux classiques. Il y a un Plugin ESXi dédié pour cela dans Jeedom.

Pendant la mise à jour du plugin, j’obtiens une erreur dans les logs

cat: /sys/devices/platform/sunxi-i2c.0/i2c-0/0-0034/temp1_input: No such file or directory

• Ne pas tenir compte de cette erreur dans les logs, elle permet de capter la température sur certains équipement, notamment le “Banana Pi”. Aucune conséquence sur le fonctionnement du plugin.

J’obtiens des erreurs dans les logs “cron_execution”

Comme par ex. (récupération de la température CPU) : cat: /sys/devices/virtual/thermal/thermal_zone0/temp: Aucun fichier ou dossier de ce type

• Votre équipement est certainement incompatible avec la récupéreration de cette donnée.
• Pour éviter cette erreur dans les logs, il suffit de décocher “Afficher” sur la commande “Température CPU” de votre équipement et Sauvegarder.

Je n’arrive pas à récupérer certaines infos de Synology

Message d’erreur : “Could not chdir to home directory /var/services/homes”

Dans la configuration du NAS Synology, il faut se rendre dans le “Panneau de configuration”, puis “Utilisateurs et groupes”, onglet “Avancé”, et tout en bas du panneau dans la partie “Accueil utilisateur” :

• Cocher la case “Activer le service d’accueil de l’utilisateur”

Comment générer une “clé SSH” permettant de se connecter à un équipement distant ?

Il existe beaucoup de tutoriels sur internet expliquant comment générer ces clés, nous ne verrons ici que quelques principes :

• Le principe de base est de générer un couple “clé privée + clé publique”, en général en utilisant la commande ssh-keygen sur un système Linux.
• La “clé privée” sera à rentrer dans la page de configuration de votre équipement. On peut afficher la clé privée qui a été générée sur un système Linux, via la commande cat .ssh/id_rsa.
• La “clé publique” sera à ajouter à la liste des clés autorisées de l’utilisateur sur le système que vous souhaitez monitorer. En général, on utilise la commande ssh-copy-id user@mamachinedistante pour ajouter cette clé publique sur le système distant.
• La “Passphrase” (phrase secrète) permet de renforcer la sécurité d’une clé SSH en ajoutant un mot de passe qui sera utilisé pour déchiffrer la clé SSH lorsqu’elle est utilisée. Cette phrase secrète est définie au moment de la génération de la clé SSH.

Captures d’écrans

Quelques captures de systèmes monitorés via le plugin :

Debian 10_x86 (VM) :

Debian 10_aarch64 (Odroid C2) :

Debian 11 (VM) :

Debian 12 (VM) :

NAS Synology :

Changelog

Voir le fichier dédié (version stable) : Changelog (Stable)

Voir le fichier dédié (version beta) : Changelog (Beta)