Page History

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

Chaque démon va démarrer son "modules-manager" qui va lister les répertoires dans /var/lib/shinken/modules et va charger chaque module présent.

Chargement du code

Le "modules-manager" va commencer à charger son module et ne logguera que si s'il rencontre un problème.

Si le "modules-manager" rencontre un problème durant le chargement du module, un log en ERROR avec l’exception Python sera affiché et le module ne sera pas importé.

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-exportmy_broker_module ] Import module [architecture-exportmy_broker_module] failed: EXCEPTION.

Chargement du module en tant que module Python ( Spécifique Python )

Une fois que Lors du chargement du code le "modules-manager" à charger le code du module, il  va vérifier si le module peut être importé en tant qu'un module package Python.

Si le "modules-manager" ne peut pas importer le code du module en tant que module python alors

un logs en

Un premier log expliquant que le "modules-manager" n'a pas réussi à importer le module en tant que python module.

INFO sera affiché.

[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=my_broker_module ] Failed to import the directory /var/lib/shinken/modules/my_broker_module as a python module.

Si le "modules-manager" ne peut pas importer le code du module en tant que package Python et qu'un import d'un fichier du module à un autre est fait, 3 Logs en ERROR seront affiché et le module ne sera pas chargé.

• Un premier log disant que l'import a échoué et que le module ne sera pas chargé.

S'il manque le fichier '__init__.py' dans le dossier du module ( Sans ce fichier il n'est pas possible d'importer le module en tant que module Python ) :

• Code Block
  theme Emacs
  [YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=my_broker_module ] Failed

-

• to

because

• import

of missing file :

• the directory /var/lib/shinken/modules/my_broker_module as a python module. The module gonna be not charged.

  
  

• Un deuxième log disant que le fichier '

  module/

  __init__.py

  .

  Un troisième log informant qu'' dans le dossier du module est manquant ( Sans ce fichier il n'est pas possible de faire un import : 'import my_broker_module.my_file '. Car le module n'a pas été importé d'importer le module en tant que module pythonPython ).

  Code Block
  theme Emacs
  [YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=my_broker_module ] - 'import because of missing file : /var/lib/shinken/modules/my_broker_module.my_file' will not work in your module.py file.

Vérification des propriétés du module

• /__init__.py.

  
  

• Un troisième log informant qu

Une fois que le modules-manager a importé son module , il va vérifier si le dictionnaire "properties" existe.

• 'il n'

• est pas possible de faire un import : 'import my_broker_module.my_file '. Car le module n'a pas été importé en tant que module python.

  Code Block

• theme Emacs

  [YYYY-MM-DD HH:MM:SS]

• WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=my_broker_module ]

• - 'import my_broker_

• module.

Création du module - chapitre [ CREATION ]

Une fois le code python chargé, on demande au "modules-manager" 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

• my_file' do not work in your module.py file.

  
  

Vérification des propriétés du module

Une fois que le modules-manager a importé son module , il va vérifier si le dictionnaire "properties" existe.

S'il n'existe pas, le log en ERROR suivant sera affiché:

Le "modules-manager" va essayer de créer le module :

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ 

CODE-LOADING ] [ directory=my_broker_module ] Missing properties dict in your module file /var/lib/shinken/modules/my_broker_module/module.py. The module will not be imported.

Création du module - chapitre [ CREATION ]

Une fois le code python chargé, on demande au "modules-manager" 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 "modules-manager" va essayer de créer le 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é.

  WebUI ] [ module-type=webui ] FAIL The module get_instance() call did not return any instance.

  Si le "get_instance()" du module rencontre une erreur, le log en ERROR sera affiché avec l'exception Python concernée:

  Code Block
  theme Emacs
  [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] [0.046s] FAIL The module creation get_instance() call did failnot withreturn an exception: EXCEPTION. Will try to recreate it in the futureany instance.

  
  

• Si le

• "get_instance()" du module rencontre une erreur, le log en ERROR sera affiché avec l'exception Python concernée:

  Code Block
  theme Emacs
  [YYYY-MM-DD HH:MM:SS]

• ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] [0.046s]

• FAIL The module

Démarrage du module

• creation did fail with an exception: EXCEPTION. Will try to recreate it in the future.

  
  

