AspNetCore 2.2 新特性---HealthCheck

网站部署上线后， 总是担心网站是否工作正常， 内存压力是否很大， CPU是否超负荷了？当然， 我们有一大套系统， perfromance counter， 监控软件来监视运维生产系统。但是这些第三方软件，不是要钱就是很难用。有时候，我们只是给客户上线一个小网站，完全没有时间，也没有兴趣去搭建一套完整的监控系统。

当然，自己写一个WebAPI， 向外部报告自己内部的状况，已经相关联的第三方软件（如SQL， redis）的状况， 不复杂但也不是一两个小时候就可以写好的，很多时候犯懒就不写了。

HealthAPI一般不希望无关人员查看， 可以通过AspNetCore 限流中间件IpRateLimitMiddleware 介绍 来限制特定IP可以访问。

AspNetCore 2.2中提供了一系列pakcage， 只要几行代码，就可以很简单实现网站健康状况报告，没有理由不提供内部health报告了。而且Docker越来越流行了，Kubernetes管理容器，也许要知道容器是否出现问题需要重启， 也需要提供一个标准方法，告诉外部，容器内部状态。

简单应用

只要注册服务AddHealthChecks, 然后在app.UseHealthChecks("/health"); 开启端点报告内部状态。

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddHealthChecks();
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        app.UseHealthChecks("/health");

        app.Run(async (context) =>
        {
            await context.Response.WriteAsync(
                "Navigate to /health to see the health status.");
        });
    }

访问端口 /Health 的返回结果为

Healthy

这是最基础的Health端口，好像没什么功能， 稍安勿躁，马上就有更精彩的。。。

报告外部依赖项的健康状况

程序运行需要内存， cpu，需要磁盘空间， 现在的网站更是依赖于各种各样的第三方系统， 比如：数据库， 缓存等等。这些东西如果不正常，我们的网站也不可能正常运行。好消息是， ASPNetCore提供了大量的辅助类型，来提供这些系统是否正常：

首先需要安装下面的nuget包

Install-Package AspNetCore.HealthChecks.System
Install-Package AspNetCore.HealthChecks.Network
Install-Package AspNetCore.HealthChecks.SqlServer
Install-Package AspNetCore.HealthChecks.MongoDb
Install-Package AspNetCore.HealthChecks.Npgsql
Install-Package AspNetCore.HealthChecks.Redis
Install-Package AspNetCore.HealthChecks.AzureStorage
Install-Package AspNetCore.HealthChecks.AzureServiceBus
Install-Package AspNetCore.HealthChecks.MySql
Install-Package AspNetCore.HealthChecks.DocumentDb
Install-Package AspNetCore.HealthChecks.SqLite
Install-Package AspNetCore.HealthChecks.Kafka
Install-Package AspNetCore.HealthChecks.RabbitMQ
Install-Package AspNetCore.HealthChecks.IdSvr
Install-Package AspNetCore.HealthChecks.DynamoDB
Install-Package AspNetCore.HealthChecks.Oracle
Install-Package AspNetCore.HealthChecks.Uris

        public void ConfigureServices(IServiceCollection services)
        {
 services.AddHealthChecks()
                    //System
                    .AddPrivateMemoryHealthCheck(1000_000_000L) //最大私有内存不超过1GB
                    .AddVirtualMemorySizeHealthCheck(1000_000_000L) //最大虚拟内存不超过1GB
                    .AddWorkingSetHealthCheck(1000_000_000L)//最大工作内存不超过1GB
                    .AddDiskStorageHealthCheck( x=> x.AddDrive("c",1000_000_000L)) //C盘需要超过1GB自由空间
                    //network
                    .AddSmtpHealthCheck(x => { x.Host = "mailserver"; x.Port = 110; x.ConnectionType = SmtpConnectionType.TLS; }) //检查邮件服务器是否正常
                    //sqlserver
                    .AddSqlServer("ConnectionStrings");
                    //redis
                    .AddRedis("RedisServerLink")
                    ;
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            app.UseHealthChecks("/health",
                new HealthCheckOptions
                {
                    ResponseWriter = async (context, report) =>
                    {
                        var result = JsonConvert.SerializeObject(
                            new
                            {
                                status = report.Status.ToString(),
                                errors = report.Entries.Select(e => new { key = e.Key, value = Enum.GetName(typeof(HealthStatus), e.Value.Status) })
                            });
                        context.Response.ContentType = MediaTypeNames.Application.Json;
                        await context.Response.WriteAsync(result);
                    }
                });

            app.Run(async (context) =>
            {
                await context.Response.WriteAsync(
                    "Navigate to /health to see the health status.");
            });
        }

很棒吧， 一下就可以知道应用是否正常， 如果不正常，是因为什么不正常。 如果是内存， cpu过高， 也许需要重启一下。

自定义健康检查

预定义的health检查器用起来很棒， 但是总是会有一些特殊要求， 比如我们要检查内部工作队列是否太大， 启用的线程是否太多等， 这就需要自己写Health检查器。 好消息是， 只要实现IHealthCheck这个接口就好。

public class WorkQueueHealthCheck : IHealthCheck
    {
        private readonly IOptionsMonitor<WorkQueueCheckOptions> _options;

        public WorkQueueHealthCheck(IOptionsMonitor<WorkQueueCheckOptions> options)
        {
            _options = options;
        }

        public string Name => "工作队列检查";

        public Task<HealthCheckResult> CheckHealthAsync(
            HealthCheckContext context, 
            CancellationToken cancellationToken = default(CancellationToken))
        {
            HealthStatus status = HealthStatus.Healthy;
                 
            if (staticQueues.Length > 10000)
            {
                status = HealthStatus.Unhealthy; //待处理的任务太多了， 不健康了。
            }else if (staticQueues.Length > 1000)
            {
                status = HealthStatus.Degraded; //待处理的任务有点多， 降级了。
            }
            var data = new Dictionary<string, object>()
            {
                { "当前工作队列长度", staticQueues.Length },
            };

            return Task.FromResult(new HealthCheckResult(
                status,
                description: "报告内部工作队列情况",
                exception: null,
                data: data));
        }
    }

    public static class HealthCheckBuilderExtensions
    {
        public static IHealthChecksBuilder AddWorkQueueHealthCheck(
            this IHealthChecksBuilder builder,
            string name,
            HealthStatus? failureStatus = null,
            IEnumerable<string> tags = null,
            long? thresholdInBytes = null)
        {
            // Register a check of type GCInfo.
            builder.AddCheck<WorkQueueHealthCheck>(
                name, failureStatus ?? HealthStatus.Degraded, tags);
            return builder;
        }
    }

定义好自己的健康检查扩展以后， 只需要像使用预定义的扩展一样，非常方便。

services.AddHealthChecks()
.AddPrivateMemoryHealthCheck(“workQueue”) //检查工作队列