Journalisation dans les applications C# : meilleures pratiques en pratique

Formateur Python en ligne pour débutants

Apprenez Python facilement sans surcharge théorique. Résolvez des tâches pratiques avec vérification automatique et écrivez du code directement dans le navigateur.

Start Course

Journalisation dans les applications C# : meilleures pratiques en pratique

La journalisation ne consiste pas simplement à écrire des messages dans un fichier. C'est un outil essentiel de surveillance, de débogage et d'audit pour toute application de production en C#. Une journalisation correctement configurée permet de trouver rapidement les causes des pannes, d'analyser le comportement du système et de prévenir les incidents. Dans cet article, nous allons passer en revue les meilleures pratiques de journalisation dans .NET que vous pourrez immédiatement appliquer dans vos projets.

1. Choix de la bibliothèque : Serilog vs NLog vs ILogger intégré

Dans le .NET moderne, il existe trois approches principales de la journalisation. Examinons leurs points forts.

ILogger intégré (Microsoft.Extensions.Logging) — une interface abstraite de base. Il est intégré dans ASP.NET Core et est minimalement configurable. Convient aux projets simples, mais nécessite des fournisseurs tiers pour les scénarios avancés.
Serilog — la norme de facto dans l'industrie. Il prend en charge la journalisation structurée "prête à l'emploi", un riche écosystème de sinks (destinations) et une configuration simple via la configuration.
NLog — un framework mature avec un routage flexible et la prise en charge des systèmes legacy. Il se distingue par ses hautes performances et la configuration détaillée des règles.

Recommandation : pour les nouveaux projets, utilisez Serilog — il s'intègre le mieux aux pratiques modernes (ELK, Application Insights). Pour les systèmes à forte charge où les performances sont critiques, envisagez NLog.

// Exemple de configuration minimale de Serilog dans Program.csusing Serilog;

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

try{    Log.Information("Application démarrée");    // votre code}catch (Exception ex){    Log.Fatal(ex, "Erreur critique au démarrage");}finally{    Log.CloseAndFlush();}

2. Niveaux de journalisation : quand et quoi écrire

Un mauvais choix du niveau de journalisation est l'une des erreurs les plus fréquentes. Examinons chaque niveau et son objectif.

Trace / Verbose — uniquement pour le débogage par le développeur. Ne jamais activer en production sans nécessité absolue.
Debug — informations de diagnostic pour le développement. Peut être activé temporairement pour rechercher un problème.
Information — fonctionnement normal de l'application : requêtes, opérations réussies, événements métier. Niveau principal en production.
Warning — problème potentiel : espace disque faible, tentatives répétées, API obsolète.
Error — exceptions et pannes que l'application a gérées, mais que l'utilisateur a remarquées.
Fatal / Critical — erreurs irrécupérables nécessitant une intervention immédiate de l'administrateur.

// Exemple d'utilisation correcte des niveauxpublic class OrderService{    private readonly ILogger<OrderService> _logger;

    public OrderService(ILogger<OrderService> logger)    {        _logger = logger;    }

    public async Task<Order> CreateOrderAsync(CreateOrderRequest request)    {        _logger.LogInformation("Création d'une commande pour l'utilisateur {UserId}", request.UserId);

        try        {            var order = await _repository.SaveAsync(request);            _logger.LogInformation("Commande {OrderId} créée avec succès", order.Id);            return order;        }        catch (Exception ex)        {            _logger.LogError(ex, "Erreur lors de la création de la commande pour l'utilisateur {UserId}", request.UserId);            throw;        }    }}