Serilog .NET (Son fonctionnement pour les développeurs)

Journalisation structurée

L'une des fonctionnalités remarquables de Serilog est sa prise en charge de la journalisation structurée. Au lieu de simplement consigner des messages en texte brut, Serilog vous permet d'enregistrer des données structurées. Ces données structurées peuvent être un objet JSON, un dictionnaire, ou tout autre type pouvant être sérialisé. En enregistrant des données structurées, vous pouvez facilement analyser et interroger les événements de journal à l'aide d'outils tels que Elasticsearch ou Splunk.

Configuration flexible

Serilog offre des options de configuration flexibles qui vous permettent de personnaliser le comportement de journalisation selon les besoins de votre application. Vous pouvez configurer Serilog de manière programmatique ou à l'aide de fichiers de configuration. Cette flexibilité vous permet d'ajuster le comportement de journalisation à l'exécution sans nécessiter de redémarrages de l'application.

Bibliothèques de Sink

Serilog fournit diverses bibliothèques de sink qui vous permettent d'envoyer des événements de journal à différentes destinations. Certaines des bibliothèques de sink populaires incluent :

• Serilog.Sinks.Console : Envoie les événements de journal à la console.
• Serilog.Sinks.File : Écrit les événements de journal dans des fichiers texte.
• Serilog.Sinks.Seq : Envoie les événements de journal à Seq, un serveur de journal structuré.
• Serilog.Sinks.Elasticsearch : Envoie les événements de journal à Elasticsearch.

Ces bibliothèques de sink facilitent l'intégration de Serilog avec différentes infrastructures et outils de journalisation.

Enrichissement de la journalisation

L'enrichissement de la journalisation est une fonctionnalité qui vous permet d'ajouter des informations contextuelles supplémentaires à vos événements de journal. Serilog fournit divers enrichisseurs qui peuvent automatiquement ajouter des informations telles que le horodatage, l'ID de thread, ou le niveau de journal à vos événements de journal. Vous pouvez également créer des enrichisseurs personnalisés pour ajouter des informations spécifiques à l'application.

Filtrage des logs

Serilog vous permet de filtrer les événements de journal en fonction de divers critères. Vous pouvez configurer des filtres pour exclure ou inclure des événements de journal en fonction du niveau de journal, des valeurs de propriétés, ou de toute autre condition. Cette capacité de filtrage vous permet de vous concentrer sur les événements de journal les plus pertinents pour votre analyse ou dépannage.

En comprenant et en exploitant ces fonctionnalités, vous pouvez exploiter la puissance de Serilog pour améliorer vos capacités de journalisation et obtenir des informations précieuses sur le comportement de votre application.

Journalisation structurée: A Core Feature

La principale force de Serilog réside dans la transformation des messages de journal en données structurées. Contrairement à d'autres bibliothèques de journalisation qui produisent du texte brut, Serilog génère des logs dans un format JSON structuré, simplifiant l'analyse et la requête des données de journal. Cette capacité est cruciale pour les applications modernes où l'analyse et la surveillance des logs sont essentielles à l'intelligence opérationnelle. Les logs structurés sont particulièrement bénéfiques lorsqu'un message de journal est ingéré dans des systèmes tels que la stack ELK (Elasticsearch, Logstash, Kibana) pour une analyse avancée.

Détails riches des événements de journal

Serilog enrichit les événements de journal avec des informations contextuelles, offrant une vue complète de ce qui se passe à l'intérieur d'une application. Chaque événement de journal peut contenir de nombreux détails au-delà d'un simple message de journal, y compris des horodatages, des niveaux de journal, des détails d'exception, et des propriétés personnalisées. Cela rend Serilog supérieur à d'autres bibliothèques de journalisation en termes de profondeur et de clarté des logs, offrant aux développeurs des informations critiques sur le comportement et la performance de l'application.

Via le fichier de configuration

