Page History

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

Les démons vont lister les répertoires Chaque démon ( ou module qui possèdes d'autres modules ) va démarrer son gestionnaire de module "modules-manager" qui va charger chaque module présent dans /var/lib/shinken/modules et vont tenter de charger chaque module.

Les logs en DEBUG seront changé en INFO quand le démon chargera le code de ses propres modules et non pas de tous les modules.

Chargement du code du module

.

Pour qu'un module soit chargé, il faut qu'il soit présent dans un répertoire.

Chargement du code

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éLe démon annonce qu'il va commencer à charger son module. Un log en DEBUG apparaîtra.

[YYYY-MM-DD HH:MM:SS] ERROR DEBUG : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-exportname_directory ] StartingImport to load the module code directory /var/lib/shinken/modules/architecture-export.

module [module_name] failed: EXCEPTION.

Chargement du module en tant que package Python

Lors du chargement du code, le "modules-manager" va vérifier si un module peut être importé en tant que package Python. En cas d'échec un log en INFO sera affiché.

[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-exportmodule_name ] Import module [architecture-export] failed: EXCEPTION.

Chargement du module en tant que module Python

Failed to import the directory /var/lib/shinken/modules/module_name as a python module.

Si cet échec est dû à un problème d'import de fichier en Python, le module ne sera pas chargé et 3 logs en ERROR seront affichés  :

• Le premier log indique que l'import a échoué et que le module ne sera pas chargé

• .

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

• : [

• daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=

• name_directory ]

• Failed to import

• the

• directory

• /var/lib/shinken/modules/

• directory_name as a python module.

Si le démon ne peut pas importer le code du module en tant que module python alors des logs en WARNING formant un bloc apparaîtrons.

• The module won't be loaded.

  
  

• Le second log indique que le fichier '__init__.py' dans le dossier du module est manquant ( sans ce fichier, il est impossible d'Un premier log expliquant que le démon n'a pas réussi à importer le module en tant que python module Python ).

  Code Block
  theme Emacs
  [YYYY-MM-DD HH:MM:SS] WARNINGERROR : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-exportname_directory ] - Failedbecause toof importmissing thefile directory: /var/lib/shinken/modules/architecture-export as a python module.

  Un second log s'affichera seulement s'il manque le fichier '

  module_name/__init__.py.

  
  

• Le troisième log précise quel fichier n'a pas réussi à être importé dans le dossier code du module. Sans se fichier il nDans notre exemple, c'est pas possible d'importer le module en tant que module Pythonle fichier module_name.my_file qui n'a pas été importé.

  Code Block
  theme Emacs
  [YYYY-MM-DD HH:MM:SS] WARNINGERROR : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-exportname_directory ] - becauseThe ofline missing file : /var/lib/shinken/modules/architecture-export/__init__.py.

  Un troisième log informant qu'il n'est pas possible de faire un import : 'import architecture-export.my_file '. Car le module n'a pas été importé en tant que module python.

  'import module_name.my_file' The module won't work in your module.py file.

  
  

Vérification des propriétés du module

Une fois que le "modules-manager" a chargé un module en tant que package Python, il va vérifier si le dictionnaire "properties" est existant dans le module.

Dans le cas contraire, le module ne sera pas importé et le log en ERROR suivant sera affiché :

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

ERROR : [ 

daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=

name_directory ] 

Missing 

properties dict in your module file /var/lib/shinken/modules/module_name/module.py. The module won't be loaded.

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 ses 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é.

  Code Block
  theme Emacs
  [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name] [ module-type=module_type ] The module get_instance() call did not return any instance or does not exist.

  
  

• 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 : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ] [0.046s] The module creation did fail with an exception: EXCEPTION. Will try to recreate it in the future.

  
  

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

[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ]  [0.046s] The module is created.

Démarrage du module

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 DEBUG : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADINGCREATION ] [ directory=architecture-exportmodule_name ] Success to import the directory /var/lib/shinken/modules/architecture-export/ as a python module.

