Concept
Ce module permet à l'Arbiter de communiquer avec le Synchronizer pour obtenir la configuration des éléments à superviser. Il est donc indispensable au bon fonctionnement d'une installation Shinken Entreprise.
Il ne faut pas enlever ce module. Dans le cas contraire, l'Arbiter ne pourra plus récupérer de données du Synchronizer. Ni mettre plusieurs modules de type synchronizer-import sur l'Arbiter. |
Activation du module
Le module synchronizer-import est un module qui peut être activé seulement sur le démon Arbiter.
- L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du démon Arbiter.
- Le module ne doit pas être enlevé de la liste des modules de l'Arbiter.
Exemple: par défaut, nous livrons un module dont le nom est "synchronizer-import":
define arbiter {
[...]
modules Module 1, Module 2, Module 3, synchronizer-import
[...]
} |
Pour prendre en compte le changement de configuration, redémarrez l'Arbiter :
Configuration
La configuration du module se trouve par défaut dans le fichier /etc/shinken/modules/synchronizer-import.cfg
- Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/arbiters/modules/synchronizer-import/synchronizer-import-example.cfg
Exemple de fichier de configuration
#================================================================================
# synchronizer-import
#================================================================================
# Daemons that can load this module:
# - Arbiter
# This module is MANDATORY for the Arbiter daemon.
# This module is used by the arbiter to get objects definitions from the synchronizer.
# CFG_FORMAT_VERSION 1
#================================================================================
define module {
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── MODULE IDENTITY ────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Module name [ Must be unique ] [ MANDATORY ] ───
# ─── ───
module_name synchronizer-import
# ─── Module type [ Do not edit ] [ MANDATORY ] ───
# ─── ───
module_type synchronizer-import
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────── SYNCHRONIZER CONNECTION ────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Synchronizer URL ───
# ─── url: http(s) uri for connecting to the synchronizer internal API (by default the 7765 port) ───
# ───
# Default : http://localhost:7765 ───
# ───
arbiter__synchronizer_import__synchronizer_connection__url http://localhost:7765
# ─── Master Key ───
# ─── The master key is an identification key generated at installation time on the Synchronizer, ───
# ─── which allows daemons to identify themselves to the configuration interface as part of the same ───
# ─── installation. ───
# ─── This allows a daemon or module to request the configuration interface. ───
# ─── This value must be the same as master key from /etc/shinken/synchronizer.cfg ───
# ─── ───
arbiter__synchronizer_import__synchronizer_connection__master_key MASTERKEY-SHOULDBECHANGED
# ─── Number of retries when unable to contact Synchronizer ───
# ─── Maximum number of tries for loading the synchronizer configuration before reporting a failure ───
# ───
# Default : 90 ( tries ) ───
# ───
# arbiter__synchronizer_import__synchronizer_connection__max_try 90
# ─── Wait time between retries when unable to contact Synchronizer ───
# ─── Sleep time (in seconds) between two successive tries of loading the synchronizer configuration ───
# ───
# Default : 2 ( seconds ) ───
# ───
# arbiter__synchronizer_import__synchronizer_connection__sleep_time 2
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────── CONFIGURATION REPORTS ─────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Enable configuration reports ───
# ───
# Default : 0 => Disable ( no report will be generated ) ───
# ... : 1 => Enable ( generate reports on Arbiter startup ) ───
# ───
# arbiter__synchronizer_import__configuration_report__enable 0
} |
Détails des sections composant le fichier de configuration
Identification du module
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | synchronizer-import | Paramètre permettant de le différencier d'un autre module du même type. Doit être unique. | |
| Texte | --- | synchronizer-import | Ne peut être modifié. |
Connexion au Synchronizer
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────── SYNCHRONIZER CONNECTION ────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Synchronizer URL ───
# ─── url: http(s) uri for connecting to the synchronizer internal API (by default the 7765 port) ───
# ───
# Default : http://localhost:7765 ───
# ───
arbiter__synchronizer_import__synchronizer_connection__url http://localhost:7765
# ─── Master Key ───
# ─── The master key is an identification key generated at installation time on the Synchronizer, ───
# ─── which allows daemons to identify themselves to the configuration interface as part of the same ───
# ─── installation. ───
# ─── This allows a daemon or module to request the configuration interface. ───
# ─── This value must be the same as master key from /etc/shinken/synchronizer.cfg ───
# ─── ───
arbiter__synchronizer_import__synchronizer_connection__master_key MASTERKEY-SHOULDBECHANGED
# ─── Number of retries when unable to contact Synchronizer ───
# ─── Maximum number of tries for loading the synchronizer configuration before reporting a failure ───
# ───
# Default : 90 ( tries ) ───
# ───
# arbiter__synchronizer_import__synchronizer_connection__max_try 90
# ─── Wait time between retries when unable to contact Synchronizer ───
# ─── Sleep time (in seconds) between two successive tries of loading the synchronizer configuration ───
# ───
# Default : 2 ( seconds ) ───
# ───
# arbiter__synchronizer_import__synchronizer_connection__sleep_time 2 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | http://localhost:7765 | Adresse permettant la connexion à l'API du Synchronizer. Les démons de l'Arbiter et du Synchronizer doivent être sur le même serveur. | |
| Texte | --- | généré à l'installation | La masterkey est une clé d'identification générée à l'installation sur le Synchronizer, qui permet aux démons de s'identifier auprès de l'interface de configuration comme faisant partie de la même installation. Cela permet qu'un démon ou un module requête l'interface de configuration. Ce champ doit avoir la valeur présente dans le fichier /etc/shinken/synchronizer.cfg, sinon le module ne pourra pas s'identifier et importer les éléments. | |
| Nombre | --- | 90 | Permet de spécifier le nombre maximum de tentatives de chargement de la configuration du Synchronizer en cas d'échec. Le Synchronizer peut ne pas être prêt à fournir sa configuration, par exemple s’il n'a pas fini de démarrer. | |
| Nombre | seconde | 2 | Nombre de secondes de délai entre deux tentatives de chargement de la configuration du Synchronizer. |
arbiter__synchronizer_import__synchronizer_connection__sleep_time * arbiter__synchronizer_import__synchronizer_connection__max_try ( par défaut 90 * 2 = 180 secondes ) doit toujours être plus grand que le temps de démarrage et chargement du Synchronizer ( jusqu'à l'arrivée de l'interface ). Sinon l'Arbiter ne démarrera pas. |
Paramètres dépréciés
Les noms de paramètre suivants sont toujours pris en compte, mais ils sont dépréciés au profit des paramètres de la section précédente.
| Si un paramètre est défini à la fois avec son nom normal et son nom déprécié, la valeur associée au nom déprécié du paramètre est ignorée. |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | URL | http://localhost:7765 | Adresse permettant la connexion à l'API du Synchronizer. Les démons de l'Arbiter et du Synchronizer doivent être sur le même serveur. | |
| Texte | --- | généré à l'installation | La masterkey est une clé d'identification générée à l'installation sur le Synchronizer, qui permet aux démons de s'identifier auprès de l'interface de configuration comme faisant partie de la même installation. Cela permet qu'un démon ou un module requête l'interface de configuration. Ce champ doit avoir la valeur présente dans le fichier /etc/shinken/synchronizer.cfg, sinon le module ne pourra pas s'identifier et importer les éléments. | |
| Nombre | --- | 90 | Permet de spécifier le nombre maximum de tentatives de chargement de la configuration du Synchronizer en cas d'échec. Le Synchronizer peut ne pas être prêt à fournir sa configuration, par exemple s’il n'a pas fini de démarrer. | |
| Nombre | secondes | 2 | Nombre de secondes de délai entre deux tentatives de chargement de la configuration du Synchronizer. |
Rapports sur la configuration
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────── CONFIGURATION REPORTS ─────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Enable configuration reports ───
# ───
# Default : 0 => Disable ( no report will be generated ) ───
# ... : 1 => Enable ( generate reports on Arbiter startup ) ───
# ───
# arbiter__synchronizer_import__configuration_report__enable 0 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Booléen | --- | 0 | Activer la génération des rapports sur la configuration
|
- Lorsque la génération des rapports est activée, à chaque démarrage de l'Arbiter principal ( donc, lorsqu'une configuration est générée ), le module alimentera un fichier au format NOMDELICENCE__ANNEE__nodes-report.csv en y ajoutant une ligne contenant :
- la date et l'heure de génération de la configuration,
- le nombre de nœuds dans la configuration,
- une signature relative à la configuration ( pour vérifier la validité de la ligne ).
- Le fichier de rapport est généré dans le répertoire /var/lib/shinken-user/licence/reports