La journalisation est une partie importante du processus de développement. La journalisation aide à protéger les développeurs et les utilisateurs contre les pannes et les problèmes à grande échelle dans les applications et les systèmes.
Découvrons ce que sont les fichiers journaux et comment enregistrer la valeur du journal dans AppMaster.
Que sont les journaux ?
Un journal est un fichier texte qui contient des informations système sur le fonctionnement du logiciel ou du serveur. Le journal comprend des données sur les actions effectuées par le programme ou l'utilisateur.
Pourquoi les journaux sont-ils nécessaires ?
Lorsque des erreurs se produisent dans le fonctionnement d'un serveur, d'un programme ou d'un ordinateur, les spécialistes se réfèrent aux journaux pour déterminer la cause et la source de cette erreur.
Les journaux répertorient les événements dans l'ordre chronologique, leurs sources et erreurs, et pourquoi ils se sont produits. Différents spécialistes peuvent utiliser les journaux. Pour les administrateurs, les fichiers journaux contiennent des informations sur les raisons pour lesquelles les périphériques et les systèmes ont échoué. Les développeurs ont besoin de journaux pour le débogage - trouver et corriger les erreurs sur un site Web ou une application. Les journaux sont également utiles pour les spécialistes du référencement qui suivent les statistiques de trafic en les utilisant.
La journalisation et l'analyse des journaux sont l'outil le plus important dans le travail des informaticiens. Il vous permet d'identifier rapidement les causes et les sources des problèmes et des pannes et de les corriger. Dans les applications, les journaux aident à surveiller leur travail pour trouver des bogues à temps.
Niveaux et types de journaux
La journalisation est nécessaire à toutes les étapes du développement et lors de la poursuite de l'exploitation du logiciel. Cela peut accumuler de nombreux fichiers journaux, qui seront très difficiles à comprendre. Par conséquent, ils sont divisés en niveaux et types pour la commodité et la simplification de la recherche et de la lecture.
Il existe quatre niveaux principaux de journaux :
- Débogage — enregistrement des transitions d'état à grande échelle : accès aux bases de données, démarrage et arrêt du service.
- Avertissement — situations anormales, par exemple, un format de demande incorrect.
- Erreur — un enregistrement des erreurs typiques.
- Fatal — plantages fatals : accès à la base de données refusé, manque d'espace disque.
Il existe deux niveaux supplémentaires de journalisation :
- Trace - enregistrement du processus étape par étape ; est nécessaire lorsqu'il est difficile de localiser le problème.
- Info — informations générales sur le fonctionnement du service.
Types de journaux :
- Serveur — appels au serveur et erreurs qui se produisent pendant les appels ;
- Événement - enregistre les données sur le trafic et l'utilisation du réseau (tentatives de connexion, événements d'application);
- Système — tous les événements système ;
- Journaux d'autorisation et d'authentification — processus de connexion et de déconnexion, problèmes d'accès, etc. ;
- Journaux des applications qui se trouvent dans ce système ;
- Journaux de la base de données — accès à la base de données.
Comment écrire correctement les logs ?
Pour que la journalisation reste pratique à utiliser, vous devez écrire les journaux correctement :
- consigner tous les événements critiques, tels que l'arrêt des transactions et le démarrage d'une application ;
- ajoutez des balises pour accéder rapidement aux enregistrements souhaités ;
- supprimer les mots répétés ;
- établir un format de création de fichiers journaux dans l'entreprise pour standardiser le processus ;
- entrez uniquement les informations requises.
Connexion à AppMaster
Chaque projet AppMaster prend en charge la journalisation standard. Pour travailler avec les logs, allez dans l'onglet Project / Deploy Stats. Ici, dans l'onglet Journaux d'application, vous trouverez tous les journaux d'application.
Comment écrire la valeur du journal dans le fichier d'application ?
Le système enregistre automatiquement certains événements dans un fichier, mais vous pouvez également enregistrer les données nécessaires. L'éditeur de processus métier dispose d'un bloc Write to log pour ce faire.
Le bloc a deux champs de saisie :
- Étiquette — un titre qui est écrit dans le fichier journal au format chaîne ;
- Entrée — toute valeur qui doit être stockée dans le journal.
Création d'un enregistreur
Vous pouvez également créer un enregistreur dans AppMaster. C'est très pratique lorsque de nombreuses requêtes sont envoyées à l'application, et il n'est pas pratique de tout enregistrer manuellement.
Pour créer un logger, créez d'abord un modèle de données — Log et ajoutez les champs suivants :
- Libellé — pour le titre de l'entrée ;
- Texte — pour le corps de l'entrée.
Pour enregistrer les valeurs dans le journal, vous aurez besoin d'un processus métier. Créez un nouveau tiers et paramétrez les champs du bloc Début :
- Étiquette - au format chaîne ;
- Texte - au format chaîne.
Ensuite, ajoutez un bloc Make et créez un enregistrement en lui transmettant les champs du bloc Start.
Enregistrez l'enregistrement dans la base de données à l'aide du bloc Créer.
Vous devez créer un point de terminaison pour le nouveau BP afin qu'il soit accessible depuis le frontend. Accédez à l'onglet Points de terminaison et créez un nouveau point de terminaison. Définir les options :
- Sélectionnez la méthode POST ;
- Définissez l'URL ;
- Sélectionnez un groupe ;
- Définissez le processus métier créé.
Maintenant, vous pouvez utiliser le BP créé où vous voulez écrire des journaux.
Pour résumer
Résumons tout ce dont nous avons discuté sur les journaux.
Les journaux sont donc les enregistrements des événements qui se produisent dans une application. Ils peuvent aider à résoudre les problèmes, à suivre l'utilisation et à surveiller la sécurité.
Il peut être difficile de déterminer la cause d'un problème ou l'origine d'un problème sans journaux. Les journaux peuvent vous aider à identifier les bogues et les problèmes pour les résoudre avant qu'ils ne causent des problèmes importants.
Lors de la rédaction des journaux, il est essentiel d'être aussi précis que possible. Incluez la date et l'heure de l'événement, le type d'événement, le niveau de journalisation, les données concernées et toute autre information pertinente.
Il est également important de garder vos journaux en sécurité. Si des données sensibles sont enregistrées, assurez-vous de les chiffrer. Et ne stockez pas les journaux dans un emplacement accessible au public. Seul le personnel autorisé doit y avoir accès.
