Antoine MASLINE-CAMERINI

Développeur web

Il y a 9 mois

Laravel : Visualiser les logs laravel.log avec log-viewer

I. Introduction

A. Vue d'ensemble

Log-Viewer est un outil essentiel pour les développeurs Laravel qui cherchent à examiner et à analyser les logs générés par leur application. Il fournit une interface conviviale pour visualiser les logs enregistrés dans le fichier laravel.log, offrant ainsi une meilleure visibilité sur le fonctionnement de l'application en temps réel.

Photo illustrant log-viewer — Photo illustrant Log-Viewer

B. Importance du suivi des logs

Le suivi des logs est un aspect crucial du développement et de la maintenance d'une application Laravel. Les logs contiennent des informations précieuses sur les erreurs, les avertissements, les requêtes HTTP, les performances de l'application, et bien plus encore. En examinant ces logs, les développeurs peuvent diagnostiquer les problèmes, détecter les comportements anormaux et améliorer la fiabilité et les performances de leur application. Ainsi, un suivi efficace des logs est indispensable pour assurer le bon fonctionnement et la qualité d'une application Laravel.

II. Installation de Log-Viewer

A. Prérequis

Avant d'installer Log-Viewer, assurez-vous que votre environnement de développement Laravel respecte les prérequis suivants :

Un projet Laravel fonctionnel en place.
Composer installé sur votre système.
Laravel version 8 ou supérieure.

B. Installation via Composer

Pour installer Log-Viewer, exécutez la commande suivante dans votre terminal à la racine de votre projet Laravel :

composer require opcodesio/log-viewer

Cette commande téléchargera (importera) opcodesio/log-viewer dans le répertoire /vendor de votre projet, ainsi que toutes ses dépendances nécessaires.

III. Utilisation de Log-Viewer

A. Accès à l'interface

Une fois le package opcodesio/log-viewer téléchargé via composer, nous pouvons visualiser les fichiers /storage/logs/*.log et leurs contenu dans le navigateur en accédant à l'URL :

http://votre-domaine.com/log-viewer

Remplacez `votre-domaine.com` par l'adresse de votre site web Laravel. Une fois sur la page, vous devriez voir l'interface de Log-Viewer affichant les logs de votre application.

B. Filtrage des logs

Log-Viewer vous permet de filtrer les logs en fonction de différents critères, tels que le niveau de gravité (debug, info, warning, error, etc.) ou la date. Utilisez les options de filtrage fournies dans l'interface pour afficher uniquement les logs pertinents en fonction de vos besoins.

IV. Configuration dans Laravel

A. Publication du fichier de configuration

Vous pouvez publier le fichier de configuration de Log-Viewer en exécutant la commande suivante :

php artisan vendor:publish --tag="log-viewer-config"

Cette commande copie le fichier /vendor/opcodesio/log-viewer/config/log-viewer.php vers /config/log-viewer.php où nous pouvons éditer les paramètres :

B. Changer la route

Ouvrez le fichier config/log-viewer.php qui a été publié dans votre projet et recherchez la clé 'route'. Vous pouvez changer la valeur de cette clé pour définir une route personnalisée pour accéder à Log Viewer. Par exemple :

    /*
    |--------------------------------------------------------------------------
    | Log Viewer Route
    |--------------------------------------------------------------------------
    | Log Viewer will be available under this URL.
    |
    */

    'route_path' => 'log-viewer',

    /*
    |--------------------------------------------------------------------------
    | Back to system URL
    |--------------------------------------------------------------------------
    | When set, displays a link to easily get back to this URL.
    | Set to `null` to hide this link.
    |
    | Optional label to display for the above URL.
    |
    */

C. Changer les droits d'accès

Pour changer les droits d'accès (middleware) des logs avec opcodesio/log-viewer sur Laravel, modifier la ligne middleware en y associant les middleware de votre choix.
Exemple pour autoriser uniquement une personne connectée avec les droits administrateurs :

    /*
    |--------------------------------------------------------------------------
    | Log Viewer route middleware.
    |--------------------------------------------------------------------------
    | Optional middleware to use when loading the initial Log Viewer page.
    |
    */

    'middleware' => [
        'web',
        \Opcodes\LogViewer\Http\Middleware\AuthorizeLogViewer::class,
        'auth',
        'admin'
    ],

    /*
    |--------------------------------------------------------------------------
    | Log Viewer API middleware.
    |--------------------------------------------------------------------------
    | Optional middleware to use on every API request. The same API is also
    | used from within the Log Viewer user interface.
    |
    */

V. Bonnes pratiques et conseils

A. Gestion des logs

Pour une gestion efficace des logs, assurez-vous de définir des politiques claires concernant la rotation, l'archivage et la suppression des logs. Limitez la taille des fichiers de logs pour éviter les problèmes de stockage et de performance. Utilisez des outils de gestion des logs tels que Log-Viewer pour faciliter l'analyse et la recherche dans les logs, ce qui peut vous aider à diagnostiquer les problèmes plus rapidement.

B. Sécurité et confidentialité

Les logs peuvent contenir des informations sensibles telles que des données utilisateur ou des identifiants de session. Assurez-vous de configurer Log-Viewer de manière sécurisée en limitant l'accès aux personnes autorisées uniquement. Protégez les fichiers de logs en restreignant les permissions d'accès et en utilisant des mécanismes d'authentification robustes pour contrôler l'accès à l'interface de Log-Viewer.

C. Optimisation des performances

Pour optimiser les performances de votre application, limitez la quantité de logging effectuée dans votre code en ne loggant que les informations pertinentes. Évitez les logs excessivement verbeux qui pourraient surcharger votre système et affecter les performances de manière négative. Utilisez des niveaux de gravité appropriés pour hiérarchiser les logs en fonction de leur importance, et ajustez les paramètres de configuration de Log-Viewer pour optimiser la récupération et l'affichage des logs dans l'interface.

VI. Conclusion

A. Récapitulatif

Dans ce guide, nous avons exploré l'utilisation de Log-Viewer pour examiner et analyser les logs de votre application Laravel. Nous avons abordé les différentes fonctionnalités offertes par Log-Viewer, notamment l'accès à l'interface, le filtrage des logs, la recherche avancée et les actions disponibles. Nous avons également discuté de l'importance de la personnalisation de Log-Viewer, des bonnes pratiques de gestion des logs, de la sécurité et de la confidentialité, ainsi que de l'optimisation des performances.

B. Prochaines étapes

Après avoir terminé ce guide, vous devriez être en mesure d'utiliser Log-Viewer de manière efficace pour gérer les logs de votre application Laravel. Pour aller plus loin, vous pouvez explorer des fonctionnalités avancées telles que l'intégration avec d'autres outils de surveillance ou la création de rapports personnalisés à partir des logs. Continuez à vous familiariser avec les fonctionnalités et les meilleures pratiques de Log-Viewer pour optimiser le suivi des activités de votre application et améliorer sa fiabilité et ses performances.