Si le module a bien été créée alors un log en INFO sera affiché son temps de création.

Une fois le module créé, le "modules-manager" va essayer de le démarrer. Ce log sera en INFO.

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

Démarrage du module

Une fois le module créé, Si le "modules-manager" a réussi à créer son module, mais n'a pas réussi à le démarrer alors 3 logs apparaîtront :

Un log en ERROR avec l'exception Python rencontré: 

va essayer de le démarrer. Ce log sera en INFO.

[YYYY-MM-DD HH:MM:SS] 

INFO : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ]  

Trying to init 

module.

Si le "modules-manager"

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

1. Un log en ERROR avec l'exception Python rencontré:  démarrer son module.

   Code Block
   theme Emacs
   [YYYY-MM-DD HH:MM:SS] WARNINGERROR : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] The module triedfailed to start: 5 times init and he raised an exception: EXCEPTION.

   
   

2. Un log en WARNING indiquant quand WARNING indiquant le nombre de fois que le "modules-manager" va à essayer de redémarrer son module ( maximum une minute )démarrer son module sans succès. Le compteur se remet à zéro dès lors que le démon a réussi à démarrer son module.

   Code Block
   theme Emacs
   [YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] The module will trytried to restartstart: at 16:32:185 times.

   
   

3. Un log

1. en WARNING indiquant quand le "modules-manager

1. " va essayer de redémarrer son module ( maximum une minute ).

   Code Block
   theme Emacs
   [YYYY-MM-DD HH:MM:SS]

1. WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ]

1. The module

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

1. will try to restart at 16:32:18.

   
   

Un log en INFO  apparaîtra si

le "modules-manager

a réussi à démarrer son module.

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

Démarrage du/des

Worker(s) du module

Une fois le module démarré, s'il utilise des Workers, le "modules-manager"

va essayer de les démarrer. Ce log sera en INFO.

[YYYY-MM-DD HH:MM:SS] 

INFO : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ]  Starting 

a worker(s)

.

Si

le "modules-manager" n'a pas réussi à démarrer le/les Worker(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 "modules-manager" n'a pas réussi à démarrer le/les Worker(s) du module avec le message de l'exception.

   Code Block

   .

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

1. and raised an exception: EXCEPTION.

   
   

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

1. .

   Code Block
   theme Emacs
   [YYYY-MM-DD HH:MM:SS]

1. ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ]

1. The worker(s) failed

1. to

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

Rajout d'un nouveau module dans un démon

1. init.

   
   

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

.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ UPDATECREATION ] [ WebUI ] Launched as a NEW module as it was added in the daemon configuration.[ module-type=webui ]  SUCCESS The worker(s) is created.

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

Rajout d'un nouveau

module dans un démon

Lorsqu'un démon reçoit un nouveau module

, le "modules-manager" affichera un log

 en INFO comme quoi le module a été ajouté à la configuration du démon.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ UPDATE ] [ WebUI ] Launched as Removinga theNEW module becauseas it iswas removedadded fromin the daemon configuration.

Suppression d'un module dans un démon

Lorsqu'un module est enlevé de la configuration du démon, le Si le "modules-manager" a essayé de supprimer le module, mais qu'il ne la pas trouver dans sa liste de module en cours d’exécution alors un log en WARNING sera affichéaffichera 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] WARNINGINFO : [ broker-master ] [ MODULES-MANAGER ] [ UPDATE ] [ WebUI ] Trying to removeRemoving the module WebUI butbecause it is notremoved found in the current running modules: LIST_CURRENT_RUNNING_MODULES

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

from the configuration.

Si le Le démon a détecté que la configuration de son module n'est plus la même qu'avant le  "modules-manager" annonce avec un log INFO a essayé de supprimer le module, mais qu'il va redémarrer son module afin de prendre la nouvelle configuration en comptene la pas trouver dans sa liste de module en cours d’exécution alors un log en WARNING sera affiché.

[YYYY-MM-DD HH:MM:SS] INFOWARNING : [ broker-master ] [ MODULES-MANAGER ] [ UPDATE ] [ WebUI ] Trying Configurationto ofremove the module did change so we restart it.

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

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 le "modules-manager" annonce avec un log INFO qu'il va redémarrer son module afin de prendre la nouvelle configuration en compteLe démon à trouver une nouvelle configuration venant d'un ancien ou d'un nouveau module, mais il n'arrive pas à le mettre à jour. Le "modules-manager" l'informe avec un log en ERROR.

