Książki
C#
Rozdział 5. Dobre praktyki programowania
Rejestrowanie zdarzeń

C#:
Rejestrowanie zdarzeń

Jak to zrobić:

W C#, można użyć wbudowanej przestrzeni nazw System.Diagnostics lub bibliotek stron trzecich takich jak NLog czy log4net. Oto krótki przykład z wykorzystaniem interfejsu ILogger, dostępnego w .NET Core:

using Microsoft.Extensions.Logging;
using System;

public class Program
{
    public static void Main()
    {
        using var loggerFactory = LoggerFactory.Create(builder => {
            builder.AddConsole();
        });

        ILogger logger = loggerFactory.CreateLogger<Program>();

        logger.LogInformation("To jest informacyjna wiadomość.");
        logger.LogWarning("To jest wiadomość ostrzegawcza.");
        logger.LogError("To jest wiadomość o błędzie.");
    }
}

Przykładowe wyjście:

info: Program[0]
      To jest informacyjna wiadomość.
warn: Program[0]
      To jest wiadomość ostrzegawcza.
fail: Program[0]
      To jest wiadomość o błędzie.

Dogłębna analiza

Historia logowania w rozwoju oprogramowania jest niemal tak stara jak samo programowanie; ewoluowała od prostych poleceń wydruku do zaawansowanych, konfigurowalnych systemów. Początkowo logowanie odbywało się przez zapisywanie do plików lub konsoli, ale rozrosło się to do bardziej złożonych struktur, takich jak systemy agregacji logów i platformy śledzenia rozproszonego (jak stos ELK czy Jaeger).

Alternatywy dla wbudowanego logowania w .NET obejmują biblioteki stron trzecich:

  • NLog: wszechstronny i łatwy w konfiguracji, z wieloma funkcjami do kierowania, formatowania i filtrowania logów.
  • log4net: inspirowany biblioteką Java log4j, jest wysoce konfigurowalny z XML i obsługuje różnorodność repozytoriów logów.

Jeśli chodzi o szczegóły implementacji, wybór abstrakcji logowania (jak Microsoft.Extensions.Logging) oraz podstawowego dostawcy logowania może znacząco wpłynąć na wydajność i niezawodność Twojej aplikacji. Kluczowe jest właściwe skonfigurowanie poziomów logowania oraz upewnić się, że zapisywanie logów nie stanie się wąskim gardłem.

Ponadto, strukturalne logowanie - gdzie rejestruje się nie tylko łańcuchy znaków, ale pary klucz-wartość lub obiekty - umożliwia bardziej precyzyjne i użyteczne logi, które są łatwiejsze do zapytań i analizy.

Zobacz także

Obsługa błędówOrganizacja kodu w funkcje