0

0

ASP.NET Core怎么实现健康检查 HealthChecks配置与使用方法

煙雲

煙雲

发布时间:2026-02-08 10:20:03

|

184人浏览过

|

来源于php中文网

原创

ASP.NET Core健康检查是监控应用状态的轻量机制,需配置检查项、暴露端点并按场景定制;支持就绪/存活区分、自定义检查及K8s/Prometheus集成。

asp.net core怎么实现健康检查 healthchecks配置与使用方法

ASP.NET Core 的健康检查(Health Checks)是监控应用运行状态的轻量级机制,能快速识别服务是否就绪、是否存活、依赖是否可用。它不复杂但容易忽略细节,关键是配置好检查项、暴露端点、并结合实际场景定制逻辑。

启用健康检查中间件

Program.cs 中注册健康检查服务并添加中间件:

  • 调用 AddHealthChecks() 注册服务,可链式添加各种检查器(如数据库、HTTP、磁盘等)
  • 调用 MapHealthChecks() 暴露 HTTP 端点,支持自定义路径、响应格式和授权

示例:

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHealthChecks()
    .AddSqlServer(connectionString: "Server=...;Database=Test;...")
    .AddRedis("localhost:6379", name: "redis-cache")
    .AddProcessHostedServiceCheck(); // 自定义检查:确认后台服务是否启动

var app = builder.Build();
app.MapHealthChecks("/health", new HealthCheckOptions
{
    ResponseWriter = async (ctx, report) =>
    {
        ctx.Response.ContentType = "application/json";
        await JsonSerializer.SerializeAsync(ctx.Response.Body, report, new JsonSerializerOptions { WriteIndented = true });
    }
});

定义自定义健康检查

当内置检查器不满足需求时(比如检查第三方 API 可用性、文件写入权限、配置有效性),可实现 IHealthCheck 接口:

  • 重写 CheckHealthAsync 方法,执行检测逻辑
  • 返回 HealthCheckResult.Healthy().Unhealthy().Degraded()
  • 可传入描述、异常、数据字典(用于输出诊断信息)

例如检查某个配置项是否存在:

public class ConfigHealthCheck : IHealthCheck
{
    private readonly IConfiguration _config;
    public ConfigHealthCheck(IConfiguration config) => _config = config;

    public Task CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
    {
        var value = _config["ExternalApi:BaseUrl"];
        return Task.FromResult(string.IsNullOrWhiteSpace(value)
            ? HealthCheckResult.Unhealthy("External API base URL is missing.")
            : HealthCheckResult.Healthy());
    }
}

然后注册:services.AddHealthChecks().AddCheck("config-check");

快剪辑
快剪辑

国内⼀体化视频⽣产平台

下载

区分就绪(Ready)与存活(Live)检查

生产中常需两类检查:

  • /health/live:只判断进程是否存活(如未崩溃、未被 SIGTERM 中断),通常用 AddLivenessCheck 或简单返回 Healthy
  • /health/ready:判断是否已准备好接收流量(如数据库连通、缓存加载完成、后台任务初始化完毕)

ASP.NET Core 不自带 Live/Ready 区分,但可通过不同端点 + 不同检查集合实现:

app.MapHealthChecks("/health/live", new HealthCheckOptions
{
    Predicate = _ => true // 所有检查都跳过,或只挂一个空检查
});

app.MapHealthChecks("/health/ready", new HealthCheckOptions
{
    Predicate = reg => reg.Tags.Contains("ready") // 只执行带 "ready" 标签的检查
});

// 注册时打标签
services.AddHealthChecks()
    .AddSqlServer(connStr, tags: new[] { "ready" })
    .AddCheck("startup-task", tags: new[] { "ready" });

集成到 Kubernetes 或 Prometheus

K8s 的 liveness/readiness 探针可直接对接上述端点;Prometheus 则需启用指标导出:

  • 安装 AspNetCore.HealthChecks.Prometheus.Metrics
  • 调用 AddPrometheusExporter() 并映射 /metrics
  • 健康检查结果会自动转为 Prometheus 格式指标(如 healthcheck_status{check="sql",status="healthy"} 1)

注意:Prometheus 端点默认不启用认证,上线前建议加中间件限制访问来源。

基本上就这些。关键不是堆功能,而是按环境选检查项、合理打标签、让返回信息对运维真正有用。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

857

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

331

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

351

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1468

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

365

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1046

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

581

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

431

2024.04.29

Golang处理数据库错误教程合集
Golang处理数据库错误教程合集

本专题整合了Golang数据库错误处理方法、技巧、管理策略相关内容,阅读专题下面的文章了解更多详细内容。

61

2026.02.06

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
进程与SOCKET
进程与SOCKET

共6课时 | 0.4万人学习

Redis+MySQL数据库面试教程
Redis+MySQL数据库面试教程

共72课时 | 6.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号