Utilisez le fichier JSON de configuration pour définir les niveaux de journal, les destinations de sortie (comme les fichiers journal ou la console), et le format de sortie du log. L'approche du fichier de configuration offre la flexibilité de modifier le comportement de journalisation sans modifier le code. Cela se fait en spécifiant les paramètres dans le fichier appsettings.json, ce qui vous permet de diriger votre sortie de journal vers divers sinks tels qu'une console, un fichier, ou même des services de gestion des logs basés sur le cloud.

Programmatiquement dans le code

Alternativement, configurez Serilog directement dans le code en utilisant la classe LoggerConfiguration. Cette méthode est souvent utilisée pour paramétrer des scénarios de journalisation plus complexes, tels que des niveaux de journal dynamiques ou des sinks de journal personnalisés. Par exemple, vous pouvez configurer un fichier log tournant qui crée un nouveau fichier log à des intervalles spécifiques ou après avoir atteint une certaine taille, assurant une gestion efficace des fichiers logs.

// Create a logger instance with a rolling log file that creates a new log file every day
var logger = new LoggerConfiguration()
    .WriteTo.File("logs/myapp.txt", rollingInterval: RollingInterval.Day) 
    .CreateLogger();

// Create a logger instance with a rolling log file that creates a new log file every day
var logger = new LoggerConfiguration()
    .WriteTo.File("logs/myapp.txt", rollingInterval: RollingInterval.Day) 
    .CreateLogger();

' Create a logger instance with a rolling log file that creates a new log file every day
Dim logger = (New LoggerConfiguration()).WriteTo.File("logs/myapp.txt", rollingInterval:= RollingInterval.Day).CreateLogger()

Intégration avec ASP.NET Core

Intégrer Serilog avec ASP.NET Core implique d'ajouter le package Serilog via la Console du Gestionnaire de Packages et de configurer le logger dans le fichier Program.cs. Les instructions var builder et var app dans .NET 6 intègrent parfaitement Serilog à l'infrastructure de journalisation de l'application. Ce processus remplace le logger par défaut par Serilog, garantissant que tous les messages de journal sont traités via le pipeline Serilog.

var builder = WebApplication.CreateBuilder(args);

// Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog((ctx, lc) => lc
    .WriteTo.Console()
    .ReadFrom.Configuration(ctx.Configuration));

var app = builder.Build();

var builder = WebApplication.CreateBuilder(args);

// Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog((ctx, lc) => lc
    .WriteTo.Console()
    .ReadFrom.Configuration(ctx.Configuration));

var app = builder.Build();

Dim builder = WebApplication.CreateBuilder(args)

' Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog(Function(ctx, lc) lc.WriteTo.Console().ReadFrom.Configuration(ctx.Configuration))

Dim app = builder.Build()

IronPDF

IronPDF permet la création, la lecture, et l'édition de PDFs dans des applications .NET. Ceci peut être particulièrement utile lorsqu'il est combiné avec Serilog pour générer des rapports PDF des données de journal, permettant une distribution et une visualisation faciles des informations de journal dans un format standardisé.

IronOCR

IronOCR est une bibliothèque de reconnaissance optique de caractères (OCR) qui peut traduire des images en texte dans 125 langues. Cette fonctionnalité peut être utilisée dans des scénarios de journalisation où des données textuelles doivent être extraites d'images ou de documents scannés, enrichissant ainsi les données de journal avec plus d'informations contextuelles.

IronXL

IronXL fournit des fonctionnalités pour travailler avec Excel sans avoir besoin d'Interop Office. Ceci peut être particulièrement bénéfique pour les besoins de journalisation, car les données de journal peuvent être exportées vers Excel pour une analyse et un reporting supplémentaires, offrant une interface familière pour la manipulation et la visualisation des données.

IronBarcode

IronBarcode facilite la lecture et l'écriture de codes QR et de codes-barres. Cette bibliothèque peut intégrer ou extraire des informations encodées dans des fichiers journal, améliorant la sécurité et la traçabilité des informations enregistrées.