Logging và diagnostics trong Kestrel

Tác giả: Sourabh Shirhatti

Bài viết này cung cấp hướng dẫn thu thập diagnostics (chẩn đoán) từ Kestrel để giúp khắc phục sự cố. Các chủ đề bao gồm:

• Logging (ghi nhật ký): Structured logs được ghi vào .NET logging. ILogger được sử dụng bởi các app framework để ghi logs, và bởi users cho logging của riêng họ trong ứng dụng.
• Metrics (chỉ số): Biểu diễn các đo lường dữ liệu theo khoảng thời gian, ví dụ như requests per second. Metrics data được phát ra bằng EventCounter và có thể quan sát bằng công cụ dòng lệnh dotnet-counters hoặc với Application Insights.
• DiagnosticSource: DiagnosticSource là cơ chế ghi nhật ký thời gian production với các payload dữ liệu phong phú để tiêu thụ trong process. Không giống như logging, vốn giả định dữ liệu sẽ rời process và mong đợi dữ liệu có thể serialize, DiagnosticSource hoạt động tốt với dữ liệu phức tạp.

Logging

Giống như hầu hết các thành phần trong ASP.NET Core, Kestrel sử dụng Microsoft.Extensions.Logging để phát ra thông tin log. Kestrel sử dụng nhiều categories cho phép bạn chọn lọc các logs bạn muốn nghe.

Connection logging

Kestrel cũng hỗ trợ phát ra logs mức Debug cho giao tiếp ở cấp byte và có thể được bật trên từng endpoint. Để bật connection logging, xem configure endpoints for Kestrel.

Metrics

Metrics là biểu diễn các đo lường dữ liệu theo khoảng thời gian, ví dụ requests per second. Metrics data cho phép quan sát trạng thái của ứng dụng ở cấp cao. Kestrel metrics được phát ra bằng EventCounter.

Lưu ý: Các counter connections-per-second và tls-handshakes-per-second được đặt tên không chính xác. Các counter này:

• Không luôn chứa số lượng kết nối mới hoặc TLS handshakes mỗi giây
• Hiển thị số lượng kết nối mới hoặc TLS handshakes trong khoảng cập nhật cuối cùng

Chúng tôi khuyến nghị người tiêu thụ các counter này chia giá trị metric dựa trên DisplayRateTimeScale là một giây.

DiagnosticSource

Kestrel phát ra sự kiện DiagnosticSource cho các HTTP request bị từ chối ở tầng server như các requests không đúng định dạng và vi phạm giao thức. Như vậy, các requests này không bao giờ lên đến tầng hosting của ASP.NET Core.

Kestrel phát ra các sự kiện này với tên sự kiện Microsoft.AspNetCore.Server.Kestrel.BadRequest và một IFeatureCollection là object payload. Exception cơ bản có thể được lấy bằng cách truy cập IBadRequestExceptionFeature trên feature collection.

Giải quyết các sự kiện này là quá trình hai bước. Trước tiên phải tạo observer cho DiagnosticListener:

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();
}

Subscribe vào ASP.NET Core DiagnosticListener với observer. Trong ví dụ này, tạo callback để log exception cơ bản:

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

Hành vi khi đính kèm debugger

Một số timeout và rate limit không được thực thi khi có debugger đính kèm vào process Kestrel. Để biết thêm thông tin, xem Behavior with debugger attached.