Cómo utilizar el registro personalizado en C#

¿Por qué debería utilizar el registro personalizado con 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")

Los registros de IronPDF se dirigirán al objeto logger personalizado. Los mensajes deben ser idénticos a los del registrador IronPDF; se transmiten al registrador personalizado. La implementación del registrador personalizado determina cómo gestionar los mensajes. Considere el siguiente ejemplo de clase de registrador personalizado.

El registro personalizado ofrece varias ventajas para las aplicaciones de producción:

• Gestión centralizada de registros: Integre los registros de IronPDF con su infraestructura de registro existente
• Depuración mejorada: Captura información detallada sobre las operaciones de PDF para la solución de problemas
• Monitorización del rendimiento: seguimiento de los tiempos de renderización y del uso de recursos
• Rastreo de errores: Captura e informa automáticamente de los fallos en la generación de PDF
• Cumplimiento: Mantener registros de auditoría para la generación de documentos en sectores regulados

Para las aplicaciones que requieren procesamiento asíncrono, el registro personalizado ayuda a realizar un seguimiento de las operaciones de PDF concurrentes y a identificar posibles cuellos de botella.

¿Qué aspecto tiene una clase de registro personalizada?

: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

Esta implementación sigue la interfaz estándar Microsoft.Extensions.Logging.ILogger, por lo que es compatible con el ecosistema de registro de .NET. La clase de registrador incluye:

• Nombre de la categoría: ayuda a identificar el origen de los mensajes de registro
• Filtrado de niveles de registro: Controla qué niveles de gravedad capturar
• Salida flexible: Dirija los registros a cualquier destino (consola, archivo, base de datos, etc.)
• Manejo de excepciones: Formatear y registrar correctamente los detalles de las excepciones
• Gestión de estados: compatibilidad con el registro estructurado con BeginScope

Para escenarios avanzados, explore opciones de renderizado que afectan a la salida de registro, especialmente cuando se trata de conversiones HTML complejas o cuando se trabaja con el motor de renderizado Chrome.

¿Qué aspecto tiene la salida de registro personalizada?

En este ejemplo, los mensajes de registro van precedidos de información adicional.

La salida de la consola demuestra cómo el registro personalizado proporciona información detallada sobre las operaciones internas de IronPDF. Se puede ver:

• Pasos de inicialización del cliente Chrome
• Creación de candidatos a la implantación
• Secuencias de carga de bibliotecas nativas
• Confirmaciones de despliegue de componentes con éxito

Este nivel de detalle es inestimable a la hora de depurar problemas de generación de PDF u optimizar el rendimiento. El formato estructurado facilita el análisis sintáctico de los registros mediante programación o su integración con herramientas de análisis de registros.