如何在 ASP.Net Core 中实现 健康检查
健康检查
常用于判断一个应用程序能否对 request 请求进行响应,ASP.Net Core 2.2 中引入了 健康检查
中间件用于报告应用程序的健康状态。
ASP.Net Core 中的 健康检查
落地做法是暴露一个可配置的 Http 端口,你可以使用 健康检查
去做一个最简单的活性检测,比如说:检查网络和系统的资源可用性,数据库资源是否可用,应用程序依赖的消息中间件或者 Azure cloud service 的可用性 等等,这篇文章我们就来讨论如何使用这个 健康检查中间件。
注册健康检查服务
要注册 健康检查
服务,需要在 Startup.ConfigureServices
下调用 AddHealthChecks 方法,然后使用 UseHealthChecks 将其注入到 Request Pipeline 管道中,如下代码所示:
public class Startup{// This method gets called by the runtime. Use this method to add services to the container.public void ConfigureServices(IServiceCollection services){services.AddControllersWithViews();services.AddHealthChecks();}// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.public void Configure(IApplicationBuilder app, IWebHostEnvironment env){app.UseHealthChecks("/health");app.UseStaticFiles();app.UseRouting();app.UseEndpoints(endpoints =>{endpoints.MapControllerRoute(name: "default",pattern: "{controller=Home}/{action=Index}/{id?}");});}}
上图的 /health
就是一个可供检查此 web 是否存活的暴露端口。
其他服务的健康检查
除了web的活性检查,还可以检查诸如:SQL Server, MySQL, MongoDB, Redis, RabbitMQ, Elasticsearch, Hangfire, Kafka, Oracle, Azure Storage 等一系列服务应用的活性,每一个服务需要引用相关的 nuget 包即可,如下图所示:
然后在 ConfigureServices 中添加相关服务即可,比如下面代码的 AddSqlServer
。
public void ConfigureServices(IServiceCollection services){services.AddControllersWithViews();services.AddHealthChecks().AddSqlServer("server=.;database=PYZ_L;Trusted_Connection=SSPI");}
自定义健康检查
除了上面的一些开源方案,还可以自定义实现 健康检查
类,比如自定义方式来检测 数据库
或 外部服务
的可用性,那怎么实现呢?只需要实现系统内置的 IHealthCheck
接口并实现 CheckHealthAsync() 即可,如下代码所示:
public class MyCustomHealthCheck : IHealthCheck{public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context,CancellationToken cancellationToken = default(CancellationToken)){bool canConnect = IsDBOnline();if (canConnect)return HealthCheckResult.Healthy();return HealthCheckResult.Unhealthy();}}
这里的 IsDBOnline 方法用来判断当前数据库是否是运行状态,实现代码如下:
private bool IsDBOnline(){string connectionString = "server=.;database=PYZ_L;Trusted_Connection=SSPI";try{using (SqlConnection connection = new SqlConnection(connectionString)){if (connection.State != System.Data.ConnectionState.Open) connection.Open();}return true;}catch (System.Exception){return false;}}
然后在 ConfigureServices 方法中进行注入。
public void ConfigureServices(IServiceCollection services){services.AddControllersWithViews();services.AddHealthChecks().AddCheck<MyCustomHealthCheck>("sqlcheck");}public void Configure(IApplicationBuilder app, IWebHostEnvironment env){app.UseRouting().UseEndpoints(config =>{config.MapHealthChecks("/health");});app.UseStaticFiles();app.UseRouting();app.UseEndpoints(endpoints =>{endpoints.MapControllerRoute(name: "default",pattern: "{controller=Home}/{action=Index}/{id?}");});}
接下来可以浏览下 /health 页面,可以看出该端口自动执行了你的 MyCustomHealthCheck 方法,如下图所示:
可视化健康检查
上面的检查策略虽然好,但并没有一个好的可视化方案,要想实现可视化的话,还需要单独下载 Nuget 包:AspNetCore.HealthChecks.UI
, HealthChecks.UI.Client
和 AspNetCore.HealthChecks.UI.InMemory.Storage
,命令如下:
Install-Package AspNetCore.HealthChecks.UI
Install-Package AspNetCore.HealthChecks.UI.Client
Install-Package AspNetCore.HealthChecks.UI.InMemory.Storage
一旦包安装好之后,就可以在 ConfigureServices 和 Configure 方法下做如下配置。
public class Startup{// This method gets called by the runtime. Use this method to add services to the container.public void ConfigureServices(IServiceCollection services){services.AddControllersWithViews();services.AddHealthChecks();services.AddHealthChecksUI().AddInMemoryStorage();}// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.public void Configure(IApplicationBuilder app, IWebHostEnvironment env){app.UseRouting().UseEndpoints(config =>{config.MapHealthChecks("/health", new HealthCheckOptions{Predicate = _ => true,ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse});});app.UseHealthChecksUI();app.UseStaticFiles();app.UseRouting();app.UseEndpoints(endpoints =>{endpoints.MapControllerRoute(name: "default",pattern: "{controller=Home}/{action=Index}/{id?}");});}}
最后还要在 appsettings.json 中配一下 HealthChecks-UI 中的检查项,如下代码所示:
{"Logging": {"LogLevel": {"Default": "Information","Microsoft": "Warning","Microsoft.Hosting.Lifetime": "Information"}},"AllowedHosts": "*","HealthChecks-UI": {"HealthChecks": [{"Name": "Local","Uri": "http://localhost:65348/health"}],"EvaluationTimeOnSeconds": 10,"MinimumSecondsBetweenFailureNotifications": 60}
}
最后在浏览器中输入 /healthchecks-ui
看一下 可视化UI 长成啥样。
使用 ASP.Net Core 的 健康检查中间件
可以非常方便的对 系统资源,数据库 或者其他域外资源进行监控,你可以使用自定义检查逻辑来判断什么样的情况算是 Healthy,什么样的算是 UnHealthy,值得一提的是,当检测到失败时还可以使用失败通知机制,类似 github 发布钩子。
译文链接:https://www.infoworld.com/article/3379187/how-to-implement-health-checks-in-aspnet-core.html
如何在 ASP.Net Core 中实现 健康检查相关推荐
- 在.NET Core 中实现健康检查
.NET Core中提供了开箱即用的运行状况检查,首先,我将在.NET Core API应用程序中执行运行状况检查,接下来,我们将使用DbContext集成SQL Server或数据库的运行状况检查, ...
- 如何在 ASP.NET Core 中使用 HttpClientFactory ?
ASP.Net Core 是一个开源的,跨平台的,轻量级模块化框架,可用它来构建高性能的Web程序,这篇文章我们将会讨论如何在 ASP.Net Core 中使用 HttpClientFactory. ...
- 如何在 ASP.Net Core 中使用 Autofac
依赖注入可以有效的实现对象之间的 松耦合 并能够实现代码的可测试和可维护性,ASP.Net Core 提供了一个极简版的容器实现对 依赖注入 的原生支持,然而内置的依赖注入容器相比成熟的 依赖注入容器 ...
- 如何在 ASP.Net Core 中使用 Lamar
ASP.Net Core 自带了一个极简的 开箱即用 的依赖注入容器,实际上,你还可以使用第三方的 依赖注入容器 来替代它,依赖注入是一种设计模式,它能够有效的实现对象之间的解耦并有利于提高单元测试和 ...
- 如何在 ASP.Net Core 中使用 MediatR
MediatR 是一个 中介者模式 的.NET开源实现, 中介者模式 管控了一组对象之间的相互通讯并有效的减少了对象之间错综复杂的相互依赖,在 中介者模式 中,一个对象不需要直接和另一个对象进行通讯, ...
- 如何在 ASP.Net Core 中对接 WCF
在 REST API 出现之前,SOAP (Simple Object Access Protocol) 一直都是基于 web 的标准协议,虽然现在 REST 大行其道,但在平时开发中总会遇到对接第三 ...
- 如何在 ASP.Net Core 中使用 NCache
虽然 ASP.Net Core 中缺少 Cache 对象,但它引入了三种不同的cache方式. 内存缓存 分布式缓存 Response缓存 Alachisoft 公司提供了一个开源项目 NCache, ...
- 如何在 ASP.Net Core 中使用 Configuration Provider
ASP.NET Core 是一个开源的,跨平台的,精简的模块化框架,可用于构建高性能,可扩展的web应用程序, ASP.NET Core 中的数据配置常用 k-v 的形式存储,值得注意的是,新的数据配 ...
- 如何在 ASP.Net Core 中使用 Serilog
记录日志的一个作用就是方便对应用程序进行跟踪和排错调查,在实际应用上都是引入 日志框架,但如果你的 日志文件 包含非结构化的数据,那么查询起来将是一个噩梦,所以需要在记录日志的时候采用结构化方式. 将 ...
最新文章
- 事业单位计算机专业知识试卷,计算机专业知识试题(事业单位计算机专业知识考试试卷).doc...
- js的闭包与原型记录
- 医学图像~脑分类数据fMRI, voxel
- 一年的第几周怎么算_外企必备,算某一天是今年第几周,用一个excel函数就搞定...
- inet_pton函数和inet_ntop函数的用法及简单实现
- Linux 小知识翻译 - 「/proc 文件夹」
- python矩阵所有元素取整_Python中如何对一个数值进行取整操作呢?
- 吴恩达神经网络和深度学习-学习笔记-12-RMSprop算法
- Win7系统无法被远程桌面连接如何解决
- Python回归分析五部曲(三)—一元非线性回归
- -bash: netstat: 未找到命令
- 剑指Offer全题解—Java版本
- WEB——Request与Response
- HZNUOJ1527
- 轴旋转——制作别样的图片浏览器
- angularjs学习总结 详细教程
- 市场底部特征_A股市场底部特征究竟有哪些?
- jar调用dll文件提示找不到指定的模块Unable to load library
- linux降级安装补丁,Adobe Shockwave Player降级安装漏洞
- 【Linux运维-集群技术进阶】集群/分布式环境下5种session处理策略
热门文章
- linux下安装mysql说明
- 廖雪峰 练习 把用户输入的不规范的英文名字,变为首字母大写,其他小写的规范名字...
- 读《一个程序猿的生命周期》有感
- Linux内核升级,从2.6.18升级到3.2.14
- UVA 10518 How Many Calls?
- Linux操作系统下Sudo命令的使用方法说明
- Unity3D学习笔记之七创建自己的游戏场景
- 什么时候可以升级HarmonyOS,华为鸿蒙OS即将迎来升级 手机版本或仍需时间
- 关于CTeX的几个大坑
- linux下redis安装