Benutzerdefiniertes Logging in C# implementieren

Warum sollte ich Custom Logging mit IronPDF verwenden?

:path=/static-assets/pdf/content-code-examples/how-to/custom-logging-custom-logging.cs

IronSoftware.Logger.LoggingMode = IronSoftware.Logger.LoggingModes.Custom;
IronSoftware.Logger.CustomLogger = new CustomLoggerClass("logging");

IronSoftware.Logger.LoggingMode = IronSoftware.Logger.LoggingModes.Custom
IronSoftware.Logger.CustomLogger = New CustomLoggerClass("logging")

Die IronPDF-Protokolle werden an das benutzerdefinierte Logger-Objekt weitergeleitet. Die Meldungen bleiben identisch mit denen des IronPDF-Loggers; sie werden an den benutzerdefinierten Logger weitergeleitet. Die benutzerdefinierte Logger-Implementierung bestimmt, wie die Nachrichten zu behandeln sind. Betrachten Sie das folgende Beispiel einer benutzerdefinierten Logger-Klasse.

Die benutzerdefinierte Protokollierung bietet mehrere Vorteile für Produktionsanwendungen:

• Zentrales Log Management: Integrieren Sie IronPDF Logs in Ihre bestehende Logging-Infrastruktur
• Verbessertes Debugging: Erfassen detaillierter Informationen über PDF-Vorgänge zur Fehlersuche
• Performance Monitoring: Rendering-Zeiten und Ressourcennutzung verfolgen
• Fehlerverfolgung: Automatisches Erfassen und Melden von Fehlern bei der PDF-Generierung
• Einhaltung von Vorschriften: Aufrechterhaltung von Prüfpfaden für die Dokumentenerstellung in regulierten Branchen

Bei Anwendungen, die eine asynchrone Verarbeitung erfordern, hilft die benutzerdefinierte Protokollierung, gleichzeitige PDF-Vorgänge zu verfolgen und potenzielle Engpässe zu erkennen.

Wie sieht eine benutzerdefinierte Logger-Klasse aus?

:path=/static-assets/pdf/content-code-examples/how-to/custom-logging-custom-logging-class.cs

public class CustomLoggerClass : ILogger
{
    private readonly string categoryName;

    public CustomLoggerClass(string categoryName)
    {
        this.categoryName = categoryName;
    }

    public IDisposable BeginScope<TState>(TState state)
    {
        return null;
    }

    public bool IsEnabled(LogLevel logLevel)
    {
        return true;
    }

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
    {
        if (!IsEnabled(logLevel))
        {
            return;
        }

        // Implement your custom logging logic here.
        string logMessage = formatter(state, exception);

        // You can use 'logLevel', 'eventId', 'categoryName', and 'logMessage' to log the message as needed.
        // For example, you can write it to a file, console, or another destination.

        // Example: Writing to the console
        Console.WriteLine($"[{logLevel}] [{categoryName}] - {logMessage}");
    }
}

Public Class CustomLoggerClass
	Implements ILogger

	Private ReadOnly categoryName As String

	Public Sub New(ByVal categoryName As String)
		Me.categoryName = categoryName
	End Sub

	Public Function BeginScope(Of TState)(ByVal state As TState) As IDisposable
		Return Nothing
	End Function

	Public Function IsEnabled(ByVal logLevel As LogLevel) As Boolean
		Return True
	End Function

	Public Sub Log(Of TState)(ByVal logLevel As LogLevel, ByVal eventId As EventId, ByVal state As TState, ByVal exception As Exception, ByVal formatter As Func(Of TState, Exception, String))
		If Not IsEnabled(logLevel) Then
			Return
		End If

		' Implement your custom logging logic here.
		Dim logMessage As String = formatter(state, exception)

		' You can use 'logLevel', 'eventId', 'categoryName', and 'logMessage' to log the message as needed.
		' For example, you can write it to a file, console, or another destination.

		' Example: Writing to the console
		Console.WriteLine($"[{logLevel}] [{categoryName}] - {logMessage}")
	End Sub
End Class

Diese Implementierung folgt der Standard-Microsoft.Extensions.Logging.ILogger-Schnittstelle und ist somit mit dem .NET -Logging-Ökosystem kompatibel. Die Logger-Klasse umfasst:

• Kategoriename: Hilft bei der Identifizierung der Quelle von Protokollmeldungen
• Protokollstufen-Filterung: Steuerung der zu erfassenden Schweregrade
• Flexible Ausgabe: Leiten Sie Protokolle an ein beliebiges Ziel (Konsole, Datei, Datenbank usw.)
• Ausnahmebehandlung: Richtiges Formatieren und Protokollieren von Ausnahmedetails
• Zustandsverwaltung : Unterstützung für strukturierte Protokollierung mit BeginScope

Für fortgeschrittene Szenarien sollten Sie sich mit den Rendering-Optionen befassen, die sich auf die Protokollierung auswirken, insbesondere bei komplexen HTML-Konvertierungen oder bei der Arbeit mit der Chrome Rendering Engine.

Wie sieht die benutzerdefinierte Logging-Ausgabe aus?

In diesem Beispiel werden den Protokollmeldungen zusätzliche Informationen vorangestellt.

Die Konsolenausgabe zeigt, wie die benutzerdefinierte Protokollierung detaillierte Einblicke in die internen Abläufe von IronPDF bietet. Sie können es sehen:

• Initialisierungsschritte des Chrome-Clients
• Erstellung von Einführungskandidaten
• Sequenzen zum Laden nativer Bibliotheken
• Bestätigungen für die erfolgreiche Bereitstellung von Komponenten

Diese Detailgenauigkeit ist von unschätzbarem Wert, wenn es darum geht, Probleme bei der PDF-Erzeugung zu beheben oder die Leistung zu optimieren. Das strukturierte Format macht es einfach, Protokolle programmatisch zu analysieren oder in Protokollanalysetools zu integrieren.