Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Le "modules-manager" va regarder si le fichier "module_info.json" placé dans le répertoire du module existe. S'il n'existe pas un log en WARNING sera affiché.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] WARNING : [ daemon_or_module_name  ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name ] Missing 'module_info.json' file at the path /var/lib/shinken/modules/my_module_directory/module_info.json. The code of the module will be loaded.


Après que le "modules-manager" ait regardé 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
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] WARNING : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name ] Missing 'daemons' key in the 'module_info.json' file at the path /var/lib/shinken/modules/my_module_directory/module_info.json. The code of the module will be loaded.


Si le "modules-manager" n'a pas réussi à lire le fichier à cause d'un problème de formatage, un log en WARNING sera affiché.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] WARNING : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name ] The 'module_info.json' file at the path /var/lib/shinken/modules/my_module_directory/module_info.json is malformed. The code of the module will be loaded.


Si le "modules-manager" n'a pas réussi à lire le fichier à cause d'un problème de permissions, un log en WARNING sera affiché.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] WARNING : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name ] Permission denied to read file 'module_info.json' file at the path /var/lib/shinken/modules/my_module_directory/module_info.json. The code of the module will be loaded.


Le "modules-manager" annonce qu'il va commencer à charger le code de son module. Un log en INFO apparaîtra.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name  ] Starting to load the module code directory /var/lib/shinken/modules/my_module_directory.


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
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name ] Import module module_name failed: EXCEPTION.


À la fin la fin de l'import du code le "modules-manager" affiche un résumé de l'import dans un log en INFO.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] A total of 9 Shinken Enterprise modules are available for this daemon/module ( daemon_or_module_name ): MODULES_LIST_NAME (on a total of 40, loaded in 1.844s)

...

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

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name ] Try to import a module code in /var/lib/shinken/modules/module_name as python module.

En cas d'échec, 2 situations sont possibles:

  • Si vous n'utilisez pas les fonctionnalités propre à un module python ( import d'un fichier local, ...  ), un log en INFO sera affiché.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=module_name ] Failed to import the directory /var/lib/shinken/modules/module_name as a python module. If it doesn't use python module feature, it won't encounter loading problems.


  • Dans le cas contraire, il se peut que l'échec de chargement du module soit lié à un problème d'import de fichier en Python. Les 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
      languagetext
      themeEmacs
      [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name] Failed to import the directory /var/lib/shinken/modules/directory_name as a python module. 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'importer le module en tant que module Python ).

      Code Block
      languagetext
      themeEmacs
      [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name]  - because of missing file : /var/lib/shinken/modules/module_name/__init__.py.
    • Le troisième log précise quel fichier n'a pas réussi à être importé dans le code du module. Dans notre exemple, c'est le fichier module_name.my_file qui n'a pas été importé.

      Code Block
      languagetext
      themeEmacs
      [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name] - The line 'import module_name.my_file' The module won't work in your module.py file.
Si le "modules-manager" a réussi à importer le module en tant que "module Python", alors un log en INFO apparaîtra.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CODE-LOADING ] [ directory=directory_name ] Success to import the directory /var/lib/shinken/modules/architecture-export/ as a python 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é :

Code Block
languagetext
themeEmacs
[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.

...

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
    languagetext
    themeEmacs
    [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
    languagetext
    themeEmacs
    [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 type ne correspond pas au démon ou au module qui le lance:

    Code Block
    languagetext
    themeEmacs
    [YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ] The module module_name of type module_type is not available for the daemon/module daemon_or_module_name.
  • Si le module a bien été créé alors un log en INFO indiquera son temps de création:

    Code Block
    languagetext
    themeEmacs
    [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.


...

Une fois le module créé, le "modules-manager" va essayer de le démarrer.

Ce log sera en INFO.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ 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 :

    Code Block
    languagetext
    themeEmacs
    [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ]  The module 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.

    Code Block
    themelanguagetext
    themeEmacs
    [YYYY-MM-DD HH:MM:SS] WARNING : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ]  The module tried to start: 5 times.
  3. Un log en WARNING indiquant quand le "modules-manager" va essayer de redémarrer son module ( maximum une minute ).

    Code Block
    languagetext
    themeEmacs
    [YYYY-MM-DD HH:MM:SS] WARNING : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ]  The 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.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ] The module is started.

...

Une fois le module créé, le "modules-manager" va essayer de le démarrer.

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

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ]  Starting a worker base module.


