Page History

Scroll Ignore

scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	true

Panel

title	Sommaire

Table of Contents

style	none

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'explications sur le principe de la rétention, voir le paragraphe 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 ce 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".

Code Block

language	js

define scheduler {
    [...]
    modules                   PickleRetentionFile
    [...]
}

Pour prendre en compte le changement de configuration, redémarrez l'Arbiter:

Code Block

theme	Emacs

service shinken-arbiter restart

Note
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 le chapitre sur la configuration de la page Configurer la rétention dans la page expliquant le mécanisme de rétention des Schedulers ( voir la page La rétention des données des Schedulers ).

Anchor
retention
retention

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 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. Voir la page du Scheduler pour plus d'informations : Scheduler

Pour plus d'informations sur le fonctionnement de la rétention dans Shinken voir la page : 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

Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/schedulers/modules/pickle-retention-file/pickle-retention-file-example.cfg

Exemple de fichier de configuration

Code Block

language	js

#===============================================================================
# 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 =========
    # File path prefix to save/load data. This means that the actual retention
	# files will be located in /var/lib/shinken and will begin by retention.dat
	# Here is an example of complete file name :
	# /var/lib/shinken/retention.dat_--_realm--REALM_NAME_--_scheduler--SCHEDULER_NAME_--_id--ID-LOCAL-SCHEDULER.retention
    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.

Warning
Il est conseillé de n'avoir plusieurs modules de rétention que dans le cas d'une migration. (Ex: passage d'un emplacement path1 à un emplacement path2, on aura un module PickleRetentionFile avec le path1, un autre avec le path2, on désactivera alors le premier module pour le prochain redémarrage)

Nom

Type

Unité

Défaut

Commentaire

Code Block
module_name

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.

Code Block
module_type

Texte

---

pickle_retention_file

Ne peut être modifié.

Emplacement des données de rétention

Code Block

language	js

	#======== Data path ========= 
	# File path prefix to save/load data. This means that the actual retention
	# files will be located in /var/lib/shinken and will begin by retention.dat
	# Here is an example of complete file name :
	# /var/lib/shinken/retention.dat_--_realm--REALM_NAME_--_scheduler--SCHEDULER_NAME_--_id--ID-LOCAL-SCHEDULER.retention  
	path /var/lib/shinken/retention.dat

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

Code Block
path

Texte

---

/var/lib/shinken/retention.dat

Préfixe du chemin vers lequel est sauvegardée la rétention Pickle.

Par exemple avec la valeur par défaut, les fichiers de rétention Pickle seront enregistrés dans le répertoire /var/lib/shinken/ et commenceront par retention.dat.

Voici un exemple complet d'un nom de fichier de rétention Pickle :

/var/lib/shinken/retention.dat_--_realm--REALM_NAME_--_scheduler--SCHEDULER_NAME_--_id--ID-LOCAL-SCHEDULER.retention

Info
Plus d'informations sur le nom des fichiers dans la section suivante.

Anchor

	pickleRetentionPath
	pickleRetentionPath

Détails de le chemin des données de rétention

Le nom des fichiers créés par le module PickleRetentionFile respecte ce format :

Code Block

theme	Emacs

/var/lib/shinken/retention.dat_--_realm--REALM_NAME_--_scheduler--SCHEDULER_NAME_--_id--SCHEDULER_ID.retention

Nom

Exemple

Description

Code Block
REALM_NAME

All

Nom du royaume sauvegardé dans la rétention.

Code Block
SCHEDULER_NAME

scheduler-master

Nom du Scheduler qui a effectué la rétention.

Code Block
SCHEDULER_ID

0

Id du Scheduler qui a effectué la rétention.

Pour récupérer l'identifiant d'un démon, il faut lancer la commande :

Code Block

theme	Emacs

shinken-daemons-list

Voici un exemple complet de nom de fichier :

Code Block

theme	Emacs

/var/lib/shinken/retention.dat_--_realm--all_--_scheduler--scheduler-master_--_id--0.retention

Info

En fonction de votre configuration ( en fonction du nombre de royaumes et de Schedulers que vous avez ) il peut y avoir plusieurs fichiers dans le dossier /var/lib/shinken/.

Pensez à vérifier que vous avez sauvegardé tous les fichiers.

Note

Ce Suivant votre architecture, 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.

Page tree

Versions Compared

Old Version 38

New Version Current

Key

Description

Activation du module

Anchor
retention
retention

Rappel du fonctionnement de la rétention

Les données sauvegardées

Configuration

Exemple de fichier de configuration

Détails des sections composant le fichier de configuration

Identification du module

Emplacement des données de rétention

Détails de le chemin des données de rétention

Page tree

Page History

Versions Compared

Old Version 38

New Version Current

Key

Description

Activation du module

AnchorretentionretentionRappel du fonctionnement de la rétention

Les données sauvegardées

Configuration

Exemple de fichier de configuration

Détails des sections composant le fichier de configuration

Identification du module

Emplacement des données de rétention

Détails de le chemin des données de rétention

Anchor
retention
retention

Rappel du fonctionnement de la rétention