.net 6 Web Api Logging To File

INFLUENCESMAG.ORG

4 min read

·

Jun 03, 2024

30

Share

Enregistrement des journaux de votre API Web .NET 6 dans un fichier

Introduction

Lors du développement d'une API Web .NET 6, il est crucial de mettre en place un système de journalisation efficace pour déboguer les erreurs, analyser le comportement de l'application et surveiller les performances. Enregistrement des logs dans un fichier est une méthode courante pour archiver ces informations de manière persistante. Cet article explique comment configurer l'enregistrement des logs dans un fichier pour votre API Web .NET 6.

Configuration de l'enregistrement des logs

1. Installation du package NuGet: Commencez par installer le package Microsoft.Extensions.Logging.File via la console de gestion de package NuGet :

Install-Package Microsoft.Extensions.Logging.File

2. Configuration du fichier de journalisation: Créez un fichier nommé appsettings.json dans le répertoire racine de votre projet. Ajoutez la section suivante pour configurer le fournisseur de journalisation de fichier :

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    },
    "File": {
      "Path": "logs/app.log",
      "RollingInterval": "Day",
      "FileSizeLimit": 10485760 // 10 MB
    }
  }
}

Explication des options de configuration:

• LogLevel: Définir le niveau de gravité du journal pour différents fournisseurs de journalisation.
• File: Configurer le fournisseur de journalisation de fichier avec les options suivantes :
  • Path: Chemin du fichier de journalisation.
  • RollingInterval: Fréquence de rotation du fichier de journalisation (jour, heure, taille).
  • FileSizeLimit: Taille maximale du fichier avant la rotation.

3. Utilisation du service de journalisation: Dans votre code, injectez le service ILogger pour enregistrer des messages de journalisation :

using Microsoft.Extensions.Logging;

public class MyController : ControllerBase
{
  private readonly ILogger _logger;

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

  [HttpGet]
  public IActionResult Get()
  {
    _logger.LogInformation("Requête GET reçue.");
    return Ok();
  }
}

Informations supplémentaires:

• Vous pouvez personnaliser le format des logs en utilisant des modèles de formatage de journalisation.
• Le package Microsoft.Extensions.Logging.File est un fournisseur de journalisation simple, mais il existe d'autres fournisseurs plus complets disponibles, tels que Serilog.
• Il est important de suivre les bonnes pratiques de journalisation, telles que l'utilisation des niveaux de gravité appropriés et l'évitement de l'enregistrement d'informations sensibles.

Conclusion

L'enregistrement des logs dans un fichier est une pratique courante pour déboguer et surveiller votre API Web .NET 6. En utilisant le package Microsoft.Extensions.Logging.File et en configurant correctement les options de journalisation, vous pouvez facilement collecter des informations précieuses sur le fonctionnement de votre application. N'oubliez pas de choisir un emplacement approprié pour les fichiers de journalisation et de gérer la taille des fichiers pour éviter d'occuper trop d'espace disque.