Journalisation en C# : meilleures pratiques pour les développeurs débutants

Introduction : Pourquoi la journalisation est la base d'une application stable

Tout développeur, surtout débutant, se retrouve tôt ou tard dans une situation où l'application plante, sans pouvoir en comprendre la cause. Sans logs, vous êtes aveugle. La journalisation n'est pas simplement l'enregistrement de messages dans un fichier, mais un outil puissant de monitoring, de débogage et d'analyse du comportement du programme. Dans l'écosystème C# (.NET), il existe plusieurs frameworks matures qui permettent de configurer flexiblement la sortie des logs. Dans cet article, nous allons analyser les meilleures pratiques de journalisation pour les débutants : du choix de la bibliothèque à la sortie structurée des données.

1. Choix de la bibliothèque de journalisation : NLog vs Serilog

Pour les applications .NET, il existe deux acteurs principaux : NLog et Serilog. Les deux sont gratuits, activement maintenus et disposent de milliers d'intégrations. Lequel choisir ?

NLog

• Simplicité de configuration via XML ou code.
• Excellente performance sous forte charge.
• Support intégré de la rotation des fichiers, envoi d'emails, écriture en base de données.
• Adapté aux projets nécessitant un démarrage rapide sans dépendances superflues.

Serilog

• Accent sur la journalisation structurée (structured logging).
• Les logs sont stockés non pas comme des chaînes, mais comme des objets avec des champs — cela simplifie la recherche et l'analyse.
• Idéal pour les microservices et les systèmes où les logs sont collectés dans Elasticsearch ou Grafana.
• La syntaxe avec des espaces réservés {Property} rend le code plus lisible.

Conseil pour les débutants : Commencez avec Serilog si vous prévoyez d'utiliser des outils de monitoring modernes. Si le projet est petit et local, NLog fera l'affaire.

// Exemple de configuration de Serilog dans Program.cs (.NET 6+)using Serilog;

Log.Logger = new LoggerConfiguration()    .MinimumLevel.Information()    .WriteTo.Console()    .WriteTo.File("logs/app-.log", rollingInterval: RollingInterval.Day)    .CreateLogger();

var builder = WebApplication.CreateBuilder(args);builder.Host.UseSerilog(); // Connecte Serilog à l'hôte

2. Niveaux de journalisation : quand et quoi écrire

L'une des erreurs les plus fréquentes des débutants est d'écrire tout et n'importe quoi au niveau Info ou Error. Cela encombre les logs et les rend inutiles. Dans .NET, les niveaux suivants sont adoptés (par ordre croissant d'importance) :

• Trace — les moindres détails : entrée/sortie des méthodes, itérations de boucles. Utilisé uniquement en débogage approfondi.
• Debug — informations de débogage pour le développeur : valeurs des variables, état des objets.
• Information — événements clés du fonctionnement de l'application : démarrage, arrêt, traitement réussi d'une requête.
• Warning — problèmes potentiels qui ne cassent pas le fonctionnement : requête lente, version obsolète d'une API.
• Error — exceptions et pannes nécessitant une intervention : erreur de base de données, timeout.
• Fatal — erreurs critiques après lesquelles l'application ne peut pas continuer à fonctionner.

// Exemple d'utilisation de différents niveauxILogger<MyService> _logger;

public async Task ProcessOrderAsync(int orderId){    _logger.LogInformation("Début du traitement de la commande {OrderId}", orderId);

    try    {        var result = await _repository.GetOrderAsync(orderId);        if (result == null)        {            _logger.LogWarning("Commande {OrderId} non trouvée", orderId);            return;        }        // ... logique    }    catch (Exception ex)    {        _logger.LogError(ex, "Erreur lors du traitement de la commande {OrderId}", orderId);        throw; // On remonte l'exception si on ne peut pas récupérer    }}

Meilleure pratique