前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Docker-HealthCheck指令探测ASP.NET Core容器健康状态

Docker-HealthCheck指令探测ASP.NET Core容器健康状态

作者头像
有态度的马甲
发布2020-04-16 15:06:32
1.4K0
发布2020-04-16 15:06:32
举报
文章被收录于专栏:精益码农

写在前面

HealthCheck 不仅是对应用程序内运行情况、数据流通情况进行检查,还包括应用程序对外部服务或依赖资源的健康检查。 健康检查通常是以暴露应用程序的HTTP端点的形式实施,可用于配置健康探测的的场景有 :

  1. 容器或负载均衡器 探测应用状态,执行既定策略,例如:容器探测到应用unhealthy可终止后续的滚动部署或者重启容器;负载均衡器探测到实例unhealthy能将请求路由到健康的运行实例。
  2. 对应用程序种依赖的第三方服务进行健康探测,比如redis、database、外部服务接口
  3. 内存、硬盘、网络等物理依赖资源的探测

HealthCheck提供对外暴露程序运行状态的机制。

容器HEALTHCHECK指令

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

Dockerfile HEALTHCHECK指令提供了探测容器以预期工作的轮询机制,轮询内容可由应用自身决定。

具体而言:通过在容器内运行shell命令来探测容器健康状态,以Shell命令的退出码表示容器健康状态:

0 指示容器健康 1 指示容器不健康 2 指示不使用这个退出码

代码语言:javascript
复制
// 可定义轮询interval、探测超时timeout、 重试retries参数轮询探测
HEALTHCHECK [OPTIONS] CMD command

Every Linux or Unix command executed by the shell script or user has an exit status. Exit status is an integer number. 0 exit status means the command was successful without any errors. A non-zero (1-255 values) exit status means command was a failure. linux shell执行成功,返回0;为对接Docker-HealcthCheck失败退出码1,要对Shell执行失败返回退出码1

对Web应用,自然会联想到使用curl命令访问端点去探测容器应用: curl web端点成功,命令返回0(真);curl web端点失败,命令返回非0(假)

代码语言:javascript
复制
// curl -f 表示请求失败返静默输出
HEALTHCHECK --interval=5m --timeout=3s --retries=3 CMD curl -f http://localhost:5000/healthz || exit 1

探测命令在stdout或stderr输出的任何内容会在容器Health Status中存储,可通过docker inspect [ContainerId] 查看HealthCheck状态。

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

ASP.NET Core实现HealthCheck端点

ASPNET Core在2.2版本内置了健康检查的能力:终端中间件(满足该路径的url请求,将会被该中间件处理)。

代码语言:javascript
复制
public void ConfigureServices(IServiceCollection services)
{
    services.AddHealthChecks();
}
 
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseHealthChecks("/healthcheck");
}

Asp.NetCore 3.1将健康检查集成在 EndPoints,请自行修改。

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

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

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

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

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

开源社区对HealthCheck的支持

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

下面的步骤演示了对web程序HTTP请求、Redis、Sqlite等服务进行健康检查的端点配置 ① 引入AspNetCore.HealthChecks.Redis 、 AspNetCore.HealthChecks.Sqlite nuget库 ② Startup.cs配置并启用健康检查

代码语言:javascript
复制
// 以下代码截取自 Startup.ConfigureServices方法,对swagger服务地址、redis、sqlte进行健康检查
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枚举值

再次强调,容器HealthCheck指令不关注Shell命令的执行过程,只关注shell命令的执行结果

代码语言:javascript
复制
// docker-compose.yml文件健康检查 参考如下配置:
healthcheck:
      test: curl -f http://localhost/healthcheck || exit 1
      interval: 1m30s
      timeout: 10s
      retries: 3

HealthChecks-UI 了解一下

抛开Docker的HEALTHCHECK指令、负载均衡器的轮询机制不谈,我们的Web自身也可以进行 轮询健康检查并给出告警。

就我们上面的Web 实例来说,我们只对外提供的是一个 /healthcheck 检查端点,引入HealthChecks.UI.dll 将会在前端生成友好的HealthReport 界面, 该库支持后台轮询检查、支持webhook 通知。

这里就不展开说明,自行前往AspNetCore.Diagnostics.HealthChecks查看相应文档,效果如下

至此,本文内容完毕:

  • 使用ASP.NET Core框架实现一个稍复杂的HealthCheck端点 /healthz
  • 使用docker的HEALTHCHECK指令对接Web应用健康检查端点
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2020-04-02,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 精益码农 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 写在前面
  • 容器HEALTHCHECK指令
  • ASP.NET Core实现HealthCheck端点
  • 开源社区对HealthCheck的支持
  • HealthChecks-UI 了解一下
相关产品与服务
容器镜像服务
容器镜像服务(Tencent Container Registry,TCR)为您提供安全独享、高性能的容器镜像托管分发服务。您可同时在全球多个地域创建独享实例,以实现容器镜像的就近拉取,降低拉取时间,节约带宽成本。TCR 提供细颗粒度的权限管理及访问控制,保障您的数据安全。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档