容器HEALTHCHECK指令对接ASP.NET Core健康检查能力

分享图片

 写在前面

         HealthCheck 不仅是对应用程序内运行情况、数据流通情况进行检查, 还包括应用程序对外部服务或依赖资源的健康检查。

健康检查通常是以暴露应用程序的HTTP端点的形式 实施,可用于配置健康探测的的场景有 :

  • 容器或负载均衡时 探测应用的状态, 例如:容器探测到应用unhealthy可终止后续的滚动部署或者重启容器负载均衡器探测到实例healthyunt能将请求路由到健康的运行实例。

  • 对应用程序种依赖的第三方服务进行健康探测,比如redis、database、外部服务接口

  • 内存、硬盘、网络等物理依赖资源的探测

HealthCheck提供一种 告知外部应用运行状态的机制

 

容器HEALTHCHECK指令

  一般情况下我们很容易知道容器正在运行[running], 但容器作为相对独立的应用执行环境,有时候并不知道容器是否以预期的方式正确运作[working]

Dockerfile/ docker-compose.yml文件提供的 HEALTHCHECK指令提供了探测容器正确工作的轮询机制,轮训内容可由应用自身决定。

该指令定义轮询参数interval、探测超时参数timeout、 重试参数retries 进行不间断探测容器:

// 通过在容器内运行shell命令来探测容器健康状态, 命令返回值0表示容器healthy, 命令返回值1表示unhealthy
EALTHCHECK [OPTIONS] CMD command  

对于容器内Web应用,自然而然会想到使用暴露HTTP端点的方式去探测,并将error response认定为unhealthy

// 容器每隔5min请求应用程序的http://localhost(重试3次),成功响应则返回0,错误响应则返回1
HEALTHCHECK --interval=5m --timeout=3s --retries=3 CMD curl -f http://localhost:5000/healthz || exit 1

下面我们会将渐进式演示 使用Docker平台的HEALTHCHECK指令对接 ASP.NET Core程序的健康检查能力

 

分享图片

 ASP.NET Core 实现HealthCheck

  ASPNET Core在2.2版本内置了健康检查的能力, 使用的是一个HealthCheck Middleware, 该中间件是一个终端中间件,满足该路径的url请求,将会被该中间件处理。

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

  请求/healthcheck端点, 程序会进行健康检查逻辑并响应输出认的行为:

     ① 对healthy、degraded状态返回200 OK 响应码; 对于unhealthy返回503 Service Unavailable 响应码

     ② 响应体只会包含简单的HealthStatus枚举字符串

     ③ 将每次健康检查的结果写入HealthReport对象。

   作为企业级项目,存在对Web项目物理资源和服务依赖的健康检查需求, 这里我们为避免重复造轮子,引入了开源的力量。

 

分享图片

 开源社区对HealthCheck的支持

 开源的企业级AspNetCore.Diagnostics.HealthChecks系列组件,该系列组件支持多种物理资源和服务依赖的健康检查,支持报告推送,支持友好的检查报告UI(支持后台轮训检查)、支持webhook通知

下面的步骤演示了对web程序HTTP请求、Redissqlite等服务进行健康检查的端点配置

    ① 引入AspNetCore.HealthChecks.Redis 、 AspNetCore.HealthChecks.sqlite nuget库

    ② startup中配置并启用健康检查

// 以下代码截取自 Startup.ConfigureServices方法,对swagger服务地址、redissqlte进行健康检查
services.AddHealthChecks().AddAsyncCheck("Http",async () =>
                      {
                        using (HttpClient client = new HttpClient())
                        {
                            try
                            {
                                var response = await client.GetAsync("http://localhost:5000/swagger");
                                if (!response.IsSuccessstatusCode)
                                {
                                    throw new Exception("Url not responding with 200 OK");
                                }
                            }
                            catch (Exception)
                            {
                                return await Task.Fromresult(HealthCheckResult.Unhealthy());
                            }
                        }
                        return await Task.Fromresult(HealthCheckResult.Healthy());
                    })
                    .Addsqlite(
                        sqliteConnectionString: Configuration.GetConnectionString("sqlite"),healthQuery: "select count(*) as count from ProfileUsageCounters;",name: "sqlite",failureStatus: HealthStatus.Degraded,tags: new string[] { "db","sqlite","sqlite" }
                     )
                    .AddRedis(Configuration.GetConnectionString("redis"),"redis",HealthStatus.Unhealthy,new string[] { "redis","redis" })
                    .Services
                    .AddMvc();