Si le "modules-manager" n'a pas réussi à 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" n'a pas réussi à démarrer le module avec le message de l'exception. Le module redémarrera dans le futur ( max 1 minute ).

    Code Block
    languagetext
    themeEmacs
    [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ]  The worker base module failed to init and raised an exception: EXCEPTION. The module will be restarted in the future.
  2. Un log en ERROR sera affiché disant que le "modules-manager" n'a pas réussi à démarrer le module et ces Workers, et que le module redémarrera dans le futur ( max 1 minute ).

    Code Block
    languagetext
    themeEmacs
    [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ]  The worker base module failed to init. The module will be restarted in the future.

Si le module et ces Workers se sont bien démarrés alors ce log en INFO apparaîtra.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CREATION ] [ module_name ] [ module-type=module_type ]  The worker base module started.

...

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 module.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Launched as a NEW module as it was added in the configuration.


Quand le "module-manager" a fini de créer le ou les module(s) ajouté(s) dans la configuration du module ou du démon, alors un récapitulatif des actions faites sera affiché en log INFO.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] Modules did changed:
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] - WebUI -> started ( new )
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] - sla -> started ( new )

...

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.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Removing the module because it is removed in the configuration.

Si le module possède des Workers, le "modules-manager" va arrêter tous ses Workers. Un log en INFO sera affiché.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Stopping all workers.

Le module "modules-manager" indique avec un log en INFO qu'il va essayer d’arrêter le module.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Trying to stop module.
  • Si l’arrêt du module a échoué en appelant la fonction quit() du module, un log en ERROR sera affiché. 

    Code Block
    languagetext
    themeEmacs
    [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Stopping module failed. The quit() function fail with error: EXCEPTION.
  • Si l’arrêt du module a échoué avec une exception Python, un log en ERROR sera affiché. 

    Code Block
    languagetext
    themeEmacs
    [YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Stopping module failed and raised an exception: EXCEPTION.

Lorsque que le "module-manager" a réussi à arrêter son module, il l'indique avec un log en INFO

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Stopping the module was a success.


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

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] WARNING : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Trying to remove the module WebUI but it is not found in the current running modules: LIST_CURRENT_RUNNING_MODULES

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.

Code Block
languagetext
themeEmacs
[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


Quand le "module-manager" a fini d’éteindre le ou les module(s) supprimé(s) dans la configuration d'un module ou d'un démon, alors un récapitulatif des actions faites sera affiché en log INFO.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] Modules did changed:
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] - Livestatus -> stopped ( removed )

...

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.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] Configuration of the module did change so we restart it.

Quand le "module-manager" a fini de redémarrer le ou les module(s) supprimé(s) dans la configuration du module ou du démon, alors un récapitulatif des actions faites sera affiché en log INFO.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] Modules did changed:
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] - Livestatus -> restarted ( configuration change )

...

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.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ UPDATE ] [ module_name ] We cannot update 'module_name' module. Please contact your Support.

...

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

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ SHUTDOWN ] Start to shutdown all modules.

...

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

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ SHUTDOWN ] 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 Python.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ SHUTDOWN ] Stopping module FAILED. Call quit() function on module: [ module_name ] fail with error: [ 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é.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ SHUTDOWN ] Trying to remove the module WebUI but it is not found in the current running modules: LIST_CURRENT_RUNNING_MODULES

...

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

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] INFO : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ SHUTDOWN ] Stopping all modules ended.

...

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.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CRASH ] [ module_name ] [ module-type=module_type ] The module module_name goes down unexpectedly!

Lorsqu'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.

Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CRASH ] [ module_name ] [ module-type=module_type ] The module module_name worker(s) goes down unexpectedly!

...

Lorsqu'un module externe a une taille de liste d'attente ( de commande interne ou de retour de commande interneplus é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(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 ).


Code Block
languagetext
themeEmacs
[YYYY-MM-DD HH:MM:SS] ERROR : [ daemon_or_module_name ] [ MODULES-MANAGER ] [ CRASH ] [ module_name ] [ module-type=module_type ] The external module module_name got a too high brok queue size ( QUEUE_SIZE > QUEUE_MAX_SIZE )!