W3CLogger i ASP.NET Core

W3CLogger är ett mellanprogram som skriver loggfiler i W3C-standardformat. Loggarna innehåller information om HTTP-begäranden och HTTP-svar. W3CLogger innehåller loggar för:

• HTTP-begärandeinformation
• Gemensamma egenskaper
• Headers
• HTTP-svarsinformation
• Metadata om paret för begäran/svar (startdatum/tid, tidsåtgång)

W3CLogger är värdefull i flera scenarier för att:

• Registrera information om inkommande begäranden och svar.
• Filtrera vilka delar av begäran och svaret som loggas.
• Filtrera vilka rubriker som ska loggas.

W3CLogger kan minska prestandan för en app. Överväg prestandapåverkan när du väljer fält att logga – prestandaminskningen ökar när du loggar fler egenskaper. Testa prestandapåverkan för de valda loggningsegenskaperna.

Warning

W3CLogger kan potentiellt logga personligt identifierbar information (PII). Överväg risken och undvik loggning av känslig information. Som standard loggas inte fält som kan innehålla PII.

Aktivera W3CLogger

Aktivera W3CLogger med UseW3CLogging, som lägger till W3CLogger-mellanprogrammet:

var app = builder.Build();

app.UseW3CLogging();

app.UseRouting();

Som standard loggar W3CLogger vanliga egenskaper som sökväg, statuskod, datum, tid och protokoll. All information om ett enskilt par för begäran/svar skrivs till samma rad.

#Version: 1.0
#Start-Date: 2021-09-29 22:18:28
#Fields: date time c-ip s-computername s-ip s-port cs-method cs-uri-stem cs-uri-query sc-status time-taken cs-version cs-host cs(User-Agent) cs(Referer)
2021-09-29 22:18:28 ::1 DESKTOP-LH3TLTA ::1 5000 GET / - 200 59.9171 HTTP/1.1 localhost:5000 Mozilla/5.0+(Windows+NT+10.0;+WOW64)+AppleWebKit/537.36+(KHTML,+like+Gecko)+Chrome/93.0.4577.82+Safari/537.36 -
2021-09-29 22:18:28 ::1 DESKTOP-LH3TLTA ::1 5000 GET / - 200 0.1802 HTTP/1.1 localhost:5000 Mozilla/5.0+(Windows+NT+10.0;+WOW64)+AppleWebKit/537.36+(KHTML,+like+Gecko)+Chrome/93.0.4577.82+Safari/537.36 -
2021-09-29 22:18:30 ::1 DESKTOP-LH3TLTA ::1 5000 GET / - 200 0.0966 HTTP/1.1 localhost:5000 Mozilla/5.0+(Windows+NT+10.0;+WOW64)+AppleWebKit/537.36+(KHTML,+like+Gecko)+Chrome/93.0.4577.82+Safari/537.36 -

W3CLogger-alternativ

Om du vill konfigurera W3CLogger-mellanprogrammet anropar du AddW3CLogging i Program.cs:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddW3CLogging(logging =>
{
    // Log all W3C fields
    logging.LoggingFields = W3CLoggingFields.All;

    logging.AdditionalRequestHeaders.Add("x-forwarded-for");
    logging.AdditionalRequestHeaders.Add("x-client-ssl-protocol");
    logging.FileSizeLimit = 5 * 1024 * 1024;
    logging.RetainedFileCountLimit = 2;
    logging.FileName = "MyLogFile";
    logging.LogDirectory = @"C:\logs";
    logging.FlushInterval = TimeSpan.FromSeconds(2);
});

LoggingFields

W3CLoggerOptions.LoggingFields är en bitflaggauppräkning som konfigurerar specifika delar av begäran och svaret på loggen och annan information om anslutningen. LoggingFields standardvärden för att inkludera alla möjliga fält utom UserName och Cookie. En fullständig lista över tillgängliga fält finns i W3CLoggingFields.