How to use Custom Logging in C

Dlaczego należy używać niestandardowego logowania z IronPDF?

: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")

Dzienniki IronPDF będą kierowane do obiektu niestandardowego loggera. Komunikaty pozostają identyczne do tych w loggerze IronPDF; są przekazywane do niestandardowego loggera. Implementacja niestandardowego loggera określa, jak obsługiwać komunikaty. Rozważ poniższy przykład klasy niestandardowego loggera.

Niestandardowe logowanie oferuje wiele zalet dla aplikacji produkcyjnych:

• Centralne zarządzanie dziennikami: Zintegruj dzienniki IronPDF z istniejącą infrastrukturą logowania
• Ulepszone debugowanie: Rejestruj szczegółowe informacje o operacjach na plikach PDF w celu rozwiązywania problemów
• Monitorowanie wydajności: śledzenie czasu renderowania i wykorzystania zasobów
• Śledzenie błędów: automatyczne wykrywanie i zgłaszanie błędów podczas generowania plików PDF
• Zgodność z przepisami: Prowadzenie ścieżek audytu dla generowania dokumentów w branżach podlegających regulacjom

W przypadku aplikacji wymagających przetwarzania asynchronicznego niestandardowe logowanie pomaga śledzić równoczesne operacje na plikach PDF i identyfikować potencjalne wąskie gardła.

Jak wygląda niestandardowa klasa loggera?

: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

Implementacja ta podąża za standardowym interfejsem Microsoft.Extensions.Logging.ILogger, co czyni ją kompatybilną z ekosystemem logowania .NET. Klasa logger zawiera:

• Nazwa kategorii: Pomaga zidentyfikować źródło komunikatów dziennika
• Filtrowanie poziomu logów: Kontroluj, które poziomy ważności mają być rejestrowane
• Elastyczne wyjście: kieruj logi do dowolnego miejsca docelowego (konsola, plik, baza danych itp.)
• Obsługa wyjątków: Prawidłowe formatowanie i rejestrowanie szczegółów wyjątków
• Zarządzanie stanem: Wsparcie dla strukturalnego logowania z BeginScope

W przypadku zaawansowanych scenariuszy warto zapoznać się z opcjami renderowania, które mają wpływ na wynik logowania, zwłaszcza podczas złożonych konwersji HTML lub pracy z silnikiem renderującym Chrome.

Jak wygląda niestandardowy wynik logowania?

W tym przykładzie komunikaty dziennika są poprzedzone dodatkowymi informacjami.

Wynik wyświetlony w konsoli pokazuje, w jaki sposób niestandardowe logowanie zapewnia szczegółowy wgląd w wewnętrzne operacje IronPDF. Możesz zobaczyć:

• Kroki inicjalizacji klienta Chrome
• Tworzenie kandydatów do wdrożenia
• Sekwencje ładowania bibliotek natywnych
• Potwierdzenia pomyślnego wdrożenia komponentów

Ten poziom szczegółowości jest nieoceniony podczas debugowania problemów związanych z generowaniem plików PDF lub optymalizacji wydajności. Strukturalny format ułatwia programowe analizowanie logów lub integrację z narzędziami do analizy logów.