Böcker
C#
Kapitel 5. Bra kodningspraxis
Loggning

C#:
Loggning

Hur man gör:

I C# kan du använda det inbyggda namnrymdet System.Diagnostics eller tredjepartskomponenter som NLog eller log4net. Här är ett snabbt exempel som använder ILogger-gränssnittet tillgängligt i .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("Det här är ett informationmeddelande.");
        logger.LogWarning("Det här är ett varningsmeddelande.");
        logger.LogError("Det här är ett felmeddelande.");
    }
}

Exempel på utskrift:

info: Program[0]
      Det här är ett informationmeddelande.
warn: Program[0]
      Det här är ett varningsmeddelande.
fail: Program[0]
      Det här är ett felmeddelande.

Fördjupning

Historien om loggning i mjukvaruutvecklingen är nästan lika gammal som programmeringen själv; den har utvecklats från enkla utskriftsdeklarationer till sofistikerade, konfigurerbara system. Ursprungligen utfördes loggning genom att skriva till filer eller konsolen, men detta har utökats till att inkludera mer komplexa strukturer såsom loggaggregeringssystem och plattformar för distribuerad spårning (som ELK-stacken eller Jaeger).

Alternativ till den inbyggda loggningen i .NET inkluderar tredjepartskomponenter:

  • NLog: mångsidig och enkel att ställa in, med massor av funktioner för ruttning, formatering och filtrering av loggar.
  • log4net: inspirerad av Java-biblioteket log4j, det är mycket konfigurerbart från XML och stödjer en mängd olika loggrepositorier.

När det kommer till implementationsdetaljer, kan valet av din loggningsabstraktion (som Microsoft.Extensions.Logging) och den underliggande loggningsleverantören avsevärt påverka din applikations prestanda och tillförlitlighet. Det är avgörande att konfigurera loggningsnivåerna på ett lämpligt sätt och säkerställa att loggning inte blir en flaskhals.

Dessutom tillåter strukturerad loggning - där du loggar inte bara strängar men nyckel-värdepar eller objekt - för mer precisa och handlingsbara loggar, vilka är enklare att söka i och analysera.

Se även

Hantering av felAtt organisera kod i funktioner