給 asp.net core 寫個中間件來記錄接口耗時

給 asp.net core 寫個中間件來記錄接口耗時

Intro

寫接口的不免會遇到別人說接口比較慢，到底慢多少，一個接口服務器處理究竟花了多長時間，若是能有具體的數字來記錄每一個接口耗時多少，別人再說接口慢的時候看一下接口耗時統計，若是幾毫秒就處理完了，對不起這鍋我不背。

中間件實現

asp.net core 的運行是一個又一個的中間件來完成的，所以咱們只須要定義本身的中間件，記錄請求開始處理前的時間和處理結束後的時間，這裏的中間件把請求的耗時輸出到日誌裏了，你也能夠根據須要輸出到響應頭或其餘地方。

public static class PerformanceLogExtension
{
    public static IApplicationBuilder UsePerformanceLog(this IApplicationBuilder applicationBuilder)
    {
        applicationBuilder.Use(async (context, next) =>
            {
                var profiler = new StopwatchProfiler();
                profiler.Start();
                await next();
                profiler.Stop();

                var logger = context.RequestServices.GetService<ILoggerFactory>()
                    .CreateLogger("PerformanceLog");
                logger.LogInformation("TraceId:{TraceId}, RequestMethod:{RequestMethod}, RequestPath:{RequestPath}, ElapsedMilliseconds:{ElapsedMilliseconds}, Response StatusCode: {StatusCode}",
                                        context.TraceIdentifier, context.Request.Method, context.Request.Path, profiler.ElapsedMilliseconds, context.Response.StatusCode);
            });
        return applicationBuilder;
    }
}

中間件配置

在 Startup 裏配置請求處理管道，示例配置以下：

app.UsePerformanceLog();

app.UseAuthentication();
app.UseMvc(routes =>
    {
      // ...
    });
// ...

示例

在日誌裏按 Logger 名稱 「PerformanceLog」 搜索日誌，日誌裏的 ElapsedMilliseconds 就是對應接口的耗時時間，也能夠按 ElapsedMilliseconds 範圍來搜索，好比篩選耗時時間大於 1s 的日誌

Memo

這個中間件比較簡單，只是一個處理思路。

大型應用能夠用比較專業的 APM 工具，最近比較火的 [Skywalking](https://github.com/ apache/skywalking) 項目能夠了解一下，支持 .NET Core, 詳細信息參考: https://github.com/SkyAPM/SkyAPM-dotnet

Reference

• https://github.com/WeihanLi/ActivityReservation

原文出處：https://www.cnblogs.com/weihanli/p/record-aspnetcore-api-elapsed-milliseconds-via-custom-middleware.html