网站部署上线后, 总是担心网站是否工作正常, 内存压力是否很大, 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”) //检查工作队列

参考自Health checks in ASP.NET Core

 
 

15人点赞

 
ASPNET

 

AspNetCore 2.2 新特性---HealthCheck的更多相关文章

  1. Asp.net Core中SignalR Core预览版的一些新特性前瞻,附源码(消息订阅与发送二进制数据)

    目录 SignalR系列目录(注意,是ASP.NET的目录.不是Core的) 前言 一晃一个月又过去了,上个月有个比较大的项目要验收上线.所以忙的脚不沾地.现在终于可以忙里偷闲,写一篇关于Signal ...

  2. ASP.NET Core 2.0 Preview 1 中贴心的新特性

    西雅图时间5月10日,微软在 Build 2017 大会上发布了 ASP.NET Core 2.0 Preview 1 ( 详见 Announcing ASP.NET 2.0.0-Preview1 a ...

  3. efcore 新特性 SaveChanges Events

    efcore 新特性 SaveChanges Events Intro 昨天早上看到之前关注的一个 efcore 的 issue 被 closed ,于是看了一眼, ef core 新合并了一个 PR ...

  4. 尝新体验ASP.NET Core 6预览版本中发布的最小Web API(minimal APIS)新特性

    本文首发于<尝新体验ASP.NET Core 6预览版本中发布的最小Web API(minimal APIS)新特性> 概述 .NET开发者们大家好,我是Rector. 几天前(美国时间2 ...

  5. ABP 6.0.0-rc.1的新特性

      2022-07-26官方发布ABP 6.0.0-rc.1版本,本文挑选了几个新特性进行了介绍,主要包括LeptonX Lite默认主题.OpenIddict模块,以及如何将Identity Ser ...

  6. SQL Server 2014 新特性——内存数据库

    SQL Server 2014 新特性——内存数据库 目录 SQL Server 2014 新特性——内存数据库 简介: 设计目的和原因: 专业名词 In-Memory OLTP不同之处 内存优化表 ...

  7. ElasticSearch 5学习(10)——结构化查询(包括新特性)

    之前我们所有的查询都属于命令行查询,但是不利于复杂的查询,而且一般在项目开发中不使用命令行查询方式,只有在调试测试时使用简单命令行查询,但是,如果想要善用搜索,我们必须使用请求体查询(request ...

  8. [干货来袭]C#6.0新特性

    微软昨天发布了新的VS 2015 ..随之而来的还有很多很多东西... .NET新版本 ASP.NET新版本...等等..太多..实在没消化.. 分享一下也是昨天发布的新的C#6.0的部分新特性吧.. ...

  9. CSS3新特性应用之结构与布局

    一.自适应内部元素 利用width的新特性min-content实现 width新特性值介绍: fill-available,自动填充盒子模型中剩余的宽度,包含margin.padding.borde ...

随机推荐

  1. 软件测试之Monkey 初步了解(入门级)

    monkey 介绍 Monkey是Google提供的一个用于稳定性与压力测试的命令行工具.可以运行在模拟器或者实际设备中.它向系统发送伪随机的用户事件(如按键.手势.触摸屏等输入),对软件进行稳定性与 ...

  2. spark运行时加载配置文件(hive,hdfs)

    文章为转载,如有版权问题,请联系,谢谢! 转自:https://blog.csdn.net/piduzi/article/details/81636253 适合场景:在运行时才确定用哪个数据源 imp ...

  3. 将表格转化为Latex代码的在线工具

    这个在线工具的网址为:http://www.tablesgenerator.com/latex_tables,好用.

  4. css实现input文本框的双边框美化

    <!DOCTYPE html><html><head><meta http-equiv="Content-Type" content=&q ...

  5. GAME-BASED LEARNING

    https://collegestar.org/modules/game-based-learning Introduction   Appalachian State University Game ...

  6. Java Polymorphism

    Ability of an organism to take different shapes is polymorphism in bio world. A simplest definition ...

  7. day001-在Windows下python环境的搭建

    一.Python下载 1.Python最新源码,二进制文档,新闻资讯等可以在Python的官网查看到: 2.Python官网:https://www.python.org/ 3.你可以在以下链接中下载 ...

  8. leetcode 合并重叠区间变异 合并多个时间段 取并集

    public class Solution { public static ArrayList<Interval> merge(ArrayList<Interval> inte ...

  9. MongoDB 中文的全文索引

    MongoDB 从3.2 版本以后添加了对中文索引的支持: 官网链接:https://docs.mongodb.com/manual/reference/text-search-languages/ ...

  10. 2.深入学习Servlet的ServletContext对象

    一.建立项目servlet01 在入门Servlet项目中建立一个子项目模块(此处不再赘述如何建立),补全maven项目中的java和resources文件夹,添加类HelloServlet.java ...