Description
Le module PickleRetentionFile est un module de rétention qui permet de stocker dans un fichier les différents statuts et contextes des éléments de Shinken. Après un redémarrage, les éléments récupèreront leurs statuts à partir de ce qui a été stocké par le module.
Pour plus d'explication sur le principe de la rétention, voir Rappel du fonctionnement de la rétention.
Activation du module
Ce module ne peut être activé que sur un Scheduler.
- L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du démon Scheduler.
- Pour se faire, ouvrez le fichier de configuration du Broker à l'emplacement /etc/shinken/schedulers/nom_du_scheduler.cfg, et ajoutez le nom de votre module "
PickleRetentionFile".
Exemple: par défaut, nous livrons un module dont le nom est "PickleRetentionFile".
define scheduler {
[...]
modules PickleRetentionFile
[...]
} |
Pour prendre en compte le changement de configuration, redémarrez l'Arbiter:
service shinken-arbiter restart |
Le module PickleRetentionFile ne peut pas être utilisé avec toutes les architectures. Les différents cas d'utilisation sont expliqués en détail dans la page Configurer la rétention des données |
Rappel du fonctionnement de la rétention
Dans Shinken Entreprise, lorsque des éléments sont en supervision, des vérifications régulières sont effectuées sur les hôtes, clusters et checks.
Suite à ces vérifications, un statut (OK, Attention, Critique, Inconnu) ainsi qu’un ou plusieurs contextes (Flapping, Période de maintenance, Prise en compte) sont attribués à chaque élément.
Sans rétention, lorsque Shinken doit être redémarré (maintenance du serveur de supervision, ou bien mise à jour de Shinken), ces statuts et contextes sont perdus, et les éventuelles notifications déclenchées sur un état non voulu seront envoyées !
Activer la rétention permet de conserver les états des hôtes, clusters et checks entre les redémarrages de Shinken et ainsi bénéficier d'une vision claire de l'état des éléments supervisés à tout moment.
Cette rétention s'effectue au niveau du démon Scheduler qui est chargé d'ordonnancer la vérification des éléments et de récupérer et analyser les résultats de ces vérifications.
Pour plus d'informations sur le fonctionnement de la rétention dans Shinken voir La rétention des données des Schedulers
Les données sauvegardées
Pour chaque élément (hôte, check ou cluster) activé dans la configuration, les données suivantes sont sauvegardées :
| Type de donnée | Commentaire |
|---|---|
| Identifiant unique de l'élément | L'UUID est un champ interne à Shinken permettant d'identifier un élément (hôte, check ou cluster) de manière unique |
| Données d'ordonnancement | Date de la dernière et de la prochaine vérification |
| Statut actuel | Statut actuel de l'élément |
| Dernier changement de statut | Date du dernier changement de statut et statut précédent |
| Contexte | Indique si l'hôte est en Flapping, à une Prise en compte ou des périodes de maintenance. Dans le cas des Périodes de maintenance et des Prises en compte, l'auteur, date et commentaire sont également sauvegardés. |
| Résultat et résultat long | Résultat et résultat long de la dernière vérification |
| Contacts | Ensemble des contacts (identifiés par leur nom) qui ont reçu une notification concernant l'élément |
| Problèmes sources | Lorsque l'élément possède des liens avec d'autres éléments, lorsque cet élément est en erreur, l'identifiant unique des autres éléments affectés est également sauvegardé. Aussi, si un élément en erreur a affecté l'élément actuel, l'identifiant unique de l'élément source du problème est sauvegardé. |
Configuration
La configuration du module se trouve par défaut dans le fichier /etc/shinken/modules/pickle-retention-file.cfg
Exemple de fichier de configuration
#===============================================================================
# PickleRetentionFile
#===============================================================================
# Daemons that can load this module:
# - scheduler
# This module save scheduler retention data (element state and scheduling) into a file
#===============================================================================
define module {
#======== Module identity =========
# Module name. Must be unique
module_name PickleRetentionFile
# Module type (to load module code). Do not edit.
module_type pickle_retention_file
#======== Data path =========
# path: file path to save/load data
path /var/lib/shinken/retention.dat
}
|
Détails des sections composant le fichier de configuration
Identification du module
Il est possible de définir plusieurs instances de module de type PickleRetentionFile dans votre architecture Shinken.
- Chaque instance devra avoir un nom unique.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | PickleRetentionFile | Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir. Doit être unique. | |
| Texte | --- | pickle_retention_file | Ne peut être modifié. |
Emplacement des données de rétention
Il est possible de définir l'emplacement et le nom du fichier de rétention via un paramètre.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | /var/lib/shinken/retention.dat | Emplacement du fichier de rétention |
Détails de l'emplacement des données de rétention
Le fichier utilisé par le module PickleRetentionFile est le suivant :
/var/lib/shinken/retention.dat_--_realm--ROYAUME_--_scheduler--SCHEDULER_--_id--ID-LOCAL-SCHEDULER.retention |
Ce fichier peut atteindre, suivant votre architecture, de quelques dizaines de Kilo-octets à plusieurs Méga-octets.
Ce fichier n'est pas lisible via un éditeur de texte.
Il possède le nom du royaume, le nom du Scheduler ainsi que son ID local à la machine (obtenable avec la commande shinken-daemons-list). En cas de changement de nom de royaume, ou de nom de Scheduler ou d'ID local, le démon Scheduler tente de retrouver ses données avec son royaume, nom ou id actuel, et prend le fichier le plus proche et récent qu'il trouve.
Voici un exemple de fichier depuis un terminal :
|