// 以下代码截取自Startup.Configure方法: 启用/healthz作为检查端点
 app.UseHealthChecks("/healthz").UseMvcWithDefaultRoute();    //  这里仍然只会响应 200/503状态码+简单的HealthStatus枚举值

     小技巧:你也可以使用UseHealthChecks()扩展方法修改认的响应输出, 这里我们可引入HealthChecks.UI.Client nuget package输出更加详细的的HealthReport

  app.UseHealthChecks("/healthz",new HealthCheckOptions()
                {
                    Predicate = _ => true,ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse // 该响应输出一个json,包含所有检查项的详细检查结果
                });

注意

    上文在Dockerfile中配置的HEALTHCHECK 指令: 

       HEALTHCHECK --interval=5m --timeout=3s --retries=3 CMD curl -f http://localhost:5000/healthz || exit 1

      并不关注响应体输出,依然对于success response 返回0, error response返回1。

    

分享图片

 测试容器的HEALTHCHECK输出

    使用docker ps命令可查看容器的状态, 通过docker inspect [container_id] 查看容器HealthCheck的输出

CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS                  PORTS                NAMES
0111ea10581f        eqidmanager_proxy   "Nginx -g ‘daemon ..."   24 hours ago        Up 24 hours             0.0.0.0:80->80/tcp   eqidmanager_proxy_1
8e96a0e8b993        eqidmanager_app     "dotnet EqidManage..."   24 hours ago        Up 24 hours (healthy)   80/tcp               eqidmanager_app_1
时间:2019-05-09 14:52:29 阅读(13)

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


本文将从上往下,循序渐进的介绍一系列相关.NET的概念,先从类型系统开始讲起,我将通过跨语言操作这个例子来逐渐引入一系列.NET的相关概念,这主要包括:CLS、...
基于 .NET 的一个全新的、好用的 PHP SDK + Runtime: PeachPie 来啦!
.NET 异步工作原理介绍。
引子 .NET 6 开始初步引入 PGO。PGO 即 Profile Guided Optimization,通过收集运行时信息来指导 JIT 如何优化代码,相比以前没有 PGO 时可以做更多以前难以
前言 2021/4/8 .NET 6 Preview 3 发布,这个版本的改进大多来自于底层,一起来看看都有什么新特性和改进吧。 库改进 新增值类型作为字典值时更快的处理方法 .NET 6 Previ
前言 开头防杠:.NET 的基础库、语言、运行时团队从来都是相互独立各自更新的,.NET 6 在基础库、运行时上同样做了非常多的改进,不过本文仅仅介绍语言部分。 距离上次介绍 C# 10 的特性已经有
直接使用 CIL - .NET 上的汇编语言编写 .NET Standard 类库
前言 不知不觉中,.NET Framework 已经更新到 4.8,.NET Core 也更新到了 3.0 版本。那么 .NET 的未来怎么样呢? 计划 2019 年 Build 大会上,微软宣布下一
本文带你穿越到未来一起看看未来的 C# 到底长什么样子。
前言 TypedocConverter 是我先前因帮助维护 monaco-editor-uwp 但苦于 monaco editor 的 API 实在太多,手写 C# 的类型绑定十分不划算而发起的一个项
前言 在 2021 年 3 月 11 日, .NET 6 Preview 2 发布,这次的改进主要涉及到 MAUI、新的基础库和运行时、JIT 改进。 .NET 6 正式版将会在 2021 年 11
前言 命名空间已经在 .NET 中使用了多年,一直追溯到 .NET Framework 1.1。它在 .NET 实施本身的数百个位置中使用,并且直接被成千上万个应用程序使用。在所有这些方面,它也是 C
.NET 上的统一跨平台 UI 框架来啦
使用 F# 手写一个 Typedoc 转 C# 代码生成器,方便一切 C# 项目对 TypeScript 项目的封装。
LINQ + SelectMany = Monad!
C# 10 主要特性一览
C# 的编译期反射终于来啦!
前言 2021 年 2 月 17 日微软发布了 .NET 6 的 Preview 1 版本,那么来看看都有什么新特性和改进吧,由于内容太多了因此只介绍一些较为重点的项目。ASP.NET Core 6
前言 有一个东西叫做鸭子类型,所谓鸭子类型就是,只要一个东西表现得像鸭子那么就能推出这玩意就是鸭子。 C 里面其实也暗藏了很多类似鸭子类型的东西,但是很多开发者并不知道,因此也就没法好好利用这些东西,
经过五年半的持续维护,Senparc.Weixin SDK 逐步丰满和完善,在升级的过程中,我们为基础库(Senparc.Weixin.dll)加入了许多通用的功能,例如加密/解密算法、通用缓存方法等