前言

ASP.NET Core提供運行狀況檢查Middleware和庫，以便于報告應用的運行狀況。

使用方式也很簡單。

引用Nuget包Microsoft.Extensions.Diagnostics.HealthChecks。

然后修改Startup.cs文件:

public?void?ConfigureServices(IServiceCollection?services) {...services.AddHealthChecks(); } public?void?Configure(IApplicationBuilder?app,?IWebHostEnvironment?env) {...app.UseHealthChecks("/health"); }

我們甚至可以為第三方組件，比如數據庫、緩存，提供健康狀態檢查。

最后，訪問/health來查看應用程序的健康狀態：

這種文本方式不夠直觀，今天我們介紹一個輕量級的圖形UI，通過可視化的方式進行健康檢查。

Demo

1.引用Nuget包

引用如下Nuget包：

AspNetCore.HealthChecks.UI AspNetCore.HealthChecks.UI.Client AspNetCore.HealthChecks.UI.InMemory.Storage

UI支持不同的存儲類型，如Sql Server、MySql等，這里選擇直接保存到內存。

2.修改Startup.cs

添加UI，并設置了自定義健康檢查，用于演示不健康狀態:

public?void?ConfigureServices(IServiceCollection?services) {...services.AddHealthChecksUI().AddInMemoryStorage();services.AddHealthChecks().AddCheck<DemoHealthCheck>("My?IO"); }public?class?DemoHealthCheck:?IHealthCheck {public?Task<HealthCheckResult>?CheckHealthAsync(HealthCheckContext?context,?CancellationToken?cancellationToken?=?default){if?(DateTime.Now.Second?>?30){return?Task.FromResult(HealthCheckResult.Healthy());}return?Task.FromResult(HealthCheckResult.Unhealthy("不健康"));} }

指定健康檢查和UI的地址，并且使用UIResponseWriter.WriteHealthCheckUIResponse返回json格式健康檢查數據：

public?void?Configure(IApplicationBuilder?app,?IWebHostEnvironment?env) {...app.UseEndpoints(endpoints?=>{endpoints.MapControllers();endpoints.MapHealthChecks("/health",?new?HealthCheckOptions(){Predicate?=?_?=>?true,ResponseWriter?=?UIResponseWriter.WriteHealthCheckUIResponse});endpoints.MapHealthChecksUI(options?=>?options.UIPath?=?"/health-ui");}); }

3.添加配置項

修改appsettings.json文件：

"HealthChecksUI":?{"HealthChecks":?[{"Name":?"My?IO","Uri":?"/health"}],"Webhooks":?[{"Name":?"","Uri":?"","Payload":?"","RestoredPayload":?""}],"EvaluationTimeinSeconds":?10,"MinimumSecondsBetweenFailureNotifications":?60}

HealthChecks是個數組，也就是說，UI同時可以監控多個健康檢查API。

Webhooks用于當API的健康狀態改變時，向指定Uri發送告警數據。

4.使用

運行程序，訪問/health-ui即可打開UI：

點擊Details按鈕，還可查看健康狀態歷史：

總結

以上是生活随笔為你收集整理的可视化ASP.Net Core Web API健康检查的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。