Import des modules depuis /var/lib/shinken/modules - chapitre [ MODULE-CODE-LOADING ]

Les démons vont lister les répertoires dans /var/lib/shinken/modules et vont tenter de charger chaque module.

Chargement du code des modules

Ce log en INFO annonce que le démon va commencer à charger ces modules un par un.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CODE-LOADING ] [ directory=architecture-export ] Starting to load the module code directory /var/lib/shinken/modules/architecture-export.

Ensuite démon va tenter de charger le code du module :

• Si le démon n'arrive pas à charger le code du module un log en ERROR sera affiché.
  

  [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CODE-LOADING ] [ directory=architecture-export ] Failed to load the directory [architecture-export] as a python module.

  
  

• Si le démon ne trouve pas de fichier module.py un log en ERROR sera affiché avec le PATH du fichier.

  [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CODE-LOADING ] [ directory=architecture-export ] - because of missing file :[PATH_DU_FICHIER].

  
  

• S'il manque le dictionnaire Python listant les propriétés du module dans module.py un log en ERROR sera affiché.

  [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CODE-LOADING ] [ directory=architecture-export ] Bad module file for FILE_NAME : missing properties dict.

  
  

• Si le démon à eu une exception Pyhton durant l'import le chargement du code du module un log en ERROR sera affiché avec l'exception.

  [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CODE-LOADING ] [ directory=architecture-export ] Importing module architecture-export: EXCEPTION.

  
  

• Si le code du module chargé contient un import alors un log en WARNING sera affiché.

  [YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CODE-LOADING ] [ directory=architecture-export ] - 'import architecture-export.my_file' will not work in your module.py file.

  
  

Une fois les modules chargé il y a un résumé qui est affiché en INFO avec les modules éligibles à ce démon / module.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CODE-LOADING ] A total of 9 Shinken Enterprise modules are available for this daemon/module (broker): broker-module-livedata, event-container, graphite-perfdata, livestatus, simple-log, sla, trending, webui, MODULE-CODE-NAME (on a total of 40, loaded in 1.844s)

Création du module - chapitre [ MODULE-CREATION ]

Une fois le code python chargé, on demande au démon de créer les modules, de les démarrer et de démarrer son ou ces Worker(s).

Création de l'instance du module

Le démon va essayer de créer l'instance du module :

• Si le code du module ne contient pas la fonction "get_instance()" ou qu'elle ne retourne rien un log en ERROR sera affiché.

  [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ] FAIL The module get_instance() call did not return any instance.

  
  

• Si le démon a réussi à charger le code du module mais n'a pas réussi à créer l'instance alors un log en ERROR sera affiché avec l'exception Python concerné.

  [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ] [0.046s] FAIL The module creation did fail with an exception: EXCEPTION. Remove this module currently, will try to recreate it in the future.

  
  

Si l'instance a bien été créée alors un log en INFO sera affiché son temps de création.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ]  [0.046s] SUCCESS The module instance is created.

Démarrage du module

Une fois le module créé le démon va essayer de la démarrer. Ce log sera en INFO.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ]  Trying to init module.

Si le démon a réussi à créer son module mais n'a pas réussi à le démarrer alors 3 logs apparaîtrons :

1. Un log en ERROR expliquant que le module n'a pas réussi à se démarrer suivie du message de l'exception Python puis de l'exception en question. 

   [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ] The module failed to init and he raised an exception: EXCEPTION.

   
   

2. Un log en WARNING indiquant le nombre de fois que le démon à essayer de démarrer son module sans succès. Le compteur se remet à zéro des lors que le démon à réussi à démarrer son module.

   [YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ] The module tried to start: 5 times.

   
   

3. Un log en WARNING indiquant quand est-ce que le démon va essayer de redémarrer son module (Maximum une minute).

   [YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ] The module will try to restart at 16:32:18.

   
   

Un log en INFO  apparaîtra si le démon a réussi à démarrer son module.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ]  SUCCESS The module is started.

Démarrage du/des Worker(s) du module

Une fois le module démarré le démon va essayer de démarrer son/ses Worker(s). Ce log sera en INFO.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ]  Starting a worker(s).

Si le démon n'a pas réussi à démarrer le/les Wroker(s) du module :

