Journalisation dans les applications PHP : bonnes pratiques pour débutants

Journalisation dans les applications PHP : bonnes pratiques pour débutants

La journalisation est le processus d'enregistrement d'informations sur le fonctionnement d'une application dans des fichiers spéciaux (logs). Pour les développeurs PHP débutants, savoir configurer correctement la journalisation est aussi important que connaître la syntaxe du langage. Les logs aident à :

\n
• Capturer les erreurs qui ne sont pas visibles à l'écran (par exemple, dans un environnement de production).
\n
• Suivre le comportement des utilisateurs et le fonctionnement du système.
\n
• Effectuer des audits de sécurité.
\n
• Accélérer le débogage de bugs complexes.
\n

Dans cet article, nous allons examiner les bonnes pratiques de journalisation en PHP : de la fonction intégrée error_log() à l'utilisation de bibliothèques professionnelles comme Monolog. Vous apprendrez comment ne pas encombrer votre code, choisir correctement les niveaux de journalisation et éviter les erreurs typiques des débutants.

1. Bases : journalisation intégrée en PHP

La façon la plus simple d'écrire quelque chose dans un log est d'utiliser la fonction error_log(). Elle peut envoyer des messages dans le log système du serveur, dans un fichier spécifié ou par email.

Exemple de journalisation de base

<?php\n// Écriture dans le log système (syslog)\nerror_log('Ceci est un message d\'erreur');\n\n// Écriture dans un fichier spécifique\nerror_log('Erreur de connexion à la base de données', 3, '/var/log/my_app_errors.log');\n?>

Avantages : ne nécessite pas l'installation de bibliothèques, fonctionne « prêt à l'emploi ».

Inconvénients :

\n
• Pas de flexibilité (impossible de changer facilement le format de sortie).
\n
• Difficile de filtrer par niveau d'importance.
\n
• Peu pratique pour travailler avec plusieurs canaux (fichier, base de données, Slack).
\n

Pour les scripts simples et l'apprentissage, cela suffit, mais pour des projets sérieux, il est préférable d'utiliser des solutions plus avancées.

2. Niveaux de journalisation : quand et quoi écrire

Pour que les logs soient utiles et non du « bruit », il est important de classer les messages par niveau de gravité. La norme PSR-3 (que nous allons détailler ci-dessous) propose 8 niveaux :

\n
• DEBUG — informations de débogage (valeurs des variables, temps d'exécution). Utilisé uniquement en phase de développement.
\n
• INFO — messages informatifs (utilisateur enregistré, requête traitée).
\n
• NOTICE — événements normaux mais importants (utilisation d'une API obsolète).
\n
• WARNING — avertissements (quelque chose s'est mal passé, mais l'application continue de fonctionner, par exemple un format de saisie incorrect).
\n
• ERROR — erreurs nécessitant une intervention (impossible de sauvegarder le fichier).
\n
• CRITICAL — erreurs critiques (composant principal du système indisponible).
\n
• ALERT — nécessite une action immédiate (piratage, panne de base de données).
\n
• EMERGENCY — système inutilisable.
\n

Exemple d'utilisation des niveaux (sans bibliothèques)

<?php\nfunction logMessage($level, $message) {\n    $logFile = __DIR__ . '/app.log';\n    $timestamp = date('Y-m-d H:i:s');\n    $formatted = "[{$timestamp}] [{$level}] {$message}" . PHP_EOL;\n    file_put_contents($logFile, $formatted, FILE_APPEND);\n}\n\nlogMessage('INFO', 'L\'utilisateur s\'est connecté');\nlogMessage('ERROR', 'Impossible de se connecter à la base de données');\n?>

Conseil : N'écrivez jamais de mots de passe, de jetons ou de requêtes SQL complètes avec des données utilisateur dans les logs — c'est une menace pour la sécurité.

3. PSR-3 et Monolog : approche professionnelle

PSR-3 est une recommandation de PHP-FIG qui décrit une interface unifiée pour les bibliothèques de journalisation. L'implémentation la plus populaire de PSR-3 est Monolog. Elle est utilisée dans Laravel, Symfony et de nombreux autres frameworks.

Installation de Monolog via Composer

composer require monolog/monolog

Exemple simple avec Monolog

<?php\nrequire 'v