Journalisation Laravel

Lors du développement d’une application moderne, la journalisation doit figurer en tête de liste des priorités.

La journalisation fournit un moyen de visualiser votre application tant en développement qu’en production, ce qui permet la transparence et la visibilité. Avec une journalisation correctement structurée, les applications modernes peuvent devenir plus faciles à maintenir, car nous pouvons identifier de manière proactive les points de défaillance et les goulots d’étranglement dans notre application.

Le framework Laravel est livré avec un système de journalisation robuste qui prend en charge tous les problèmes liés à la configuration d’un système de journalisation correctement structuré. Ce nouveau système de journalisation introduit dans Laravel 6.5 est puissant, et nous allons l’explorer dans cet article.

Qu’est-ce que la journalisation Laravel ?

La journalisation Laravel concerne la façon dont Laravel gère la journalisation, ou le signalement automatique des problèmes, en utilisant un système de journalisation PHP viral appelé Monolog. Cependant, en raison de la philosophie de Laravel qui consiste à utiliser des bibliothèques existantes populaires pour implémenter différentes fonctionnalités du framework, Laravel utilise Monolog pour tous ses besoins de journalisation.

Monolog est une bibliothèque de journalisation PHP très flexible et populaire que nous pouvons configurer pour envoyer vos journaux vers des fichiers, des sockets, des bases de données et d’autres services w eb. Monolog fournit une interface familière pour l’écriture de journaux à partir de fichiers texte standard jusqu’à des services tiers avancés de gestion de journaux. Laravel configure généralement Monolog pour utiliser un fichier de configuration de journalisation standard.

Les bases de la journalisation Laravel

Apprendre les bases de la journalisation vous aidera à comprendre comment Laravel gère la journalisation et comment vous pouvez améliorer vos pratiques de journalisation structurée.

Examinons deux concepts essentiels de la journalisation pour mieux comprendre comment mettre en œuvre nos procédures de journalisation.

Journalisation structurée de Laravel

Dans le développement de logiciels, la journalisation structurée consiste à mettre en œuvre un format de message prédéterminé et cohérent pour les journaux d’application. Ce format permet de traiter les messages comme des données qui peuvent être surveillées, manipulées et visualisées bien mieux que le format texte ordinaire.

Comme Laravel utilise Monolog, les développeurs peuvent rapidement mettre en œuvre une journalisation structurée en configurant l’outil de journalisation pour qu’il reçoive des types d’informations spécifiques, en stockant les fichiers journaux dans différents formats et en envoyant les journaux à divers services tiers de gestion des journaux pour les visualiser.

Journalisation centralisée de Laravel

Dans un système de journalisation centralisée, les journaux sont envoyés à des solutions de gestion centralisée des journaux (Centralized Log Management ou CLM) à partir de plusieurs sources pour être facilement consolidés et visualisés. Cependant, la CLM est une solution de journalisation spécialisée qui collecte les messages de journalisation de différentes sources et consolide les données pour un traitement et une visualisation faciles.

Outre la collecte de données, la CLM est également censée prendre en charge l’analyse des données de journalisation et la présentation claire des données après analyse.

Journalisation structurée vs journalisation de base

Examinons la différence entre la journalisation structurée et la journalisation de base (non structurée) et pourquoi vous devriez utiliser la journalisation structurée dans votre projet Laravel.

Journalisation de base

Dans la journalisation de base, les fichiers journaux sont stockés dans un format brut avec des données limitées pour interroger et identifier les journaux individuels.

Il y a trois grandes raisons d’éviter d’utiliser la journalisation de base :

• Les systèmes centralisés de gestion des journaux ne peuvent pas travailler avec les données sans support supplémentaire.
• Une solution personnalisée est nécessaire pour lire et analyser les données d’une solution de journalisation de base.
• Il peut être difficile pour les administrateurs de lire les données de journalisation de base car elles sont brutes et non structurées.

La journalisation structurée

La journalisation structurée permet aux développeurs de gagner du temps en utilisant des outils d’analyse de journaux tiers à code open source qui prennent en charge la structure standard des journaux pour lire, visualiser et analyser les journaux.

Voici quelques exemples de données que vous pouvez collecter avec la journalisation structurée :

• Le port utilisé pour exécuter la fonction
• La date et l’heure auxquelles l’événement s’est produit
• Le nom d’utilisateur ou l’ID du client
• Une description de l’événement (message du journal)
• Le protocole utilisé pour exécuter la fonction
• L’emplacement de l’événement déclenché (indiquer l’API ou l’application en cours d’exécution)
• L’ID unique de l’événement
• Le type d’action déclenchée (niveau du journal)

Les journaux doivent contenir suffisamment de données pour permettre de visualiser facilement la solution ou la raison de l’événement de journal. Notez également que vous ne devez pas stocker tous les types d’informations, comme les mots de passe ou les données sensibles dans les journaux.