Serilog .NET (jak to działa dla programistów)

Rejestrowanie ustrukturyzowane

Jedną z wyróżniających się funkcji Serilog jest obsługa logowania strukturalnego. Zamiast po prostu rejestrować komunikaty jako zwykły tekst, Serilog pozwala na rejestrowanie danych ustrukturyzowanych. Te dane strukturalne mogą mieć postać obiektu JSON, słownika lub dowolnego innego typu, który można zserializować. Rejestrując dane ustrukturyzowane, można łatwo analizować i wyszukiwać zdarzenia logowania za pomocą narzędzi takich jak Elasticsearch lub Splunk.

Elastyczna konfiguracja

Serilog oferuje elastyczne opcje konfiguracji, które pozwalają dostosować zachowanie rejestrowania do potrzeb aplikacji. Serilog można skonfigurować programowo lub za pomocą plików konfiguracyjnych. Ta elastyczność pozwala dostosować zachowanie rejestrowania w czasie wykonywania bez konieczności ponownego uruchamiania aplikacji.

Biblioteki Sink

Serilog udostępnia różne biblioteki sink, które umożliwiają wysyłanie zdarzeń logowania do różnych miejsc docelowych. Niektóre z popularnych bibliotek typu sink to:

• Serilog.Sinks.Console: Wysyła zdarzenia dziennika do konsoli.
• Serilog.Sinks.File: Zapisuje zdarzenia dziennika do plików tekstowych.
• Serilog.Sinks.Seq: Wysyła zdarzenia logowania do Seq, serwera logów strukturalnych.
• Serilog.Sinks.Elasticsearch: Wysyła zdarzenia logowania do Elasticsearch.

Te biblioteki sink ułatwiają integrację Serilog z różnymi infrastrukturami i narzędziami do logowania.

Wzbogacanie logów

Wzbogacanie logów to funkcja, która pozwala dodawać dodatkowe informacje kontekstowe do zdarzeń logowania. Serilog udostępnia różne moduły rozszerzające, które mogą automatycznie dodawać do zdarzeń logowania informacje, takie jak sygnatura czasowa, identyfikator wątku lub poziom logowania. Można również tworzyć niestandardowe moduły wzbogacające, aby dodawać informacje specyficzne dla danej aplikacji.

Filtrowanie logów

Serilog umożliwia filtrowanie zdarzeń dziennika na podstawie różnych kryteriów. Można skonfigurować filtry, aby wykluczyć lub uwzględnić zdarzenia dziennika na podstawie poziomu dziennika, wartości właściwości lub dowolnego innego warunku. Ta funkcja filtrowania pozwala skupić się na zdarzeniach dziennika, które są najbardziej istotne dla analizy lub rozwiązywania problemów.

Dzięki zrozumieniu i wykorzystaniu tych funkcji możesz wykorzystać potencjał Serilog do ulepszenia możliwości rejestrowania zdarzeń i uzyskania cennych informacji na temat zachowania aplikacji.

Rejestrowanie ustrukturyzowane: podstawowa funkcja

Główną zaletą Serilog jest przekształcanie komunikatów dziennika w dane ustrukturyzowane. W przeciwieństwie do innych bibliotek logowania, które generują zwykły tekst, Serilog tworzy logi w ustrukturyzowanym formacie JSON, co ułatwia analizowanie i wyszukiwanie danych logów. Ta funkcja ma kluczowe znaczenie dla nowoczesnych aplikacji, w których analiza logów i monitorowanie stanowią integralną część analizy operacyjnej. Strukturalne logi są szczególnie przydatne, gdy komunikat logowania jest wprowadzany do systemów takich jak stos ELK (Elasticsearch, Logstash, Kibana) w celu przeprowadzenia zaawansowanej analizy.

Szczegółowe informacje o zdarzeniach w dzienniku

Serilog wzbogaca zdarzenia logowania o informacje kontekstowe, zapewniając kompleksowy obraz tego, co dzieje się wewnątrz aplikacji. Każde zdarzenie dziennika może zawierać wiele szczegółów wykraczających poza prosty komunikat dziennika, w tym znaczniki czasu, poziomy dziennika, szczegóły wyjątków i właściwości niestandardowe. To sprawia, że Serilog przewyższa inne biblioteki logowania pod względem szczegółowości i przejrzystości logów, oferując programistom kluczowe informacje na temat zachowania i wydajności aplikacji.

Za pośrednictwem pliku konfiguracyjnego

Użyj pliku konfiguracyjnego JSON, aby zdefiniować poziomy logowania, miejsca docelowe wyjścia (takie jak pliki logów lub konsola) oraz format wyjściowy logów. Podejście oparte na pliku konfiguracyjnym zapewnia elastyczność w zakresie zmiany zachowania rejestrowania bez konieczności modyfikowania kodu. Odbywa się to poprzez określenie ustawień w pliku appsettings.json, co pozwala skierować wyjście logów do różnych miejsc, takich jak konsola, plik, a nawet usługi zarządzania logami w chmurze.

Programowo w kodzie

Alternatywnie można skonfigurować Serilog bezpośrednio w kodzie, używając klasy LoggerConfiguration. Metoda ta jest często wykorzystywana do konfiguracji bardziej złożonych scenariuszy logowania, takich jak dynamiczne poziomy logowania lub niestandardowe odbiorniki logów. Na przykład można skonfigurować plik dziennika typu rolling, który tworzy nowy plik dziennika w określonych odstępach czasu lub po osiągnięciu określonego rozmiaru, zapewniając efektywne zarządzanie plikami dziennika.

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

Integracja z ASP.NET Core

Integracja Serilog z .NET Core polega na dodaniu pakietu Serilog za pomocą konsoli menedżera pakietów oraz skonfigurowaniu loggera w pliku Program.cs. Instrukcje var builder i var app w .NET 6 płynnie włączają Serilog do infrastruktury logowania aplikacji. Proces ten zastępuje domyślny moduł logowania biblioteką Serilog, zapewniając, że wszystkie komunikaty logowania są przetwarzane przez potok 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

IronPDF umożliwia tworzenie, odczytywanie i edycję plików PDF w aplikacjach .NET. Może to być szczególnie przydatne w połączeniu z Serilogiem do generowania raportów PDF z danymi logów, umożliwiając łatwą dystrybucję i przeglądanie informacji logów w standardowym formacie.

IronOCR

Biblioteka IronOCR do optycznego rozpoznawania znaków (OCR), która może przekształcać obrazy na tekst w 125 językach. Funkcja ta może być wykorzystywana w scenariuszach logowania, w których dane tekstowe muszą być wyodrębniane z obrazów lub zeskanowanych dokumentów, wzbogacając w ten sposób dane logowania o dodatkowe informacje kontekstowe.

IronXL

IronXL zapewnia funkcjonalność umożliwiającą pracę z programem Excel bez konieczności korzystania z Office Interop. Może to być szczególnie korzystne do celów rejestrowania, ponieważ dane dziennika można eksportować do programu Excel w celu dalszej analizy i raportowania, oferując znany interfejs do manipulacji danymi i ich wizualizacji.

IronBarcode

IronBarcode ułatwia odczytywanie i zapisywanie kodów QR oraz kodów kreskowych. Biblioteka ta umożliwia osadzanie lub wyodrębnianie zakodowanych informacji z plików dziennika, zwiększając bezpieczeństwo i identyfikowalność rejestrowanych danych.