Serilog .NET (Wie es für Entwickler funktioniert)

Strukturierte Protokollierung

Eine der herausragenden Funktionen von Serilog ist die Unterstützung der strukturierten Protokollierung. Anstatt einfach nur Nachrichten als einfachen Text zu protokollieren, ermöglicht Serilog das Protokollieren strukturierter Daten. Diese strukturierten Daten können ein JSON-Objekt, ein Wörterbuch oder ein anderer serialisierbarer Typ sein. Durch das Protokollieren strukturierter Daten können Sie Protokollierungsereignisse problemlos mit Tools wie Elasticsearch oder Splunk analysieren und abfragen.

Flexible Konfiguration

Serilog bietet flexible Konfigurationsoptionen, mit denen Sie das Protokollierungsverhalten entsprechend den Anforderungen Ihrer Anwendung anpassen können. Sie können Serilog programmgesteuert oder über Konfigurationsdateien konfigurieren. Diese Flexibilität ermöglicht es Ihnen, das Protokollierungsverhalten zur Laufzeit anzupassen, ohne dass Anwendungs-Neustarts erforderlich sind.

Sink-Bibliotheken

Serilog bietet verschiedene Sink-Bibliotheken, die es Ihnen ermöglichen, Protokollierungsereignisse an unterschiedliche Ziele zu senden. Einige der beliebten Sink-Bibliotheken sind:

• Serilog.Sinks.Console: Sendet Protokollierungsereignisse an die Konsole.
• Serilog.Sinks.File: Schreibt Protokollierungsereignisse in Textdateien.
• Serilog.Sinks.Seq: Sendet Protokollierungsereignisse an Seq, einen strukturierten Protokollserver.
• Serilog.Sinks.Elasticsearch: Sendet Protokollierungsereignisse an Elasticsearch.

Diese Sink-Bibliotheken erleichtern es, Serilog mit verschiedenen Protokollierungsinfrastrukturen und -tools zu integrieren.

Anreicherung der Protokollierung

Protokollanreicherung ist eine Funktion, die es ermöglicht, Ihren Protokollierungsereignissen zusätzliche kontextuelle Informationen hinzuzufügen. Serilog bietet verschiedene Enricher, die automatisch Informationen wie Zeitstempel, Thread-ID oder Protokollebene hinzufügen können. Sie können auch benutzerdefinierte Enricher erstellen, um anwendungsspezifische Informationen hinzuzufügen.

Log-Filterung

Serilog ermöglicht es Ihnen, Protokollierungsereignisse anhand verschiedener Kriterien zu filtern. Sie können Filter konfigurieren, um Protokollierungsereignisse basierend auf Protokollebene, Eigenschaftswerten oder anderen Bedingungen auszuschließen oder einzubeziehen. Diese Filterfunktion ermöglicht es Ihnen, sich auf die Protokollierungsereignisse zu konzentrieren, die für Ihre Analyse oder Fehlersuche am relevantesten sind.

Indem Sie diese Funktionen verstehen und nutzen, können Sie die Leistungsfähigkeit von Serilog auch nutzen, um Ihre Protokollierungsfähigkeiten zu verbessern und wertvolle Einblicke in das Verhalten Ihrer Anwendung zu gewinnen.

Strukturierte Protokollierung: Eine Kernfunktion

Die primäre Stärke von Serilog liegt in der Umwandlung von Protokollnachrichten in strukturierte Daten. Im Gegensatz zu anderen Protokollierungsbibliotheken, die einfachen Text ausgeben, erzeugt Serilog Protokolle im strukturierten JSON-Format, was das Parsen und Abfragen von Protokolldaten vereinfacht. Diese Fähigkeit ist entscheidend für moderne Anwendungen, bei denen Protokollanalyse und -überwachung integraler Bestandteil der operativen Intelligenz sind. Strukturierte Protokolle sind besonders vorteilhaft, wenn eine Protokollmeldung in Systeme wie den ELK (Elasticsearch, Logstash, Kibana)-Stack für erweiterte Analysen aufgenommen wird.

