Définir le niveau de journalisation

Introduction #

Dans certains cas, la cause d’un problème ne peut pas être identifiée dans le niveau de journalisation par défaut. Dans ce cas, le niveau du journal peut être ajusté en conséquence et les informations produites peuvent être augmentées.

Le niveau de journalisation peut être défini via le fichier application.yml, le portail du système ou l’API.

Le niveau de journalisation DEBUG ne devrait être utilisé qu’à des fins d’analyse, car beaucoup plus d’informations sont écrites dans le journal et le journal s’agrandit en conséquence. Le niveau du journal peut être ajusté dans le portail système. Depuis Relution 5, cette option doit être activée au préalable à titre de sécurité supplémentaire.

Emplacement du fichier journal #

Les fichiers journaux de Relution se trouvent dans le répertoire log situé sous le répertoire d’installation. Les journaux sont renouvelés automatiquement une fois par jour et les vieux fichiers journaux sont compressés pour économiser de l’espace.

Docker #

Les conteneurs Docker étant censés être éphémères, Relution n’écrit pas de fichiers journaux lorsqu’il est exécuté à l’intérieur d’un conteneur. Pour obtenir les journaux d’un conteneur en cours d’exécution, utilisez la commande docker logs.

Nous recommandons de mettre en place une infrastructure de journalisation pour s’assurer que les journaux sont correctement collectés et archivés afin de faciliter le dépannage en cas de problèmes.

Linux #

Si Relution a été installé dans le répertoire par défaut /opt/relution, les journaux peuvent être trouvés dans /opt/relution/log. Le fichier journal le plus récent est appelé relution.log, tandis que les fichiers journaux archivés sont nommés relution.log.<date>.gz. Si Relution a été installé à un autre endroit, le répertoire du journal est trouvé par rapport à son répertoire d’installation.

Windows #

Si Relution a été installé dans le répertoire par défaut C:\NProgram Files\NRelution, les journaux se trouvent dans C:\NProgram Files\NRelution\Nlog. Le fichier journal le plus récent est appelé relution.log, tandis que les fichiers journaux archivés sont nommés relution.log.<date>.gz. Si Relution a été installé à un autre endroit, le répertoire du journal est trouvé par rapport à son répertoire d’installation.

Activation du portail système #

Dans le fichier application.yml du répertoire Relution, ajoutez cette section :

relution :
  spring-boot-admin :
    enabled : true

Veillez à indenter chaque ligne ici (deux espaces par niveau). Il est recommandé de désactiver à nouveau le portail système après avoir terminé le travail.

Activation du journal DEBUG dans le portail système #

1. Connectez-vous à Relution en tant qu’administrateur système. Le nom d’utilisateur par défaut est admin

2. allez à System Portal dans le menu système.

   

3. vous pouvez ensuite appeler l’instance associée. Pour ce faire, cliquez sur la boîte et non pas directement sur le lien vert.

   

4. passez à la section Logger.

   

5. utilisez la recherche pour mettre le Logger correspondant à DEBUG. ROOT active tous les Loggers et ne devrait donc être utilisé que dans des cas exceptionnels, car beaucoup de contenu est généré rapidement. Dans l’exemple, le AppleMDMResource a été activé.

   

Notez que le paramètre est directement actif et que vous n’avez pas besoin de redémarrer les services. Lors du redémarrage du service Relution ou du conteneur Docker, le journal sera réinitialisé à INFO.

Garder le journal DEBUG actif après un redémarrage #

Puisque le journal DEBUG est remis à INFO après un redémarrage de l’instance, il n’est pas possible d’enregistrer les erreurs initiales pendant le processus de démarrage, par exemple dans le contexte d’une connexion LDAP, de la manière décrite ci-dessus. Pour cela, il est possible de définir le journal dans le fichier application.yml. Celui-ci est chargé directement au démarrage et active ainsi le journal DEBUG.

Insérez le contenu suivant directement dans la première ligne à la position 1.

Définir ROOT à DEBUG #

Notez que la journalisation au niveau ROOT peut générer rapidement beaucoup de contenu. Cette fonctionnalité ne devrait être utilisée que dans des cas tout à fait exceptionnels pour des activités d’analyse courtes. Notez qu’il peut y avoir une dégradation significative des performances ici, même avec de petites installations.

Il est recommandé d’activer un ou plusieurs journaux individuellement et de manière ciblée. Pour ce faire, ajoutez simplement les loggers individuels l’un à la suite de l’autre dans le fichier :

logging.level.com.mwaysolutions : DEBUG

Plusieurs journaux individuels #

com.mwaysolutions.relution.platform.security.ldap : DEBUG
com.mwaysolutions.relution.mdm.apple.service.AppleMdmResource : DEBUG

Dans l’exemple, la fonctionnalité LDAP et IosResource seraient maintenant activées dans le journal DEBUG. Les noms des loggers et la façon de les activer peuvent être trouvés dans le portail du système.

Configurer le niveau de log avec un utilisateur de log via l’API Web #

Depuis la version 5.18 de la Relution, il est possible de créer un utilisateur de journalisation spécial sur l’organisation du système, qui peut confortablement changer le niveau de journalisation via l’API Web. Cela permet d’éviter l’édition manuelle du fichier de configuration YAML ainsi qu’un redémarrage du serveur.

1. créer l’autorisation et l’utilisateur #

Pour créer l’utilisateur de journalisation, une nouvelle autorisation doit d’abord être créée dans l’organisation du système, où l’option “Système > Configuration de la journalisation” est activée et sauvegardée. Ensuite, un nouvel utilisateur peut être créé exclusivement pour l’accès à la journalisation, auquel l’autorisation précédemment créée est attribuée. Remarque : l’administrateur du système dispose de cette autorisation par défaut.

2. créer un jeton d’accès #

Un jeton d’accès peut être créé pour ce nouvel utilisateur afin de faciliter sa manipulation. Pour ce faire, l’utilisateur doit d’abord se connecter et créer le jeton via le profil de l’utilisateur. Le jeton d’accès n’est affiché qu’une seule fois, un autre jeton peut être créé si nécessaire.

3. contrôler le niveau de journalisation via l’API Web #

Pour contrôler le niveau de journalisation via l’API Web, il est possible d’accéder à l’utilisateur de journalisation dans l’organisation du système via l’icône ⚙️ > API Web > Autoriser. Le jeton d’accès de l’utilisateur de journalisation peut être utilisé pour faciliter l’accès et ajouter automatiquement l’authentification à curl. Dans l’élément “userAccessTokenAuth”, le jeton doit être inséré et autorisé. Note : Vous pouvez également vous connecter avec System System Orga Admin et ne pas saisir le jeton.

Au point “Logging”, les points d’enregistrement requis ainsi que le niveau d’enregistrement peuvent être définis et exécutés. L’exécution réussie est confirmée par le code 204 et la commande curl exécutée est affichée.

En outre, il est possible de rétablir les paramètres d’enregistrement par défaut en déclenchant une réinitialisation ou une restauration des points d’enregistrement.

4. contrôler le niveau de journalisation via la commande curl #

Il est également possible de contrôler le niveau de journalisation via la commande curl en enregistrant le curl généré via l’API Web en tant qu’alias ou script pour une utilisation ultérieure.

5. utilisation pour le personnel d’assistance ou d’autres employés #

Pour accorder l’accès à un utilisateur, par exemple un membre du personnel d’assistance de Relution, il suffit de, transmettre le jeton ou l’adresse électronique de l’utilisateur (helpdesk@relution.io), qui est liée à une instance valide de Relution, à l’équipe d’assistance de Relution.