Serilog .NET (Cómo funciona para desarrolladores)

Registro estructurado

Una de las características destacadas de Serilog es su soporte para registro estructurado. En lugar de simplemente registrar mensajes como texto plano, Serilog te permite registrar datos estructurados. Estos datos estructurados pueden ser un objeto JSON, un diccionario, o cualquier otro tipo que pueda ser serializado. Al registrar datos estructurados, puedes analizar y consultar fácilmente los eventos de registro usando herramientas como Elasticsearch o Splunk.

Configuración flexible

Serilog ofrece opciones de configuración flexibles que te permiten personalizar el comportamiento de registro según las necesidades de tu aplicación. Puedes configurar Serilog programáticamente o usando archivos de configuración. Esta flexibilidad permite ajustar el comportamiento del registro en tiempo de ejecución sin necesidad de reiniciar la aplicación.

Bibliotecas

Serilog proporciona varias bibliotecas de sumideros que te permiten enviar eventos de registro a diferentes destinos. Algunas de las bibliotecas de sumideros más populares incluyen:

• Serilog.Sinks.Console: Envía eventos de registro a la consola.
• Serilog.Sinks.File: Escribe eventos de registro en archivos de texto.
• Serilog.Sinks.Seq: Envía eventos de registro a Seq, un servidor de registro estructurado.
• Serilog.Sinks.Elasticsearch: Envía eventos de registro a Elasticsearch.

Estas bibliotecas de sumideros facilitan la integración de Serilog con diferentes infraestructuras y herramientas de registro.

Enriquecimiento del registro

El enriquecimiento del registro es una característica que te permite añadir información contextual adicional a tus eventos de registro. Serilog proporciona varios enriquecedores que pueden añadir automáticamente información como timestamps, ID de hilo o nivel de registro a tus eventos de registro. También puedes crear enriquecedores personalizados para añadir información específica de la aplicación.

Filtrado de registros

Serilog te permite filtrar eventos de registro basados en varios criterios. Puedes configurar filtros para excluir o incluir eventos de registro basados en el nivel de registro, valores de propiedades o cualquier otra condición. Esta capacidad de filtrado te permite centrarte en los eventos de registro que son más relevantes para tu análisis o solución de problemas.

Al entender y aprovechar estas características, puedes aprovechar el poder de Serilog para mejorar tus capacidades de registro y obtener valiosos conocimientos sobre el comportamiento de tu aplicación.

Registro estructurado: Una característica esencial

La principal fortaleza de Serilog reside en convertir los mensajes de registro en datos estructurados. A diferencia de otras bibliotecas de registro que generan texto plano, Serilog genera registros en un formato JSON estructurado, simplificando el análisis y consulta de los datos de registro. Esta capacidad es crucial para las aplicaciones modernas donde el análisis y la monitorización de registros son fundamentales para la inteligencia operativa. Los registros estructurados son particularmente beneficiosos cuando un mensaje de registro se ingiere en sistemas como la pila ELK (Elasticsearch, Logstash, Kibana) para un análisis avanzado.

Detalles de eventos de registro

Serilog enriquece los eventos de registro con información contextual, proporcionando una vista completa de lo que está sucediendo dentro de una aplicación. Cada evento de registro puede contener muchos detalles más allá de un simple mensaje de registro, incluidos timestamps, niveles de registro, detalles de excepciones y propiedades personalizadas. Esto hace que Serilog sea superior a otras bibliotecas de registro en términos de profundidad y claridad del registro, ofreciendo a los desarrolladores conocimientos críticos sobre el comportamiento y rendimiento de la aplicación.

Fichero de configuración

Usa el archivo JSON de configuración para definir niveles de registro, destinos de salida (como archivos de registro o consola) y el formato de salida del registro. El enfoque del archivo de configuración ofrece la flexibilidad de cambiar el comportamiento del registro sin modificar el código. Esto se hace especificando configuraciones en el archivo appsettings.json, que te permite dirigir tu salida de registro a varios sumideros como una consola, un archivo, o incluso servicios de gestión de registros en la nube.

Programáticamente en código

Alternativamente, configura Serilog directamente en el código usando la clase LoggerConfiguration. Este método se utiliza a menudo para configurar escenarios de registro más complejos, como niveles de registro dinámicos o sumideros de registro personalizados. Por ejemplo, puedes configurar un archivo de registro rotativo que crea un nuevo archivo de registro a intervalos específicos o al alcanzar cierto tamaño, asegurando una gestión eficiente de los archivos de registro.

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

Integración con ASP.NET Core

Integrar Serilog con ASP.NET Core implica añadir el paquete Serilog a través de la consola del administrador de paquetes y configurar el logger en el archivo Program.cs. Las declaraciones var builder y var app en .NET 6 integran sin problemas Serilog en la infraestructura de registro de la aplicación. Este proceso reemplaza al logger predeterminado con Serilog, asegurando que todos los mensajes de registro sean procesados a través del pipeline de 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()

HierroPDF

IronPDF permite la creación, lectura y edición de PDFs dentro de aplicaciones .NET. Esto puede ser particularmente útil cuando se combina con Serilog para generar informes PDF de datos de registro, permitiendo una fácil distribución y visualización de información de registro en un formato estándar.

IronOCR

IronOCR es una biblioteca de Reconocimiento Óptico de Caracteres (OCR) que puede traducir imágenes a texto en 125 idiomas. Esta característica puede ser utilizada en escenarios de registro donde se debe extraer datos de texto de imágenes o documentos escaneados, enriqueciendo así los datos de registro con más información contextual.

IronXL

IronXL proporciona funcionalidad para trabajar con Excel sin la necesidad de Office Interop. Esto puede ser particularmente beneficioso para propósitos de registro, ya que los datos de registro pueden ser exportados a Excel para un posterior análisis e informes, ofreciendo una interfaz familiar para la manipulación y visualización de datos.

Código de barras de hierro

IronBarcode facilita la lectura y escritura de códigos QR y de barras. Esta biblioteca puede incrustar o extraer información codificada dentro de archivos de registro, mejorando la seguridad y trazabilidad de la información registrada.