Vérification des propriétés du module

[ module-type=module_type ]  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ée :

Une fois que le démon à importer (ou non) son module en tant que python module, il va vérifier si le dictionnaire "properties " existe.

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

1. daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [

1. module_name ] [

1. module-type=module_type ]

1. The module

Création du module - chapitre [ 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

1. failed to init and he raised an exception: EXCEPTION.

   
   

2. Un log en WARNING indiquant le nombre de fois que le "modules-manager" à essayé de 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

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

1. .

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

1. WARNING : [

1. daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [

1. module_name ] [ module-type=

1. module_type ]

1. The module

1. tried to start: 5 times.

   
   

2. Un log en WARNING indiquant quand le "modules-manager" va essayer de redémarrer son module ( maximum une minute ).

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

1. WARNING : [

1. daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [

1. module_name ] [ module-type=

1. module_type ] The module will try to

1. restart

1. at 16:32:18.

   
   

Un log en INFO  apparaîtra si le "modules-manager a réussi à démarrer son moduleSi 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-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ WebUImodule_name ] [ module-type=webuimodule_type ]  [0.046s] SUCCESS The module instance is createdstarted.

Démarrage

des modules avec des workers

Une fois le module créé le démon va essayer de la démarrer. démarré, s'il utilise des Workers, le "modules-manager" va essayer de les démarrer.

• S'il n'arrive pas à les démarrer, le module redémarrera dans le futur ( max 1 minute ) afin de redémarrer les Workers.
• Ce log sera en INFO.
  
  

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ WebUImodule_name ] [ module-type=webuimodule_type ]  TryingStarting to init modulea worker(s).

Si le démon a "modules-manager" n'a pas réussi à créer son module mais n'a pas réussi à le démarrer alors 3 logs apparaîtrons :démarrer le 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" Un log en ERROR expliquant que le module n'a pas réussi à se démarrer suivie les Workers du module avec le message de l'exception Python puis de l'exception en question. . Le module redémarrera dans le futur ( max 1 minute ).

   Code Block
   theme Emacs
   [YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ WebUImodule_name ] [ module-type=webuimodule_type ] The moduleworker(s) failed to init and he raised an exception: EXCEPTION. The module will be restarted in the future.

   
   

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 moduleERROR sera affiché disant que le "modules-manager" n'a pas réussi à démarrer les Workers du module, et que le module redémarrera dans le futur ( max 1 minute ).

   Code Block
   theme Emacs
   [YYYY-MM-DD HH:MM:SS] WARNINGERROR : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ WebUImodule_name ] [ module-type=webui ] type=module_type ] The worker(s) failed to init. The module will triedbe torestarted start:in 5the timesfuture.

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

   
   

Si les Workers du module se sont bien démarrés alors ce log en INFO apparaîtra.

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

INFO : [ 

daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ 

module_name ] [ module-type=

module_type ]  The worker(s) started.

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

Rajout d'un nouveau module

Lorsqu'un démon ou un module reçoit un nouveau module, le "modules manager" affiche un log en INFO expliquant qu'il va lancer le nouveau

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-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CREATIONUPDATE ] [ WebUI ] [ module-type=webui ]  SUCCESS The module is started.

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

Suppression d'un module

Lorsqu'un module est enlevé de la configuration du démon ou de son module, le "modules-manager" affichera un log en INFO informant que l'on supprime le module, car il n'est plus dans la configuration de son démon ou de son 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-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CREATIONUPDATE ] [ WebUImodule_name ] Removing [the module-type=webui ]  Starting a worker(s) because it is removed in the configuration.

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

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

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

WARNING : [ 

daemon_or_module_name ] [ MODULES-MANAGER ] [ 

UPDATE ] [ 

module_name ]

 Trying to remove the module

 module_name but it is not found in the current running modules: LIST_CURRENT_RUNNING_MODULES

Où LIST_CURRENT_RUNNING_MODULES est la liste des modules en cours d'exécution.

