Diagnostik i Kestrel

Av Sourabh Shirhatti

Den här artikeln innehåller vägledning för att samla in diagnostik från Kestrel för att felsöka problem. Ämnen som tas upp är:

• Loggning: Strukturerade loggar som skrivits till .NET-loggning. ILogger används av appramverk för att skriva loggar och av användare för sin egen loggning i en app.
• Mått: Representation av datamått över tidsintervall, till exempel begäranden per sekund. Mått genereras med hjälp av EventCounter och kan observeras med hjälp av kommandoradsverktyget dotnet-counters eller med Application Insights.
• DiagnosticSource: DiagnosticSource är en mekanism för loggning under produktionstid med omfattande datanyttolaster för användning inom processen. Till skillnad från loggning, som förutsätter att data lämnar processen och förväntar sig serialiserbara data, DiagnosticSource fungerar det bra med komplexa data.

Logging

Precis som de flesta komponenter i ASP.NET Core används KestrelMicrosoft.Extensions.Logging för att generera logginformation. Kestrel använder sig av flera kategorier som gör att du kan vara selektiv på vilka loggar du lyssnar på.

Loggning av anslutningar

Kestrel stöder också möjligheten att generera Debug nivåloggar för kommunikation på bytenivå och kan aktiveras per slutpunkt. För att aktivera anslutningsloggning, se konfigurera slutpunkter för Kestrel

Metrics

Mått är en representation av datamått över tidsintervall, till exempel begäranden per sekund. Måttdata gör det möjligt att övervaka tillståndet för en app på hög nivå. Kestrel mätvärden genereras med hjälp av EventCounter.

DiagnosticSource

Kestrel genererar en DiagnosticSource händelse för HTTP-begäranden som avvisas på servernivå, till exempel felaktiga begäranden och protokollöverträdelser. Därför kommer dessa begäranden aldrig in i värdlagret i ASP.NET Core.

Kestrel genererar dessa händelser med Microsoft.AspNetCore.Server.Kestrel.BadRequest händelsenamnet och en IFeatureCollection som objektnyttolast. Det underliggande undantaget kan hämtas genom att komma åt IBadRequestExceptionFeature i funktionssamlingen.

Att lösa dessa händelser är en tvåstegsprocess. En övervakare för DiagnosticListener måste skapas:

class BadRequestEventListener : IObserver<KeyValuePair<string, object>>, IDisposable
{
    private readonly IDisposable _subscription;
    private readonly Action<IBadRequestExceptionFeature> _callback;

    public BadRequestEventListener(DiagnosticListener diagnosticListener, Action<IBadRequestExceptionFeature> callback)
    {
        _subscription = diagnosticListener.Subscribe(this!, IsEnabled);
        _callback = callback;
    }
    private static readonly Predicate<string> IsEnabled = (provider) => provider switch
    {
        "Microsoft.AspNetCore.Server.Kestrel.BadRequest" => true,
        _ => false
    };
    public void OnNext(KeyValuePair<string, object> pair)
    {
        if (pair.Value is IFeatureCollection featureCollection)
        {
            var badRequestFeature = featureCollection.Get<IBadRequestExceptionFeature>();

            if (badRequestFeature is not null)
            {
                _callback(badRequestFeature);
            }
        }
    }
    public void OnError(Exception error) { }
    public void OnCompleted() { }
    public virtual void Dispose() => _subscription.Dispose();
}

Prenumerera på ASP.NET Core DiagnosticListener med observatören. I detta exempel skapar vi en callback som loggar det underliggande undantaget.

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
var diagnosticSource = app.Services.GetRequiredService<DiagnosticListener>();
using var badRequestListener = new BadRequestEventListener(diagnosticSource, (badRequestExceptionFeature) =>
{
    app.Logger.LogError(badRequestExceptionFeature.Error, "Bad request received");
});
app.MapGet("/", () => "Hello world");
app.Run();

Beteende med felsökningsprogrammet anslutet

Vissa tidsgränser och hastighetsgränser tillämpas inte när ett felsökningsprogram är kopplat till en Kestrel process. Mer information finns i Beteende med felsökningsprogram kopplat.