Import des modules depuis /var/lib/shinken/modules - chapitre [ CODE-LOADING ]
Les démons vont démarrer leurs modules manager qui vont lister les répertoires dans /var/lib/shinken/modules et vont tenter de charger chaque module.
Chargement du code du module
Le "modules manager" va regarder si le fichier "module_info.json" placé dans le répertoire du module existe. Si il n'existe pas un log en WARNING sera affiché.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] Missing 'module_info.json' file at the path /var/lib/shinken/modules/architecture-export/module_info.json. The code of the module gonna be charged. |
Après que le "modules manager" ait regarder si le fichier "module_info.json" existe, il va regarder si la clé "daemons" est bien présente dans le fichier. Si elle n'existe pas un log en WARNING sera affiché.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] Missing 'daemons' key in the 'module_info.json' file at the path /var/lib/shinken/modules/architecture-export/module_info.json. The code of the module gonna be charged. |
Si le "modules manager" n'a pas réussit à lire le fichier à cause d'un problème de formatage, un log en WARNING sera affiché.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] The 'module_info.json' file at the path /var/lib/shinken/modules/architecture-export/module_info.json is malformed. The code of the module gonna be charged. |
Si le "modules manager" n'a pas réussit à lire le fichier à cause d'un problème de permissions, un log en WARNING sera affiché.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] Permission denied to read file 'module_info.json' file at the path /var/lib/shinken/modules/architecture-export/module_info.json. The code of the module gonna be charged. |
Le "modules manager" annonce qu'il va commencer à charger le code de son module. Un log en INFO apparaîtra.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] Starting to load the module code directory /var/lib/shinken/modules/architecture-export. |
Si le "modules manager" trouve une exception Python durant le procédé d'import du module, un log en ERROR avec l’exception sera affiché et le module ne sera pas importé.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] Import module [architecture-export] failed: EXCEPTION. |
Chargement du module en tant que module Python
Une fois que À la fin la fin de l'import 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 python. Un log en INFO apparaîtraaffiche un résumé de l'import dans un log en INFO.
| Code Block |
|---|
|
[YYYY2020-MM07-DD08 HH16:MM31:SS38] INFO : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] Try to import a module code in /var/lib/shinken/modules/architecture-export as python module.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) |
Chargement du module en tant que module Python
Une fois que le "modules manager" à charger le code du module il va vérifier si le module peut être importé en tant qu'un module python. Un log en INFO apparaîtra
Si le "modules manager" ne peut pas importer le code du module en tant que module python alors des logs en WARNING formant un bloc apparaîtrons.
Un premier log expliquant que le "modules manager" n'a pas réussi à importer le module en tant que python module.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] |
WARNINGINFO : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] |
Failedthedirectoryin /var/lib/shinken/modules/architecture-export as |
a Un second log s'affichera seulement s'il manque le fichier '__init__.py' dans le dossier du module. Sans ce fichier il n'est pas possible d'importer le Si le "modules manager" ne peut pas importer le code du module en tant que module python alors des logs en WARNING formant un bloc apparaîtrons.
Un premier log expliquant que le "modules manager" n'a pas réussi à importer le module en tant que python module.
Python.| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] Failed -to becauseimport ofthe missing filedirectory : /var/lib/shinken/modules/architecture-export/ as a python module. |
Un second log s'affichera seulement s'il manque le fichier '__init__.py
.Un troisième log informant qu'' dans le dossier du module. Sans ce fichier il n'est pas possible de faire un import : 'import architecture-export.my_file '. Car le module n'a pas été importé d'importer le module en tant que module pythonPython.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] - 'import architecture-export.my_file' will not work in your module.py file. |
Si le "modules manager" a réussi à importer, le module en tant que Python module alors un log en INFO apparaîtraINFOWARNING : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] |
Successto import the directory /var/lib/shinken/modules/'import architecture-export |
/ as a python.my_file' will not work in your module. |
Vérification des propriétés du module
Si le "modules manager" a réussi à importer, le
Une fois que le modules manager à importer (ou non) son module en tant que
python module, il va vérifier si le dictionnaire "properties " existe.S'il n'existe pas Python module alors un log en
ERROR sera affiché expliquant que le dictionnaire est manquant et que le module ne sera par conséquent pas importéINFO apparaîtra.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=architecture-export ] MissingSuccess propertiesto dictimport inthe your module file /directory /var/lib/shinken/modules/architecture-export/module.py. Theas modulea will not be importedpython module.
|
Création
Vérification des propriétés 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
que le modules manager à importer (ou non) son module en tant que python module, il va vérifier si le dictionnaire "properties " existe.
S'il n'existe pas alors un log en ERROR sera affiché expliquant que le dictionnaire est manquant et que le module ne sera par conséquent pas importé
Le "modules manager" 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é.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ |
CREATIONWebUIdirectory=architecture-export ] Missing properties dict in your module file /var/lib/shinken/modules/architecture-export/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 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é
[ module-type=webui ] FAIL The module get_instance() call did not return any instance.Si le "modules manager" 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ée.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] FAIL [0.046s] FAIL The module creationThe module get_instance() call did failnot withreturn an exception: EXCEPTION. Remove this module currently, will try to recreate it in the future. |
Si l'instance a bien été créée INFO son temps de créationINFOERROR : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] [0.046s] |
SUCCESSinstanceis created.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.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ |
Une fois le module créé le modules manager va essayer de la démarrer. Ce log sera en INFO.
| Code Block |
|---|
|
[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 instance is created. |
Une fois le module créé le modules manager va essayer de la démarrer. Ce log sera en INFO.
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 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.
| Code Block |
|---|
|
[YYYY-ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] |
The modulefailed and he raised an exception: EXCEPTION.Un log en WARNING indiquant le nombre de fois que
Si le "modules manager"
à essayer de démarrer son module sans succès. Le compteur se remet à zéro dès lors que le démon 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 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. démarrer son module.
| Code Block |
|---|
|
[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. |
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 |
|---|
|
[YYYY-MM-DD HH:MM:SS] WARNING : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] The module willtried try to restartstart: at 16:32:185 times. |
Un log
en INFO apparaîtra si en WARNING indiquant quand le "modules manager
a réussi à démarrer " va essayer de redémarrer son module (maximum une minute).
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] |
INFOWARNING : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] |
SUCCESS
is started.Démarrage du/des Worker(s) du module
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
Une fois le module démarré le "modules manager" va essayer de démarrer son/ses Worker(s). Ce log sera en INFO.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] SUCCESS The Startingmodule a workeris started. |
Démarrage du/des Worker(s) du module
Une fois le module démarré
.Si le "modules manager" n'a pas réussi à démarrer le/les Wroker(s) du module :
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'exceptionva essayer de démarrer son/ses Worker(s). Ce log sera en INFO.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] |
ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] Starting |
TheSi le "modules manager" n'a pas réussi à démarrer le/les Wroker(s) du module :
Et qu'il a levé une exception lors du démarrage alors
failed to init and he raised an exception: EXCEPTION.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 |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] The worker(s) failed to init. |
Si le/les and he raised an exception: EXCEPTION. |
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
ce sont bien démarrer alors ce log en INFO apparaîtra.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] |
INFOERROR : [ broker-master ] [ MODULES-MANAGER ] [ CREATION ] [ WebUI ] [ module-type=webui ] |
SUCCESS
is
created.Changement de configuration ou d'état du module - chapitre [ UPDATE ]
Rajout d'un nouveau module dans un démon
Si le/les Worker(s) du module ce sont bien démarrer alors ce log en INFO apparaîtra.
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.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ UPDATECREATION ] [ WebUI ] Launching a new[ module-type=webui as] it wasSUCCESS added in the daemon configuration.The worker(s) is created. |
Changement de configuration ou d'état du module - chapitre [ UPDATE ]
Rajout d'un nouveau module
Suppression d'un module dans un démon
Lorsqu'un
utilisateur enlève démon reçoit un nouveau module
de la configuration du démon,
le le "modules manager" affichera un log
en INFO informant que l'on supprime le module, car il n'est plus dans en INFO comme quoi le module a été ajouté à la configuration du démon.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] INFO : [ broker-master ] [ MODULES-MANAGER ] [ UPDATE ] [ WebUI ] Launching Removinga thenew module becauseas it iswas removedadded fromin the daemon configuration. |
Suppression d'un module dans un démon
Lorsqu'un utilisateur enlève un module de la configuration du démon, le "modules manager" affichera un log en INFO informant que l'on supprime le module, car il n'est plus dans la configuration du démonSi 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é.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] WARNINGINFO : [ broker-master ] [ MODULES-MANAGER ] [ UPDATE ] [ WebUI ] Trying to removeRemoving the module WebUIbecause but it is notremoved foundfrom in the current running modules: LIST_CURRENT_RUNNING_MODULES |
Changement de configuration d'un module (et sa relance)
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 un 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é.
| Code Block |
|---|
|
[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
WebUI but it is not found in the current running modules: LIST_CURRENT_RUNNING_MODULES |
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.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ UPDATE ] [ WebUI ] Cannot find previous or new module definition for Configuration of the module namedid WebUI,change so cannotwe updaterestart it. |
Arrêt du module - chapitre [ SHUTDOWN ]
Lorsque le démon s'éteint, il va d'abord demander au module manager d'éteindre ses modules.
Le démon éteint ses modules
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 "modules manager" l'informe avec un log en ERRORCe log en INFO indique que le "modules manager" va commencer à éteindre tous ses modules.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] INFOERROR : [ broker-master ] [ MODULES-MANAGER ] [ SHUTDOWNUPDATE ] Start[ toWebUI shutdown] all modules. |
Cannot find previous or new module definition for the module name WebUI, so cannot update it. |
Arrêt du module - chapitre [ SHUTDOWN ]
Lorsque le démon s'éteint, il va d'abord demander au module 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.
| Code Block |
|---|
|
[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.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ SHUTDOWN ] StoppingStart moduleto FAILED.shutdown Call quit() function on module: [ WebUI ] fail with error: [ EXCEPTION ].all modules. |
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é.
| Code Block |
|---|
|
[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 "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 "modules manager" informe avec un log INFO qu'il à terminé d’arrêter tous les modules.
| Code Block |
|---|
|
[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. Call quit() function on module: [ WebUI ] fail 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é
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.
| Code Block |
|---|
|
[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 goes down unexpectedly!SHUTDOWN ] 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.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERRORINFO : [ broker-master ] [ MODULES-MANAGER ] [ SHUTDOWN CRASH] 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.
| Code Block |
|---|
|
[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[ 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 peut pré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 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.
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CRASH ] [ WebUIsynchronizer-module-database-backup ] [ 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
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 peut prévenir le démon avant de s’arrêter), on aura le log explicatif en ERROR issu du module
Lorsqu'un module externe à une taille de liste d'attente d'internal commande 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).
| Code Block |
|---|
|
[YYYY-MM-DD HH:MM:SS] ERROR : [ broker-master ] [ MODULES-MANAGER ] [ CRASH ] [ synchronizer-module-database-backupWebUI ] [ 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)! |
Les démons vont lister les répertoires dans /var/lib/shinken/modules et vont tenter de charger chaque module.
Ceci va créer une entrée DEBUG:
| Code Block |
|---|
|
[2020-07-08 16:31:36] DEBUG : [broker-master ] [modules-manager ] [MODULE-CODE-LOADING] [directory=architecture-export ] Starting to load the module code directory /var/lib/shinken/modules/architecture-export. |
Quand l'import est effectué, on aura une ligne en DEBUG:
| Code Block |
|---|
|
[2020-07-08 16:31:36] DEBUG : [broker-master ] [modules-manager ] [MODULE-CODE-LOADING] [directory=architecture-export ] [0.021s] Module code was loaded. Did import 10 python new librairies (PIL,PIL.Image,PIL.ImageMode,PIL._binary,_imaging,architecture-export,architecture-export.mapper,shinken.webui.bottlewebui,shinken.webui.bottlewebui.ext,shinken.webui.cherrypybackend). |
Ceci donne le temps de chargement, mais également les nouvelles librairies importées.
À la fin des chargements, il y a un résumé en INFO qui est affiché:
| Code Block |
|---|
|
[2020-07-08 16:31:38] 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) |
Les modules éligibles à ce démon/module sont listés.
Création des instances de modules
Une fois le code python chargé, on lui demande de créer des instances pour les modules ( les vrais objets ):
| Code Block |
|---|
|
[2020-07-08 16:31:38] DEBUG : [broker-master ] [modules-manager ] [MODULE-INSTANCE-CREATION] [module type=webui ] [name=WebUI ] Start to create the module instance |
Une fois créé, on a un log en INFO concernant le temps que ça a pris.
| Code Block |
|---|
|
[2020-07-08 16:31:38] INFO : [broker-master ] [modules-manager ] [MODULE-INSTANCE-CREATION] [module type=webui ] [name=WebUI ] [0.046s] SUCCESS The module instance is created. |
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 liste d'attente d'internal commande 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
Initialisation des instances de modules
Une fois les instances créées, on leur demande de se préparer ( ouvrir leurs connexions, lancer les processus pour les modules externes ou avec des workers, etc ).
Ceci sera de l'ordre de la seconde pour le cas des modules avec workers ( il faut créer les queues de connexions, lancer les processus et le manager de queue, etc ).
| Code Block |
|---|
|
[2020YYYY-07MM-08DD 16HH:31MM:38SS] INFOERROR : [ broker-master ] [modules MODULES-managerMANAGER ] [MODULE-INSTANCE-CREATION CRASH] [WebUI ] Trying to initialize module by calling it's init method. |
Quand l'initialisation est finie, un log INFO est affiché.
| Code Block |
|---|
|
[2020-07-08 16:31:39] INFO : [broker-master synchronizer-module-database-backup ] [modules-manager ] [MODULE-INSTANCE-CREATION] [WebUI ] [0.801s] SUCCESS The module was initialized successfully. 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)! |
Création des instances de modules
Initialisation des instances de modules
Rajout d'un nouveau module dans un démon
Lorsqu'un démon reçoit un nouveau module, on va avoir une entrée MODULES-CHANGE en INFO comme quoi le module est started:
| Code Block |
|---|
|
[2020-07-09 13:29:58] INFO : [broker-master ] [modules-manager ] [MODULES-CHANGE ] Modules did changed:
[2020-07-09 13:29:58] INFO : [broker-master ] [modules-manager ] [MODULES-CHANGE ] - WebUI -> started (new)
[2020-07-09 13:29:58] INFO : [broker-master ] [modules-manager ] [MODULES-CHANGE ] - sla -> started (new) |
À noter que les sous-modules d'un module seront eux affichés en DEBUG:
| Code Block |
|---|
|
[2020-07-09 13:29:58] INFO : [broker-master ] [modules-manager ] [MODULES-CHANGE ] - WebUI -> started (new)
[2020-07-09 13:29:58] DEBUG : [broker-master ] [modules-manager ] [MODULES-CHANGE ] * Cfg_password
[2020-07-09 13:29:58] DEBUG : [broker-master ] [modules-manager ] [MODULES-CHANGE ] * sla |
Suppression d'un module dans un démon
Quand un module est enlevé de la configuration d'un démon, celui-ci l'affichera avec une entrée MODULES-CHANGE en INFO comme quoi le module est stopped:
| Code Block |
|---|
|
[2020-07-09 13:57:31] INFO : [broker-master ] [modules-manager ] [MODULES-CHANGE ] Modules did changed:
[2020-07-09 13:57:31] INFO : [broker-master ] [modules-manager ] [MODULES-CHANGE ] - Livestatus -> stopped (removed)
|
Changement de configuration d'un module (et sa relance)
Quand la configuration d'un module change (ou la configuration d'un de ses sous-modules) alors le module est redémarré (et ses processus redémarrés si besoin). Ceci est loggué avec une entrée MODULES-CHANGE en INFO comme quoi le module est restarted:
| Code Block |
|---|
|
[2020-07-09 13:51:49] INFO : [broker-master ] [modules-manager ] [MODULES-CHANGE ] Modules did changed:
[2020-07-09 13:51:49] INFO : [broker-master ] [modules-manager ] [MODULES-CHANGE ] - Livestatus -> restarted (configuration change) |