Quand le "modules-manager" éteint les modules, si un module ne réussit pas à s'éteindre alors un log en ERRORsera affiché, suivi de la traceback de l'exception

.

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

daemon_or_module_name ] [ MODULES-MANAGER ] [ 

UPDATE ] [ 

module_name ] 

The module

 MODULE_NAME failed to stop and raised an exception : EXCEPTION

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

Le démon ou le module a détecté que la configuration de son module en cours d'exécution a changé. Le "modules-manager" indique avec un log INFO qu'il va redémarrer le module afin de prendre en compte la nouvelle configuration

.

[YYYY-MM-DD HH:MM:SS] INFO : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CREATIONUPDATE ] [ WebUImodule_name ] Configuration of [the module-type=webui ]did change 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

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

Le démon ou le module n'arrive pas à mettre à jour son module. Le "modules-manager" informe qu'il faut contacter le support avec un log en ERROR

.

[YYYY-MM-DD HH:MM:SS] INFOERROR : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ WebUImodule_name ] LaunchingWe acannot newupdate module as it was added in the daemon configuration.

Suppression d'un module dans un démon

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 modulesLorsqu'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-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [UPDATE ] [ WebUISHUTDOWN ] RemovingStart theto module because it is removed from the configuration.shutdown all modules.

Le module s'éteint

Ce log en INFO indique que le "modules-manager est en train d’arrêter le moduleSi 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] WARNINGINFO : [ broker-master ] [ MODULES-MANAGERdaemon_or_module_name ] [ UPDATEMODULES-MANAGER ] [ WebUISHUTDOWN ] Trying to remove the module WebUI but it is not found in the current running modules: LIST_CURRENT_RUNNING_MODULES

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

Stopping module module_name.

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 PythonLe 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] INFOERROR : [ broker-master  [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATESHUTDOWN ] Stopping [module WebUIfailed. ]The Configurationquit() offunction theon module [ didmodule_name change] sofailed wewith restarterror: it.

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

EXCEPTION.

Si le "modules-manager" a essayé de supprimer un module, mais qu'il ne l'a pas trouvé dans sa liste de modules en cours d’exécution alors un log en ERROR sera affiché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-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATESHUTDOWN ] [Trying to WebUIremove ]the Cannotmodule findmodule_name previousbut orit newis modulenot definitionfound forin the modulecurrent namerunning WebUI, so cannot update it.

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

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

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

Le "modules-manager" informe avec un log INFO qu'il a terminé d’arrêter tous les modules

.

[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CRASHSHUTDOWN ] [ synchronizer-module-database-backup ] [ module-type=synchronizer_module_database_backup ] The external module synchronizer-module-database-backup goes down unexpectedly!Stopping all modules ended.

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

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

Lorsqu'un module 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-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CRASH ] [ synchronizer-module-database-backupmodule_name ] [ module-type=synchronizer_module_database_backuptype ] The module synchronizer-module-database-backup worker(s) module module_name 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 moduleLorsqu'un ou plusieurs Worker(s) d'un module ne sont plus en cours d’exécution et qu'ils se sont éteint(s) de manière inattendue, le "modules-manager" affichera un log en ERROR.

[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.daemon_or_module_name ] [ MODULES-MANAGER ] [ CRASH ] [ module_name ] [ module-type=module_type ] The module module_name worker(s) goes down unexpectedly!

Le module a

un comportement anormal

Lorsqu'un module externe à a une taille de liste d'attente d'internal ( de commande interne ou de retour d'internal commande plus élevé de commande interne ) plus élevée que la taille maximale définie dans le fichier de configuration ini du démon 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(s) 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-masterdaemon_or_module_name ] [ MODULES-MANAGER ] [ CRASH ] [ synchronizer-module-database-backupmodule_name ] [ module-type=synchronizer_module_database_backuptype ] The external module synchronizer-module-database-backupmodule_name got a too high brok queue size ( QUEUE_SIZE > QUEUE_MAX_SIZE )!