[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ UPDATE ] [ WebUI ] Cannot find previous or new module definition forConfiguration of the module namedid WebUI,change so cannotwe updaterestart 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

Arrêt du module - chapitre [ SHUTDOWN ]

"modules-manager"

Le démon éteint ses modules

l'informe avec un log en ERROR.

Ce log en INFO indique que le "modules-manager" va commencer à éteindre tous ses modules.

[YYYY-MM-DD HH:MM:SS] INFOERROR : [ broker-master ] [ MODULES-MANAGER ] [ UPDATE ] [ SHUTDOWNWebUI ] Start to shutdown all modules.

Le module s'éteint

Arrêt du module - chapitre [ SHUTDOWN ]

Lorsqu'un démon s'éteint, il va d'abord demander au "modules-manager" d'éteindre ses modules.

Le démon éteint ses modules

Ce log en INFO indique que le "modules-manager" va commencer à éteindre tous ses modules

Ce log en INFO indique que le "modules-manager est en train d’arrêter le module.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ SHUTDOWN ] Stopping module WebUI.

Si une exception Python a été remontée par le "modules-manager" lors de l’arrêt du module, un log apparaîtra en ERROR avec le nom du module et le message de l’exception Python.

[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ SHUTDOWN ] StoppingStart moduleto FAILED.shutdown The quit() function on module [ WebUI ] failed with error: EXCEPTION.all modules.

Le module s'éteint

Ce log en INFO indique que le "modules-manager est en train d’arrêter le moduleSi le "modules-manager" a essayé de supprimer un module, mais qu'il ne la pas trouver dans sa liste de module en cours d’exécution alors un log en WARNING sera affiché.

[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ SHUTDOWN ] Trying to remove theStopping module WebUI but it is not found in the current running modules: LIST_CURRENT_RUNNING_MODULES

Le démon a fini d'éteindre ses modules

.

Si une exception Python a été remontée par le Le "modules-manager" informe avec un log INFO qu'il à terminé d’arrêter tous les moduleslors de l’arrêt du module, un log apparaîtra en ERROR avec le nom du module et le message de l’exception Python.

[YYYY-MM-DD HH:MM:SS] INFOERROR : [ broker-master ] [ MODULES-MANAGER ] [ SHUTDOWN ] End of stopping all modules.

Arrêt inopiné du module - chapitre [ CRASH ]

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

 Stopping module FAILED. The quit() function on module [ WebUI ] failed with error: EXCEPTION.

Si le "modules-manager" a essayé de supprimer un module, mais qu'il ne la pas trouver dans sa liste de module en cours d’exécution alors un log en WARNING sera affiché

.

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CRASHSHUTDOWN ] [ my_broker_module ] [ module-type=my_broker_module_type ] The external module my_broker_module goes down unexpectedly!Trying to remove the module WebUI but it is not found in the current running modules: LIST_CURRENT_RUNNING_MODULES

Le démon a fini d'éteindre ses modules

Le "modules-manager" informe avec un log INFO qu'il à terminé d’arrêter tous les modulesLorsqu'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 "modules-manager" affichera un log en ERROR.

[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ CRASHSHUTDOWN ] [ my_broker_module ] [ module-type=my_broker_module_type ] The module my_broker_module worker(s) goes down unexpectedly!End of stopping all modules.

Arrêt inopiné du module - chapitre [ 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 "modules-manager" affichera un log en ERROR.

[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CRASH ] [ my_broker_module ] [ module-type=my_broker_module_type ] The external module my_broker_module 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 "modules-manager" affichera un log en ERRORSi 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 peut pré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 ] [ 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.MANAGER ] [ CRASH ] [ my_broker_module ] [ module-type=my_broker_module_type ] The module my_broker_module worker(s) goes down unexpectedly!

Le module à un comportement anormal

Lorsqu'un module externe à une taille de liste d'attente commande interne ou de retour d'internal commande plus élevée que la taille maximale définie dans le fichier de configuration ini du démon (  max_queue_size ) 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 ] [ 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)!