Serilog .NET (Como funciona para desenvolvedores)

Registro estruturado

Uma das características mais marcantes do Serilog é o seu suporte para registro estruturado de logs. Em vez de simplesmente registrar mensagens como texto simples, o Serilog permite registrar dados estruturados. Esses dados estruturados podem ser um objeto JSON, um dicionário ou qualquer outro tipo que possa ser serializado. Ao registrar dados estruturados, você pode facilmente analisar e consultar eventos de log usando ferramentas como Elasticsearch ou Splunk.

Configuração flexível

O Serilog oferece opções de configuração flexíveis que permitem personalizar o comportamento de registro de acordo com as necessidades da sua aplicação. Você pode configurar o Serilog programaticamente ou usando arquivos de configuração. Essa flexibilidade permite ajustar o comportamento de registro em tempo de execução sem a necessidade de reiniciar o aplicativo.

Bibliotecas de coletores (Sinks)

O Serilog oferece diversas bibliotecas de coletores que permitem enviar eventos de log para diferentes destinos. Algumas das bibliotecas de coletores mais populares incluem:

• Serilog.Sinks.Console: Envia eventos de log para o console.
• Serilog.Sinks.File: Grava eventos de log em arquivos de texto.
• Serilog.Sinks.Seq: Envia eventos de log para o Seq, um servidor de logs estruturados.
• Serilog.Sinks.Elasticsearch: Envia eventos de log para o Elasticsearch.

Essas bibliotecas de coleta de dados facilitam a integração do Serilog com diferentes infraestruturas e ferramentas de registro de logs.

Enriquecimento de Registros

O enriquecimento de logs é um recurso que permite adicionar informações contextuais adicionais aos seus eventos de log. O Serilog oferece diversos enriquecedores que podem adicionar automaticamente informações como carimbo de data/hora, ID da thread ou nível de log aos seus eventos de log. Você também pode criar enriquecedores personalizados para adicionar informações específicas do aplicativo.

Filtragem de logs

O Serilog permite filtrar eventos de log com base em vários critérios. Você pode configurar filtros para excluir ou incluir eventos de log com base no nível de log, valores de propriedade ou qualquer outra condição. Essa funcionalidade de filtragem permite que você se concentre nos eventos de registro que são mais relevantes para sua análise ou solução de problemas.

Ao compreender e aproveitar esses recursos, você pode utilizar o poder do Serilog para aprimorar suas capacidades de registro de logs e obter informações valiosas sobre o comportamento do seu aplicativo.

Registro estruturado: um recurso essencial

A principal vantagem do Serilog reside na transformação de mensagens de log em dados estruturados. Diferentemente de outras bibliotecas de registro que geram texto simples, o Serilog gera registros em um formato JSON estruturado, simplificando a análise e a consulta dos dados de registro. Essa capacidade é crucial para aplicações modernas onde a análise e o monitoramento de logs são parte integrante da inteligência operacional. Os logs estruturados são particularmente benéficos quando uma mensagem de log é inserida em sistemas como o ELK (Elasticsearch, Logstash, Kibana) para análises avançadas.

Detalhes do evento de registro

O Serilog enriquece os eventos de log com informações contextuais, fornecendo uma visão abrangente do que está acontecendo dentro de um aplicativo. Cada evento de registro pode conter muitos detalhes além de uma simples mensagem de registro, incluindo carimbos de data/hora, níveis de registro, detalhes da exceção e propriedades personalizadas. Isso torna o Serilog superior a outras bibliotecas de registro em termos de profundidade e clareza do log, oferecendo aos desenvolvedores informações cruciais sobre o comportamento e o desempenho do aplicativo.

Por meio de arquivo de configuração

Utilize o arquivo JSON de configuração para definir os níveis de registro, os destinos de saída (como arquivos de log ou console) e o formato de saída do log. A abordagem de arquivo de configuração oferece a flexibilidade de alterar o comportamento de registro de logs sem modificar o código. Isso é feito especificando configurações no arquivo appsettings.json, que permite direcionar a saída de log para vários destinos, como um console, um arquivo ou até mesmo serviços de gerenciamento de logs baseados em nuvem.

Programaticamente em código

Alternativamente, configure o Serilog diretamente no código usando a classe LoggerConfiguration. Esse método é frequentemente usado para configurar cenários de registro mais complexos, como níveis de registro dinâmicos ou destinos de registro personalizados. Por exemplo, você pode configurar um arquivo de log rotativo que cria um novo arquivo de log em intervalos específicos ou ao atingir um determinado tamanho, garantindo um gerenciamento eficiente dos arquivos de log.

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

Integração com ASP.NET Core

A integração do Serilog com o ASP.NET Core envolve a adição do pacote Serilog através do Console do Gerenciador de Pacotes e a configuração do logger no arquivo Program.cs. As instruções var builder e var app no .NET 6 integram o Serilog perfeitamente à infraestrutura de logs da aplicação. Este processo substitui o logger padrão pelo Serilog, garantindo que todas as mensagens de log sejam processadas pelo pipeline do 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()

IronPDF

O IronPDF permite a criação, leitura e edição de PDFs em aplicações .NET . Isso pode ser particularmente útil quando combinado com o Serilog para gerar relatórios em PDF de dados de registro, permitindo fácil distribuição e visualização das informações de registro em um formato padronizado.

IronOCR

IronOCR é uma biblioteca de Reconhecimento Óptico de Caracteres (OCR) que pode traduzir imagens em texto em 125 idiomas. Essa funcionalidade pode ser utilizada em cenários de registro de logs onde dados textuais precisam ser extraídos de imagens ou documentos digitalizados, enriquecendo assim os dados de log com mais informações contextuais.

IronXL

O IronXL oferece funcionalidades para trabalhar com o Excel sem a necessidade de interoperabilidade com o Office. Isso pode ser particularmente benéfico para fins de registro de logs, já que os dados de log podem ser exportados para o Excel para análises e relatórios adicionais, oferecendo uma interface familiar para manipulação e visualização de dados.

IronBarcode

O IronBarcode facilita a leitura e a gravação de códigos QR e códigos de barras. Esta biblioteca pode incorporar ou extrair informações codificadas em arquivos de log, aumentando a segurança e a rastreabilidade das informações registradas.