如何给asp.net core写个简单的健康检查

 更新时间:2019年05月18日 13:13:20   作者:weihanli  
这篇文章主要给大家介绍了关于如何给asp.net core写个简单的健康检查的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用asp.net core具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧

Intro

健康检查可以帮助我们知道应用的当前状态是不是处于良好状态,现在无论是 docker 还是 k8s 还是现在大多数的服务注册发现大多都提供了健康检查机制来检测应用的健康状态,如果应用本身就提供一个健康检查的机制会更友好,更能真实的反映出应用的健康状态。

我们的开发环境虚拟机配置有点低,所以有时候虚拟机会卡死。。导致接口无响应,有时可能有些服务启动有问题会挂掉,所以需要一个简单的健康检查机制去检查应用的健康状态来第一时间知道应用出现异常。

健康检查扩展实现

实现源码

  public static IApplicationBuilder UseHealthCheck(this IApplicationBuilder applicationBuilder)
  {
   return UseHealthCheck(applicationBuilder, new PathString("/api/health"));
  }

  public static IApplicationBuilder UseHealthCheck(this IApplicationBuilder applicationBuilder, string path)
  {
   return UseHealthCheck(applicationBuilder, new PathString(path));
  }

  public static IApplicationBuilder UseHealthCheck(this IApplicationBuilder applicationBuilder, PathString path)
  {
   applicationBuilder.Map(path, builder => builder.Use(
    (context, next) =>
    {
     context.Response.StatusCode = 200;
     return context.Response.WriteAsync("healthy");
    }));
   return applicationBuilder;
  }

  public static IApplicationBuilder UseHealthCheck(this IApplicationBuilder applicationBuilder, string path, Func<IServiceProvider, bool> checkFunc)
  {
   return UseHealthCheck(applicationBuilder, new PathString(path), serviceProvider => Task.FromResult(checkFunc(serviceProvider)));
  }

  public static IApplicationBuilder UseHealthCheck(this IApplicationBuilder applicationBuilder, string path,
   Func<IServiceProvider, Task<bool>> checkFunc)
  {
   return UseHealthCheck(applicationBuilder, new PathString(path), checkFunc);
  }

  public static IApplicationBuilder UseHealthCheck(this IApplicationBuilder applicationBuilder, PathString path, Func<IServiceProvider, bool> checkFunc)
  {
   if (checkFunc == null)
   {
    checkFunc = serviceProvider => true;
   }
   return UseHealthCheck(applicationBuilder, path, serviceProvider => Task.FromResult(checkFunc(serviceProvider)));
  }

  public static IApplicationBuilder UseHealthCheck(this IApplicationBuilder applicationBuilder, PathString path, Func<IServiceProvider, Task<bool>> checkFunc)
  {
   if (checkFunc == null)
   {
    checkFunc = serviceProvider => Task.FromResult(true);
   }
   applicationBuilder.Map(path, builder => builder.Use(
    async (context, next) =>
    {
     try
     {
      var healthy = await checkFunc.Invoke(context.RequestServices);
      if (healthy)
      {
       context.Response.StatusCode = StatusCodes.Status200OK;
       await context.Response.WriteAsync("healthy");
      }
      else
      {
       context.Response.StatusCode = StatusCodes.Status503ServiceUnavailable;
       await context.Response.WriteAsync("unhealthy");
      }
     }
     catch (Exception ex)
     {
      context.RequestServices.GetService<ILoggerFactory>().CreateLogger("HealthCheck").Error(ex);
      context.Response.StatusCode = StatusCodes.Status503ServiceUnavailable;
      await context.Response.WriteAsync("unhealthy");
     }
    }));
   return applicationBuilder;
  }

配置健康检查

在 Startup 里配置健康检查,示例代码

app.UseHealthCheck(); // 最基本的健康检查, 默认检查路径为 ""/api/health",直接返回 healthy
app.UseHealthCheck("/heath"); // 配置健康检查的路径为 "/health",直接返回 healthy

app.UseHealthCheck("/health", serviceProvider =>
 {
  // 检查数据连接是否正常,这里只是一个示例,可以根据需要自定义自己的实现
  var configuration = serviceProvider.GetService<IConfiguration>();
  var connString = configuration.GetConnectionString("DefaultConnection");
  try
  {
   using (var conn = new SqlConnection(connString))
   {
    conn.EnsureOpen();
   }
   return true;
  }
  catch (Exception)
  {
   return false;
  }
 });

实际效果

直接启动访问 "/health"

数据库连接改为一个错误的连接,修改数据库名称为一个不存在的数据库

End

这个实现比较简单,只是实现一个比较简单的检查,最初的想法比较简单只是看某个应用是否正常工作,具体的检查逻辑可以自定义。官方的 HealthChecks 的实现稍为复杂,下次单独写一篇文章介绍。

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对脚本之家的支持。

相关文章

  • 上传图片后使用数据库保存图片的示例分享

    上传图片后使用数据库保存图片的示例分享

    这篇文章主要介绍了上传图片后使用数据库保存图片的示例,需要的朋友可以参考下
    2014-03-03
  • .NET 4.5 异步IO 相关实例

    .NET 4.5 异步IO 相关实例

    本篇文章小编为大家介绍,.NET 4.5 异步IO 相关实例,需要的朋友参考下
    2013-04-04
  • 使用vs2019加.net core 对WeiApi的创建过程详解

    使用vs2019加.net core 对WeiApi的创建过程详解

    这篇文章主要介绍了使用vs2019加.net core 对WeiApi的创建,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • asp.net(c#)判断远程图片是否存在

    asp.net(c#)判断远程图片是否存在

    不错的应用,大家可以拓展到,判断远程文件是否存在等功能
    2008-09-09
  • .NET CORE中使用AutoMapper进行对象映射的方法

    .NET CORE中使用AutoMapper进行对象映射的方法

    这篇文章主要给大家介绍了关于.NET CORE中使用AutoMapper进行对象映射的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用.NET CORE具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-04-04
  • 为Visual Studio2019添加Git组件

    为Visual Studio2019添加Git组件

    这篇文章介绍了为Visual Studio2019添加Git组件的方法,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-04-04
  • IIS上部署你的ASP.NET Core Web Api项目及Swagger(图文)

    IIS上部署你的ASP.NET Core Web Api项目及Swagger(图文)

    本篇经验将和大家介绍如何在IIS上部署ASP.NET Core项目,对大家的学习或者工作具有一定的参考学习价值,希望为初学.NET CORE的童靴入门有所帮助
    2023-09-09
  • Asp.Net Core中WebSocket绑定的方法详解

    Asp.Net Core中WebSocket绑定的方法详解

    WebSocket 是一种在单个 TCP 连接上进行全双工通讯的协议,是建立在TCP上、且独立的协议。下面这篇文章主要给大家介绍了关于Asp.Net Core中WebSocket绑定的方法,需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-12-12
  • asp.net下实现URL重写技术的代码

    asp.net下实现URL重写技术的代码

    asp.net下实现URL重写技术的代码...
    2007-10-10
  • asp.NET 脏字过滤算法 修改版

    asp.NET 脏字过滤算法 修改版

    我们网站的脏字字典中大概有600多个词,而且会发生变化,因此简单的在数据新增/修改的时候做一次脏字过滤是不够的。在网站从.NET 1.1到2.0改版的时候,对新版的测试发现旧的脏字过滤算法耗费的时间过长,需要做一些优化。
    2009-10-10

最新评论