Reichhaltige Protokoll-Ereignis-Details

Serilog bereichert Protokollereignisse mit kontextuellen Informationen und bietet einen umfassenden Überblick darüber, was in einer Anwendung geschieht. Jedes Protokollereignis kann viele Details über eine einfache Protokollnachricht hinaus enthalten, einschließlich Zeitstempel, Protokollebenen, Ausnahmeinformationen und benutzerdefinierter Eigenschaften. Dadurch ist Serilog anderen Protokollierungsbibliotheken in Bezug auf die Tiefe und Klarheit des Protokolls überlegen und bietet Entwicklern wichtige Einblicke in das Verhalten und die Leistung der Anwendung.

Über die Konfigurationsdatei

Verwenden Sie die JSON-Konfigurationsdatei, um Protokollebenen, Ausgabestellen (wie Protokolldateien oder Konsole) und das Protokollausgabeformat zu definieren. Der Konfigurationsdateiansatz bietet die Flexibilität, das Protokollierungsverhalten zu ändern, ohne den Code zu modifizieren. Dies geschieht durch die Angabe von Einstellungen in der appsettings.json-Datei, die es Ihnen ermöglicht, Ihre Protokollausgabe an verschiedene Sinks zu leiten, wie z.B. eine Konsole, eine Datei oder sogar cloudbasierte Protokollverwaltungsdienste.

Programmatisch im Code

Alternativ konfigurieren Sie Serilog direkt im Code mit der LoggerConfiguration-Klasse. Diese Methode wird häufig verwendet, um komplexere Protokollierunsszenarien einzurichten, wie z.B. dynamische Protokollebenen oder benutzerdefinierte Protokollsinks. Zum Beispiel können Sie eine rollierende Protokolldatei konfigurieren, die zu bestimmten Intervallen oder beim Erreichen einer bestimmten Größe eine neue Protokolldatei erstellt, um eine effiziente Verwaltung von Protokolldateien sicherzustellen.

// 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()

Integration mit ASP.NET Core

Die Integration von Serilog mit ASP.NET Core beinhaltet das Hinzufügen des Serilog-Pakets über die Paket-Manager-Konsole und das Einrichten des Loggers in der Program.cs-Datei. Die var builder- und var app-Anweisungen in .NET 6 binden Serilog nahtlos in die Protokollierungsinfrastruktur der Anwendung ein. Dieser Prozess ersetzt den Standardlogger durch Serilog und stellt sicher, dass alle Protokollnachrichten durch die Serilog-Pipeline verarbeitet werden.

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 ermöglicht das Erstellen, Lesen und Bearbeiten von PDFs innerhalb von .NET-Anwendungen. Dies kann besonders nützlich sein, wenn es mit Serilog kombiniert wird, um PDF-Berichte über Protokolldaten zu erstellen, die eine einfache Verteilung und Ansicht von Protokollinformationen in einem standardisierten Format ermöglichen.

IronOCR

IronOCR ist eine Software zur optischen Zeichenerkennung (OCR), die Bilder in Text in 125 Sprachen übersetzen kann. Diese Funktion kann in Protokollierungsszenarien genutzt werden, in denen Textdaten aus Bildern oder gescannten Dokumenten extrahiert werden müssen, um die Protokolldaten mit mehr kontextuellen Informationen anzureichern.

IronXL

IronXL bietet Funktionalitäten zur Arbeit mit Excel, ohne dass Office Interop erforderlich ist. Dies kann besonders für Protokollierungszwecke von Vorteil sein, da Protokolldaten für weitere Analysen und Berichte in Excel exportiert werden können, was eine vertraute Oberfläche für die Datenmanipulation und -visualisierung bietet.

IronBarcode

IronBarcode erleichtert das Lesen und Schreiben von QR-Codes und Barcodes. Diese Bibliothek kann kodierte Informationen in Protokolldateien einbetten oder extrahieren, was die Sicherheit und Rückverfolgbarkeit der protokollierten Informationen verbessert.