ASP.NET Core 中的健康检查 UI 如何配置?

来源:这里教程网 时间:2026-02-21 17:27:15 作者:

在 ASP.NET Core 中配置健康检查 UI,可以让你直观地查看应用各项服务的健康状态,比如数据库、缓存、外部 API 等。要启用健康检查 UI,需要结合 Microsoft.AspNetCore.Diagnostics.HealthChecks 和第三方库 AspNetCore.HealthChecks.UI 来实现。

安装所需 NuGet 包

你需要先安装以下两个核心包:

AspNetCore.HealthChecks.UI – 提供健康检查的前端界面 AspNetCore.HealthChecks.UI.InMemory.Storage – 使用内存存储健康检查结果(也可替换为数据库存储)

通过 NuGet 包管理器或命令行安装:

dotnet add package HealthChecks.UI
dotnet add package HealthChecks.UI.InMemory.Storage

配置健康检查服务

Program.cs 中注册健康检查和 UI 服务:

using HealthChecks.UI.Client;
var builder = WebApplication.CreateBuilder(args);
// 添加健康检查服务
builder.Services.AddHealthChecks()
    .AddSqlServer(builder.Configuration.GetConnectionString("DefaultConnection"))
    .AddRedis(builder.Configuration["Redis:Configuration"])
    .AddUrlGroup(new Uri("https://httpbin.org/status/200"), name: "external-api");
// 添加健康检查 UI
builder.Services.AddHealthChecksUI(settings =>
{
    settings.SetEvaluationTimeInSeconds(30); // 每30秒检查一次
    settings.MaximumHistoryEntriesPerEndpoint(50); // 保留历史记录
}).AddInMemoryStorage(); // 使用内存存储
var app = builder.Build();
// 启用健康检查中间件
app.UseHealthChecks("/health", new HealthCheckOptions
{
    Predicate = _ => true,
    ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse
});
// 启用健康检查 UI 路由
app.UseHealthChecksUI(options =>
{
    options.UIPath = "/health-ui";         // 访问 UI 的路径
    options.ApiPath = "/health-ui-api";    // API 接口路径
});

访问健康检查页面

启动应用后,可以通过以下地址访问健康检查 UI:

/health-ui – 健康检查的可视化界面 /health – 原始健康检查 JSON 输出

确保你在浏览器中能正常打开

https://localhost:xxxx/health-ui
,看到各个检查项的状态(健康、警告、不健康)。

可选:使用持久化存储

内存存储适合开发环境,生产环境建议使用数据库。例如使用 SQL Server 存储:

安装包:AspNetCore.HealthChecks.UI.Database.Storage 替换存储方式:
<code>builder.Services.AddHealthChecksUI()
    .AddSqliteStorage("Data Source=healthchecks.db"); // 或 UseSqlServer

首次运行会自动创建所需的数据表。

基本上就这些。配置完成后,你就能通过图形界面实时监控服务健康状态,便于排查问题和集成到运维系统中。

相关推荐