1. Et qu'il a levé une exception lors du démarrage alors un log en ERROR sera affiché disant que le démon n'a pas réussi à démarrer le/les Worker(s) du module avec le message de l'exception.

   [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ] The worker(s) failed to init and he raised an exception: EXCEPTION.

   
   

2. Alors un log en ERROR sera affiché disant que le démon n'a pas réussi à démarrer le/les Worker(s) du module.

   [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ] The worker(s) failed to init.

   
   

Si le/les Worker(s) du module ce sont bien démarrer alors ce log en INFO apparaîtra.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CREATION ] [ WebUI ] [ module-type=webui ]  SUCCESS The worker(s) is created.

Changement de configuration ou d'état du module - chapitre [ MODULE-CHANGE ]

Rajout d'un nouveau module dans un démon

Lorsqu'un démon reçoit un nouveau module, on va avoir un log en INFO comme quoi le module à été ajouter à la configuration du démon.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CHANGE ] [ WebUI ] Launching a new module as it was added in the daemon configuration.

Suppression d'un module dans un démon

Lorsqu'un utilisateur enlève un module de la configuration du démon, on va avoir un log en INFO informant que l'on supprime le module car il n'est plus dans la configuration du démon.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [MODULE-CHANGE ] [ WebUI ] Removing the module because it is removed from the configuration.

Si le démon a essayé de supprimer un module mais qu'il ne la pas trouver dans ses instances alors un log en WARNING sera affiché.

[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CHANGE ] [ WebUI ] Trying to remove the module %s but it is not found in the current instances: INSTANCES

Changement de configuration d'un module (et sa relance)

Le démon a détecté que la configuration de son module n'est plus la même qu'avant il annonce avec un log INFO qu'il va redémarrer son module afin de prendre la nouvelle configuration en compte.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CHANGE ] [ WebUI ] Configuration of the module did change so we restart it.

Le module n'a pas réussi à se mettre à jour

Le démon à trouver une nouvelle configuration venant d'un ancien ou d'un nouveau module mais il n'arrive pas à le mettre à jour. Le démon vous l'informe avec un log en ERROR.

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CHANGE ] [ WebUI ] Cannot find previous or new module definition for the module name WebUI, so cannot update it.

Arrêt du module en cours d’exécution - chapitre [ MODULE-CRASH ]

Le module s'est arrêté de façon inattendu

Lorsqu'un module externe n'est plus en cours d’exécution et qu'il s'est éteint de façon inattendue le démon affichera un log en ERROR.

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CRASH] [ synchronizer-module-database-backup ] [ module-type=synchronizer_module_database_backup ] The external module synchronizer-module-database-backup goes down unexpectedly!

Lorsqu'un ou plusieurs Worker(s) d'un module externe n'est ou ne sont plus en cours d’exécution et qu'il s'est ou qu'ils se sont éteint(s) de façon inattendue le démon affichera un log en ERROR.

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CRASH] [ synchronizer-module-database-backup ] [ module-type=synchronizer_module_database_backup ] The module synchronizer-module-database-backup worker(s) goes down unexpectedly!

Si un module a pu prévenir lors de son arrêt (par exemple la WebUI détecte qu'elle a un problème avec ses fichiers .html ou .js, elle peutprévenir le démon avant de s’arrêter), on aura le log explicatif en ERROR issu du module.

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CRASH ] [ WebUI ] [ module_type=webui ] The __shinken_lang__ variable was not found in the index.html file: there is a critical error with your installation. Please open a ticket to your support.

Le module à un comportement anormal

Lorsqu'un module externe à une taille de Queue plus élevé que la taille maximale définie dans la configuration du démon un log sera affiché en ERROR.

QUEUE_SIZE = Taille ( en nombre d'éléments ) de la liste d'attente. Éléments possibles : Commande(s) ou retour de commande(s).

QUEUE_MAX_SIZE = Taille ( en nombre d'éléments ) maximale de la Queue définie dans le fichier ini du démon. ( paramètre max queue size).

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ MODULE-CRASH] [ synchronizer-module-database-backup ] [ module-type=synchronizer_module_database_backup ] The external module synchronizer-module-database-backup got a too high brok queue size (QUEUE_SIZE > QUEUE_MAX_SIZE)!