Journalisation dans les applications PHP : meilleures pratiques et outils

Journalisation dans les applications PHP : bonnes pratiques

La journalisation ne se limite pas à écrire les erreurs dans un fichier. C'est un processus systématique de collecte, de stockage et d'analyse des informations sur le fonctionnement d'une application. Dans le développement PHP, une journalisation bien configurée permet de trouver rapidement les bugs, de suivre les anomalies dans le comportement des utilisateurs et d'assurer un audit de sécurité. Dans cet article, nous allons examiner les bonnes pratiques de journalisation en PHP, des normes aux outils avancés.

1. Pourquoi la journalisation est nécessaire et principes de base

La journalisation répond à plusieurs objectifs clés :

• Débogage — enregistrement de l'état de l'application au moment de l'erreur.
• Surveillance — suivi des performances et de la charge.
• Sécurité — enregistrement des actions suspectes (tentatives d'intrusion, accès non autorisé).
• Audit — documentation des opérations métier critiques.

Principes de base d'une bonne journalisation :

• Ne mentez pas — les logs doivent refléter l'état réel du système.
• Structuration — utilisez un format unifié (JSON, key=value).
• Niveaux de priorité — séparez debug, info, warning, error, critical.
• Pas de secrets — n'écrivez jamais de mots de passe, jetons ou données personnelles.

2. Norme PSR-3 et interface LoggerInterface

PHP-FIG recommande d'utiliser PSR-3 — une interface standard pour les bibliothèques de journalisation. Elle définit 8 niveaux (de debug à emergency) et un contrat unifié.

Exemple d'implémentation utilisant PSR-3 :

<?phpuse Psr\\Log\\AbstractLogger;

class SimpleLogger extends AbstractLogger{    public function log($level, $message, array $context = [])    {        $logEntry = sprintf(            '[%s] %s: %s %s',            date('Y-m-d H:i:s'),            strtoupper($level),            $message,            json_encode($context)        );        file_put_contents('/var/log/app.log', $logEntry . PHP_EOL, FILE_APPEND);    }}

$logger = new SimpleLogger();$logger->info('Utilisateur enregistré', ['user_id' => 42]);?>

L'utilisation de PSR-3 permet de remplacer facilement la bibliothèque de journalisation (par exemple, de Monolog à une implémentation personnalisée) sans modifier le code de l'application.

3. Monolog — un outil puissant pour la journalisation

Monolog est la bibliothèque de journalisation la plus populaire pour PHP (installation via Composer : composer require monolog/monolog). Elle prend en charge de nombreux gestionnaires (handlers) et formateurs.

Configuration de base de Monolog

<?phpuse Monolog\\Logger;use Monolog\\Handler\\StreamHandler;use Monolog\\Handler\\FirePHPHandler;use Monolog\\Formatter\\LineFormatter;

$logger = new Logger('my_app');

// Gestionnaire pour fichier$fileHandler = new StreamHandler(__DIR__ . '/logs/app.log', Logger::WARNING);$fileHandler->setFormatter(new LineFormatter("[%datetime%] %level_name%: %message% %context%"));$logger->pushHandler($fileHandler);

// Gestionnaire pour navigateur (FirePHP)$logger->pushHandler(new FirePHPHandler());

// Utilisation$logger->warning('Droits d'accès insuffisants', ['user' => 'guest']);$logger->error('Erreur de connexion à la base de données', ['db_host' => 'localhost']);?>

Fonctionnalités avancées de Monolog

• FingersCrossedHandler — met en mémoire tampon les logs et ne les écrit que lorsqu'un certain niveau est atteint (économise de l'espace).
• GroupHandler — envoie les logs simultanément vers plusieurs canaux (fichier + Email + Slack).
• Processors — ajoutent du contexte (adresse IP, ID de session, temps d'exécution).

Exemple avec un processeur pour ajouter l'IP :