Qu'est-ce que le shinken-healthcheck ?
Le shinken-healthcheck est une commande présente dans toute installation Shinken Entreprise qui permet de vérifier le bon fonctionnement de Shinken Entreprise.
Cet outil est utilisé pour vérifier :
- L'état de l'installation de Shinken Enterprise ( version des démons ).
- L'état des principales options de configuration réseau ( ports, adresses ).
- L'état des modules et sous-modules activés sur les démons.
- L'état des connexions réseau et la synchronisation d'horloge entre les démons.
Le shinken-healthcheck est donc un outil de diagnostic général qui peut détecter les problèmes les plus importants. Cependant, il ne fournit pas autant d'informations et de détail que les checks fournissent par Shinken pour sa propre supervision, par exemple des indicateurs de performance.
Usage
shinken-healthcheck
Principales options
| Option | Option longue | Description |
|---|---|---|
| -h | --help | Affiche le message d'aide |
| -v | --version | Affiche la version de Shinken Entreprise installée |
| -l | --local | Effectue une vérification des démons locaux seulement |
| -g | --global | Effectue une vérification complète des démons ( doit être lancé depuis la machine comportant l'Arbiter et le Synchronizer ). Par défaut sur une machine avec un Arbiter et un Synchronizer, un Healthcheck global est effectué sauf si un Healthcheck local est explicitement demandé. |
| --debug | Active l'affichage des données de debug dans la sortie de la commande. Cette option est utile seulement dans le cas d'un envoi de ces données aux équipes de support de Shinken Solutions. | |
| -f | --file | Écris la sortie de la commande dans un fichier. La sortie de la commande est également affichée. |
| --output-directory | Dossier dans lequel sera placé le fichier de sortie. Par défaut, le dossier courant est utilisé. | |
| --output-name | Fichier dans lequel sera placé le fichier de sortie. Valeur par défaut: shinken-healthcheck_$(DATE).txt | |
| --timeout | Temps en secondes à partir duquel un démon sera considéré comme injoignable. Par défaut: 3 secondes | |
| --modules-warning-expire | Temps en minutes pendant lequel un redémarrage de module génère une alerte. Par défaut :120 ( 2 heures ), valeur maximale :1440 (24 heures) | |
| --show-history | Affiche l'historique des installations et données de Shinken Entreprise sur ce serveur |
La commande Shinken-healthcheck sépare sa vérification en plusieurs parties qui sont décrites dans les sections suivantes.
Lancement centralisé de toute l'architecture ou local uniquement
La commande shinken-healthcheck peut être utilisée dans deux modes de fonctionnements différents :
- Vérification globale de toute l'architecture
- Ce mode est le mode par défaut de la commande
- La commande vérifie l'ensemble des serveurs à distance et local, telle que définie dans ses fichiers .cfg
- Peut être lancé avec l'option --global ou -g
- Vérification locale
- Ce mode vérifie que les démons locaux à la machine, sans vérifier les notions de royaumes
- Ce mode est automatiquement sélectionné quand :
- On est sur le serveur de l'Arbiter spare
- On est sur un serveur qui n'a pas d'Arbiter
- Peut être lancé avec l'option --local ou -l
Informations de version
L'option --version ou -v nous donnes les informations suivantes :
- Original installed version : C'est la toute première version de Shinken qui a été installée
- Updated version : C'est la version actuelle de Shinken
- Updated patch : C'est le nom du patch actuellement installé. Si aucun patch est installé, alors cette ligne ne s'affiche pas
Vérification de l'architecture
Etat des démons
Le Shinken-healthcheck affiche ensuite pour tous les démons activés dans la configuration, différentes informations indiquant le bon fonctionnement du démon:
- Le type et le nom du démon. Si celui est un Spare, une mention "SPARE" est présente à la suite du nom du démon.
- La configuration est-elle valide ?
- Le démon est-il joignable sur le port trouvé dans la configuration ?
- La version actuelle du démon. S’il y a une différence de version entre l'Arbiter et le démon, un message d'erreur indique cette différence.
- Connexion avec l'Arbiter, ainsi que le décalage de temps entre le démon et l'Arbiter.
- Si plusieurs Arbiters envoient une configuration au démon, un message d'erreur indique qu'un ou plusieurs Arbiters sont en conflit, en précisant l'ip de chacun de ces Arbiters.
- Liste des autres démons à contacter pour pouvoir fonctionner correctement ( section "Talk to" ).
- État des modules, et le cas échéant des sous-modules. Si un module a redémarré récemment, un avertissement sera affiché en indiquant la liste des derniers redémarrages du module ou sous-modules.
- Champs spécifiques au démon
- Liste des tags pour le Poller et Reactionner ainsi que les éventuelles erreurs sur les workers.
Dans l'affichage de l'état des démons, ainsi que dans les sections suivantes, plusieurs états peuvent être retournés:
- OK : Tout va bien
- AT RISK : Problème pouvant potentiellement nuire au fonctionnement du système.
- ERROR : Une erreur bloquante a été détectée.
Cas spécifique au Synchronizer - Vérification du statut du chiffrement des propriétés et données protégées
La sous-section "Encryption status" donne des informations sur le chiffrement des propriétés et données protégées :
- Protection activée ou pas ( et nom de la clé si elle est activée )
- Si la clé n'a pas été sauvegardée ou si la clé ne peut pas être chargée, une erreur est affichée
- S’il y a une incohérence de configuration du chiffrement ( voir la page : Mécanismes de sécurisation du chiffrement ), le message d’erreur correspondant sera affiché.
Royaumes et sous-royaumes
Dans une configuration de Shinken Entreprise, les démons peuvent être répartis sur plusieurs machines.
Dans la commande shinken-healthcheck, les démons sont regroupés en fonction de la machine sur laquelle ils sont installés.
On voit dans l'exemple ci-dessous qu'un Poller est installé sur la machine d'adresse 192.168.1.35, et qu'un Arbiter et un Broker sont installés et activés sur la machine vm3 ( 172.16.0.3 ).
Si plusieurs royaumes sont définis, la sortie de Shinken-healthcheck organise les machines par royaume et sous-royaumes, puis les démons sont répartis par machine d'installation.
Dans l'exemple ci-contre, on voit que la configuration comporte 4 royaumes, agencés comme suivant:
- Un royaume principal: France
- Un sous Royaume: Corse
- Un sous Royaume: Sud Ouest
- Un sous Royaume: Bordeaux
On voit aussi, pour chaque royaume, les démons activés ainsi que la machine sur laquelle ils sont installés. Dans l'exemple de Shinken-healthcheck, on peut faire le récapitulatif suivant:
- Royaume France: 8 démons répartis sur 2 machines
- Machine d'adresse a.a.a.a: Poller
- Machine master1 (b.b.b.b): Arbiter, Broker, Poller, Reactionner, Synchronizer, Receiver, Scheduler
- Royaume France/Corse: 3 démons installés sur une seule machine
- Machine master2 (d.d.d.d): Broker, Poller, Scheduler
- Royaume France/Sud Ouest: Un démon installé sur une machine
- Machine master2: Broker
- Royaume France/Sud Ouest/Bordeaux: 2 démons installés
- Machine master2: Poller, Scheduler
Vérification de la licence
Cette section du Shinken-healthcheck affiche des informations sur la licence en cours.
Elle affiche le propriétaire de la licence, le type de licence, et la date d'expiration de la licence.
Si le nombre de nœuds est dépassé ou que la licence est expirée, une erreur sera affichée dans cette section.
A noter que cette section ne s'affiche que sur les serveurs hébergeant un Arbiter ou un Broker.
Vérification des bibliothèques externes
Shinken Entreprise utilise de nombreuses librairies externes pour fonctionner.
La partie Local Libraries du Shinken-healthcheck fournie les informations suivante pour les bibliothèques nécessaires au fonctionnement de Shinken Enterprise :
- Si elles sont bien présentes
- La version de python dans laquelle la bibliothèque est installée
- La version de la bibliothèque
- La liste des dépendances de la bibliothèque et leur version
En cas d'erreur concernant l'une des bibliothèques, un message d'erreur est affiché indiquant la nature de l'erreur.
Vérification des espaces de stockage
Graphite
Shinken Entreprise sauvegarde les données de métrologie dans un serveur Graphite. Si la configuration de la sauvegarde des données de métrologies est simple pour une configuration basique, elle devient rapidement compliquée lorsque la configuration comporte plusieurs royaumes avec plusieurs Brokers.
Lorsque plusieurs Brokers sont dans un même royaume,
- il faut s'assurer que les Brokers n'écrivent pas les données de métrologie au même endroit ( sur le ou les mêmes serveurs Graphite ).
- Il faut également vérifier que toutes les interfaces de Visualisation d'un broker lisent les données de métrologie de tous les royaumes et sous-royaume que le broker gère, afin d'assurer une cohérence des données.
- Aussi, il faut s'assurer de ne pas avoir oublié de configurer au moins un broker d'un royaume pour écrire les données de métrologie dans la base Graphite, sans quoi aucune donnée de métrologie ne sera sauvegardée pour ce royaume.
La commande Shinken-healthcheck possède une section dédiée à la vérification des espaces de stockage des données de métrologie, qui vérifie que les brokers de chaque royaume sont configurés pour sauvegarder les données, que tous les modules Webui sont configurés correctement pour lire les données stockées dans les serveurs graphite de chaque royaume ou sous-royaume et que les serveurs de métrologie sont effectivement joignables et aptes à sauvegarder des données.
Pour cette partie, nous allons utiliser une configuration avec un royaume par défaut ( Metropole ) et deux sous royaumes ( Corse et Reunion ).
Vérification de la configuration de la sauvegarde des données de métrologie
La première section de la vérification vérifie qu'il y a au moins un broker pour chaque royaume ou sous-royaume configuré pour sauvegarder les données de métrologie.
Dans l'exemple ci-contre, nous pouvons voir qu'il y a un broker configuré par royaume, pour sauvegarder les données métrologie sur deux serveurs graphite différent :
- Les données métrologie du royaume France sont stockées par le broker broker-france sur le serveur graphite 192.168.1.23
- Les données métrologie du royaume Bordeaux sont stockées par le broker broker-bordeaux sur le serveur graphite 192.168.1.131
Si un royaume n'est configuré sur aucun Broker sauvegardant les données de métrologie, une erreur sera affichée.
On note que s'il n'y a aucun hôte à superviser dans le royaume, le Broker n'a pas besoin de sauvegarder de données de métrologie, et donc ne sera pas indiqué en erreur s'il ne sauvegarde pas de données dans Graphite.
Vérification de la configuration pour la lecture des données de métrologie
Cette section vérifie que chaque module webui a configuré pour chaque royaume ( ou sous royaume ) un serveur graphite que gère le broker.
Dans l'exemple ci-dessous, nous pouvons voir que la vérification de configuration de la lecture s'effectue pour module webui de chaque broker et que pour chaque module, la commande shinken-healthcheck teste la configuration pour les différents royaumes présents sur le broker.
Si un royaume est inconnu ou non géré par le broker, la vérification retournera une erreur pour ce royaume.
Vérification du bon fonctionnement des serveurs graphite
Cette section présente tous les serveurs graphite répertoriés lors de la lecture de la configuration. Un serveur est déterminé par les modules de type "graphite_perfdata" utilisés et également par les graphite_backend de chaque module de type "webui" utilisées.
Chaque serveur graphite est identifié de manière unique par son adresse IP : il est possible que le module "graphite_perfdata" utilise un nom DNS et le module "Webui" une adresse IP. Si les modules utilisent l'adresse de boucle locale ( 127.0.0.1 ), elle sera également remplacée par l'adresse IP du broker sur lequel il tourne.
Pour chaque serveur deux catégories sont affichées : la partie écriture et la partie lecture.
La partie écriture ( Write connexion status ) affiche :
- Le port utilisé pour la communiquer avec le service carbon-cache.
- L'état de la connexion pour chaque module de type "graphite_perdata" qui est configuré pour écrire sur ce serveur.
- Le port utilisé par ce serveur est affiché en information si les connexions des modules sont OK ( sinon il sera absent ).
- Les royaumes qui sont écrits sur ce serveur sont affichés en information si les connexions des modules sont OK ( sinon il sera absent ).
- Si aucun module n'écrit d'information, cela sera affiché en AT RISK .
La partie lecture ( Read connection status ) affiche :
- Le port utilisé pour la communiquer avec le service Graphite.
- L'état de la connexion pour chaque module de type "Webui" qui est configuré pour lire des données sur ce serveur.
- Le nombre d'hôtes qui est accessible sur ce serveur est affiché en information si les connexions des modules sont OK ( sinon il sera absent ).
- Si aucun module ne lit d'informations sur ce serveur, cela sera affiché en AT RISK .
Affichage lorsque la gestion des données de performance est désactivé
Lorsque dans la configuration avancée de Shinken ( voir la page : Configuration avancée ( shinken.cfg ) ) l'option de gestion des données de performance ( process_performance_data ) est désactivée, la section "graphite" de la commande Shinken-healthcheck va :
- Informer que la fonctionnalité de gestion des données de performance est désactivée
- Mettre un AT RISK pour chaque broker ayant un module "graphite_perfdata" configuré
Vérification des addons
La section suivante du Shinken-healthcheck affiche l'état des différents addons actifs sur la machine.
La liste des addons actuellement activés est affichés, avec pour chacun, leur statut ainsi que l'état de différentes vérifications.
Puisque les addons peuvent avoir chacun un fonctionnement différent, les vérifications effectuées diffèrent selon l'addon.
Structure des royaumes
L'avant-dernière section du Shinken-healthcheck l'état de la structure des royaumes.
Si la configuration des royaumes est erronée, les autres vérifications ne sont pas faites et seule cette erreur est affichée.
La copie d'écran montre une erreur, car deux royaumes ont été définis comme royaumes par défaut.
Récapitulatif du healthcheck
Cette dernière section fait résume le nombre d'erreurs, d'informations et de AT RISK présent dans le résultat du Shinken-healthcheck. Cette section permet à l'utilisateur de ne plus faire défiler toutes les lignes du résultat afin de vérifier s'il y a des erreurs ou des avertissements.
Dans notre exemple, nous pouvons savoir aisément qu'il y a 4 erreurs et un avertissement dans le résultat du Shinken-healthcheck.
Historique des installations et de la configuration
Le Shinken-healthcheck affiche par défaut la version initiale d'installation ainsi que la version actuellement installée.
Il est possible d'obtenir des informations supplémentaires sur l'historique de l'installation en utilisant l'option "--show-history" de la commande "shinken-healthcheck":
shinken-healthcheck --show-history
Ce paramètre affiche des informations sur l'évolution de Shinken Entreprise depuis son installation initiale.
L'utilisation de cette option est surtout pratique lorsque vous communiquez avec le support Shinken, qui utilisera les informations remontées pour plus facilement retrouver l'origine de votre problème.
Historique des mises à jour
L'option --show-history affiche d'abord une liste triée chronologiquement des différentes versions de Shinken installées et désinstallées sur la machine courante.
On peut donc voir facilement, pour une date donnée, quelle était la version de Shinken installée.
Cette option est également utile pour communiquer avec le support Shinken, pour détecter des erreurs de configuration liées à d’anciennes versions de Shinken.
Description des champs de la sortie de l'historique :
| Action | Description | Détails |
|---|---|---|
| INSTALLATION | Première installation de Shinken. |
|
| PATCH | Mise à jour de Shinken. |
Le nom de la version à la ligne correspond à la version vers la quelle la mise à jour est faite. |
| UNPATCH | Désinstalle une mise à jour. |
Le nom de la version à la ligne correspond à la version du patch désinstallé. |
Historique des données
Après l'historique des installations vient l'historique des données de Shinken. Cet historique des données est séparé en plusieurs sections correspondantes chacune à un type de donnée différente :
- Configuration : configuration de Shinken, élément de supervision
- SLA : historique des états des éléments supervisés et données de SLA
- Métrologie : métriques
- Données utilisateurs : données sauvegardées dans l'interface de visualisation
- Modules : configuration des modules
| Action | Description | Détails |
|---|---|---|
| INSTALLATION | Première installation de Shinken. |
|
| UPDATE | Mise à jour de Shinken. |
|
| sanatize | Exécution du script de nettoyage des données. Retravaille les données lors d'une mise à jour ou restauration pour les rendre compatibles avec la version installée / restaurée. |
|
| RESTORE | Restauration d'une sauvegarde. Le type de données restaurées dépend des options utilisées lors du script de restauration. ( Voir la page : Shinken-backup et Shinken-restore, les commandes de sauvegarde et de restauration ) |
|
Historique des paramètres de chiffrement des données
Le dernier type d'information remonté par l'option --show-history est l'historique des paramètres de chiffrement des données sensibles.
À chaque fois que les paramètres de chiffrement sont modifiés et déclenchent un changement dans le chiffrement des données ( activation, désactivation, changement des champs chiffrés ), une entrée sera ajoutée dans la liste des modifications.
L'état d'activation, le nom de la clé utilisée, l'état de sauvegarde de la clé ainsi que la liste des définitions des données à chiffrer sont affichés pour chaque entrée de la liste.
Notez que le statut de sauvegarde de la clé peut être différent du statut affiché dans la section [Encryption Status] :
- Dans la section [Encryption Status], Shinken-healthcheck affiche l'état actuel.
- Dans l'historique, Shinken-healthcheck affiche l'état au moment de la modification de la configuration.
Seuls les cinq derniers changements sont conservés.
