Laravel

Dans le développement d’applications web avec Laravel, deux concepts clés pour assurer la fiabilité et la performance sont le monitoring et le profiling. Ces deux processus, bien que distincts, sont tous deux cruciaux pour identifier et résoudre les problèmes potentiels dans l’application. Le monitoring permet de surveiller l’état et les performances de l’application, tandis que le profiling fournit des informations détaillées sur l’utilisation des ressources et la consommation de temps par différentes parties du code.

Le monitoring est essentiel pour s’assurer que l’application fonctionne correctement et reste disponible pour les utilisateurs. Il permet de détecter les problèmes dès qu’ils se produisent et d’intervenir rapidement pour les résoudre, réduisant ainsi la durée et l’impact de la panne. Le profiling, quant à lui, est vital pour identifier les parties du code qui consomment trop de temps ou de ressources, ce qui peut ralentir l’application et causer une mauvaise expérience utilisateur.

Dans cet article, nous examinerons les outils et les techniques disponibles pour mettre en place un monitoring et un profiling efficaces dans le cadre du développement Laravel. Nous verrons comment ces pratiques peuvent vous aider à améliorer la fiabilité et les performances de votre application, ainsi que la satisfaction de vos utilisateurs.

Le monitoring

Le monitoring est un élément essentiel dans le développement d’applications web avec Laravel. Il s’agit de la surveillance continue de l’état et des performances de votre application, pour s’assurer qu’elle fonctionne comme prévu et reste disponible pour les utilisateurs. Le monitoring permet de détecter les problèmes dès qu’ils apparaissent, de diagnostiquer les causes racines et de prendre rapidement les mesures nécessaires pour corriger les erreurs ou les défaillances.

Parmi les principaux aspects du monitoring Laravel, nous pouvons citer la surveillance de l’uptime et de la disponibilité de l’application, la gestion des exceptions et des erreurs, la surveillance des performances et des temps de réponse, et l’analyse des journaux d’activité. Le monitoring peut également inclure des aspects liés à la sécurité, tels que la détection des attaques par force brute, des intrusions dans le système ou des anomalies dans le trafic réseau.

Dans ce chapitre, nous aborderons les outils et les techniques disponibles pour mettre en place un monitoring efficace pour votre application Laravel. Nous examinerons comment configurer et utiliser les fonctionnalités de monitoring intégrées à Laravel, ainsi que les services de monitoring externes tels que Sentry, New Relic ou DataDog. Nous verrons par ailleurs comment interpréter les données de monitoring pour identifier les tendances, les problèmes potentiels et les opportunités d’amélioration de votre application.

En mettant en place un monitoring proactif et exhaustif, vous pouvez non seulement éviter les pannes et les temps d’arrêt inattendus, mais aussi optimiser continuellement les performances et l’expérience utilisateur de votre application Laravel.

Les logs

Les logs sont des enregistrements des événements se produisant au sein de votre application. Dans Laravel, les logs sont une composante essentielle du monitoring et du débogage, car ils permettent de garder une trace des actions, des erreurs et des processus importants.

• Logging intégré : Laravel fournit un système de log intégré basé sur des "canaux". Chaque canal représente une façon spécifique d'enregistrer les informations de log. Par exemple, le canal "single" écrit les logs dans un fichier unique, tandis que le canal "daily" crée un nouveau fichier de log chaque jour.
• Diversité des canaux : Laravel prend en charge un large éventail de canaux de log, tels que les fichiers, les bases de données, les services web, les sockets, etc. Cela vous permet de choisir le type de log le plus adapté à vos besoins.
• Configuration des niveaux de log : Laravel vous permet de configurer les niveaux de log (debug, info, notice, warning, error, critical, alert et emergency) afin de filtrer les messages en fonction de leur gravité.
• Personnalisation : Laravel vous permet d'étendre et de personnaliser le comportement de log grâce à l'utilisation de Monolog, une bibliothèque de log PHP populaire et flexible.

Pour configurer les logs dans votre application Laravel, suivez les étapes suivantes : Ouvrez le fichier config/logging.php : Définissez les canaux de log souhaités et configurez leurs options:

'channels' => [

    'stack' => [
        'driver' => 'stack',
        'channels' => explode(',', env('LOG_STACK', 'single')),
        'ignore_exceptions' => false,
    ],

    'single' => [
        'driver' => 'single',
        'path' => storage_path('logs/laravel.log'),
        'level' => env('LOG_LEVEL', 'debug'),
        'replace_placeholders' => true,
    ],

    'daily' => [
        'driver' => 'daily',
        'path' => storage_path('logs/laravel.log'),
        'level' => env('LOG_LEVEL', 'debug'),
        'days' => env('LOG_DAILY_DAYS', 14),
        'replace_placeholders' => true,
    ],
...

Pour chaque canal, sélectionnez le pilote (driver) approprié (par exemple, 'single', 'daily', 'slack', etc.). Configurez les niveaux de log pour chaque canal. Pour finir enregistrez les modifications apportées au fichier de configuration. L'utilisation de logs dans votre application Laravel est simple et intuitive :

• Importez le Facade Log à l'aide de l'instruction use Log.
• Pour enregistrer un message de log, utilisez la méthode Log::{niveau}('Message de log'). Remplacez {niveau} par l'un des niveaux de log disponibles (debug, info, notice, warning, error, critical, alert et emergency).
• Optionnellement, vous pouvez ajouter des contextes aux messages de log à l'aide de tableaux associatifs.

Le plus classique est d'avoir la création d'un fichier des logs ici :

Vous retrouvez là empilés en fonction de leur date toutes les erreurs en fonctions des critères que vous avez déterminés, voici un exemple :

2024-07-23 16:10:38] local.ERROR: SQLSTATE[42S22]: Column not found: 1054 Unknown column 'date' in 'order clause' (Connection: mysql, SQL: select * from `events` order by `date` asc, `start_date` asc limit 10 offset 0) {"userId":1,"exception":"[object] (Illuminate\\Database\\QueryException(code: 42S22): SQLSTATE[42S22]: Column not found: 1054 Unknown column 'date' in 'order clause' (Connection: mysql, SQL: select * from `events` order by `date` asc, `start_date` asc limit 10 offset 0) at E:\\laragon\\www\\sillo\\vendor\\laravel\\framework\\src\\Illuminate\\Database\\Connection.php:813)
[stacktrace]
#0 E:\\laragon\\www\\sillo\\vendor\\laravel\\framework\\src\\Illuminate\\Database\\Connection.php(767): Illuminate\\Database\\Connection->runQueryCallback('select * from `...', Array, Object(Closure))
#1 E:\\laragon\\www\\sillo\\vendor\\laravel\\framework\\src\\Illuminate\\Database\\Connection.php(398): Illuminate\\Database\\Connection->run('select * from `...', Array, Object(Closure))
#2 E:\\laragon\\www\\sillo\\vendor\\laravel\\framework\\src\\Illuminate\\Database\\Query\\Builder.php(2996): Illuminate\\Database\\Connection->select('select * from `...', Array, true)
#3 E:\\laragon\\www\\sillo\\vendor\\laravel\\framework\\src\\Illuminate\\Database\\Query\\Builder.php(2981): Illuminate\\Database\\Query\\Builder->runSelect()

En résumé, les logs sont un aspect essentiel du développement Laravel. Grâce à la flexibilité, à la diversité et à la facilité d'utilisation des fonctionnalités de log intégrées, Laravel offre aux développeurs un contrôle total sur la gestion et l'analyse des logs.

Supervision de la file d'attente avec Horizon

Laravel Horizon est un outil puissant qui permet de superviser et de gérer les files d'attente dans les applications Laravel. Il offre une interface utilisateur élégante et intuitive, des statistiques en temps réel et des fonctionnalités avancées de gestion des tâches. Mais ça implique que vous utilisiez Redis pour vos files d'attente.

Fonctionnalités de Laravel Horizon :

• Tableau de bord en temps réel : Horizon fournit un tableau de bord affichant les statistiques en temps réel sur les files d'attente, les travailleurs, les échecs et les délais de traitement.
• Gestion des travailleurs (jobs) : Horizon simplifie la gestion des travailleurs de files d'attente en fournissant des outils pour arrêter, redémarrer et contrôler les travailleurs individuels.
• Notifications : Horizon permet de configurer des notifications en cas d'échec des tâches ou de dépassement de temps d'exécution.
• Prévisualisation des tâches : Vous pouvez prévisualiser les tâches de la file d'attente dans Horizon pour identifier rapidement les problèmes potentiels.
• Journalisation et débogage : Horizon fournit des outils de journalisation et de débogage intégrés pour faciliter le diagnostic et la résolution de problèmes liés aux files d'attente.

Pour la configuration et l'utilisation référez-vous à la documentation officielle.

Analyse de performances Laravel avec Inspector

Laravel Inspector est un service de monitoring de performances conçu pour les applications Laravel. Il permet de collecter des données précieuses sur les temps de réponse, les traces de pile et les exceptions, contribuant ainsi à identifier les goulets d'étranglement et à améliorer les performances de votre application.

Fonctionnalités de Laravel Inspector :

• Visualisation des temps de réponse : Inspector fournit un graphique à barres détaillé qui affiche les temps de réponse de vos routes, contrôleurs et méthodes.
• Analyse de traces de pile : Inspector enregistre les traces de pile pour chaque requête, ce qui permet de suivre la séquence d'exécution de votre code et d'identifier les zones d'amélioration potentielles.
• Surveillance des exceptions : Inspector permet de suivre les exceptions survenues dans votre application, avec des informations détaillées sur les messages d'erreur, les traces de pile et les requêtes associées.
• Alertes de performances : Configurez des seuils de performances pour être notifié en cas de temps de réponse élevé ou d'autres problèmes de performances.
• Intégration facile : Laravel Inspector peut être intégré à votre application Laravel en quelques étapes simples.

Il existe une version gratuite mais limitée avec 30000 transactions par mois et 10 analyses d'IA. Une bonne façon de découvrir le produit et de voir s'il vous convient.

Intégration avec des outils externes

Laravel offre la possibilité d'intégrer des services de monitoring externes pour surveiller l'état, les performances et la sécurité de vos applications.

Sentry

Sentry est un outil de monitoring d'erreurs et de suivi de performances pour les applications web.

Il existe une version gratuite pour un seul utilisateur avec monitoring et trace des erreurs et alertes et notification par emails.

Voici la démarche pour l'utiliser :

• Créez un compte Sentry et obtenez votre clé DSN.
• Suivez les étapes décrites avec précision dans leur documentation

New Relic

New Relic est une plateforme de monitoring de performances qui fournit des analyses détaillées sur les temps de réponse, les transactions et les erreurs dans vos applications web.

Vous pouvez le tester gratuitement.

Zabbix

Zabbix est un système de monitoring open-source pour les infrastructures informatiques.

Il existe un package sur Github pour l'intégration dans Laravel mais il est trop vieux pour être encore utilisable. Par contre vous pouvez installer Zabbix sur votre serveur et utiliser l'API. Il y a une documentation détaillée en français ici.

Le profiling

Le profiling est un processus essentiel dans le développement d’applications Laravel, qui permet de collecter des données détaillées sur la consommation de ressources et le temps d’exécution de différentes parties du code. Cette technique est cruciale pour identifier les sections de l’application qui peuvent ralentir le fonctionnement global, affecter la réactivité de l’interface utilisateur ou surcharger les ressources du serveur.

Le profiling peut être réalisé à différents niveaux de granularité, y compris au niveau du code, des requêtes de base de données, des services externes ou de l’architecture d’ensemble de l’application. Les informations recueillies au cours de ce processus aident à prendre des décisions éclairées pour optimiser le code, améliorer les performances, et délivrer une expérience utilisateur fluide et efficace.

Dans ce chapitre, nous explorerons diverses méthodes et outils de profiling disponibles pour Laravel. Nous verrons comment utiliser les fonctionnalités de profiling intégrées à Laravel, ainsi que des packages tierces populaires tels que Telescope ou Clockwork. Nous découvrirons également comment analyser et interpréter les données de profiling pour prendre des mesures ciblées d’amélioration de l’application.

Avec le profiling efficace, vous pouvez transformer votre application Laravel en une solution performante et fiable qui offre une expérience utilisateur exceptionnelle.

Telescope

Laravel Telescope est un assistant de debugging élégant pour le framework Laravel. Il fournit des informations précieuses sur les requêtes entrantes, les exceptions, les entrées de journal, les requêtes de base de données, les travaux planifiés, les notifications, les opérations de cache, les variables de dump et bien plus encore. En fait il assure aussi bien le monitoring que le profiling.

Fonctionnalités de Laravel Telescope

• Tableau de bord interactif : Telescope fournit un tableau de bord interactif affichant les requêtes, les exceptions, les entrées de journal, les requêtes de base de données et les tâches planifiées en temps réel.
• Informations détaillées sur les exceptions : Visualisez les exceptions avec des traces de pile détaillées, les variables de contexte et les données de requête associées.
• Exploration de la base de données : Observez les requêtes de base de données, leurs temps d'exécution et le nombre de résultats, ainsi que les explications des requêtes générées par Laravel.
• Analyse des tâches planifiées : Suivez les tâches planifiées, les commandes artisan, les travaux de file d'attente et les délais de planification. Visualisation de variables : Vérifiez les variables de dump dans vos requêtes pour mieux comprendre l'état de votre application pendant le développement.

Installation de Laravel Telescope