.net Core Logging Middleware Serilog

5 min read Jun 03, 2024

Améliorez la journalisation de votre application .NET Core avec Serilog

Introduction

Lorsque vous développez une application .NET Core, il est crucial de pouvoir suivre les événements qui s'y produisent afin de pouvoir déboguer les problèmes et d'améliorer les performances. Le système de journalisation intégré à .NET Core est une bonne base, mais il peut manquer de fonctionnalités et de flexibilité. Serilog est un framework de journalisation puissant et extensible qui vous permet de contrôler la façon dont les événements sont enregistrés et de les envoyer à plusieurs destinations.

Pourquoi utiliser Serilog ?

Serilog offre de nombreux avantages par rapport au système de journalisation intégré de .NET Core :

Formatage riche : Serilog vous permet de formater vos messages de journalisation de manière plus flexible et lisible, en utilisant des informations structurées.
Diversité des sinks : Serilog prend en charge un large éventail de sinks (destinations de journalisation), tels que les fichiers, la console, les bases de données, les services de journalisation cloud, etc.
Extensions : Serilog dispose d'une large communauté et d'un écosystème d'extensions qui vous permettent d'intégrer des fonctionnalités spécifiques à vos besoins.
Performances élevées : Serilog est conçu pour être performant, ce qui est important pour les applications exigeantes.

Intégration de Serilog dans une application .NET Core

Pour intégrer Serilog dans votre application .NET Core, vous pouvez utiliser le package NuGet "Serilog.AspNetCore". Voici un exemple de configuration de base :

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using Serilog;

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .UseSerilog((hostingContext, loggerConfiguration) => loggerConfiguration
                .ReadFrom.Configuration(hostingContext.Configuration)
                .WriteTo.Console()
            );
}

Dans cet exemple, Serilog lit la configuration de journalisation à partir du fichier appsettings.json et écrit les messages de journalisation sur la console. Vous pouvez configurer Serilog pour écrire dans d'autres sinks en utilisant les extensions appropriées.

Utilisation de Serilog dans votre code

Une fois que Serilog est configuré, vous pouvez l'utiliser pour enregistrer des messages de journalisation dans votre code :

using Serilog;

public class MyService
{
    private readonly ILogger _logger;

    public MyService(ILogger logger)
    {
        _logger = logger;
    }

    public void DoSomething()
    {
        _logger.Information("Début de l'opération DoSomething");

        try
        {
            // ... votre code
        }
        catch (Exception ex)
        {
            _logger.Error(ex, "Erreur lors de l'exécution de DoSomething");
        }
    }
}

Dans cet exemple, le service MyService utilise Serilog pour enregistrer un message d'information au début de l'opération DoSomething et un message d'erreur en cas d'exception.

Conclusion

Serilog est un excellent outil pour améliorer la journalisation de votre application .NET Core. Il offre un large éventail de fonctionnalités et de flexibilité, ce qui vous permet de contrôler la manière dont vos messages de journalisation sont enregistrés et de les envoyer à diverses destinations. En utilisant Serilog, vous pouvez améliorer le débogage, la surveillance et l'analyse de votre application.