快捷導(dǎo)航

.Net Core實(shí)現(xiàn)健康檢查的示例代碼

更新時(shí)間：2019年11月04日 15:15:24 作者：馮輝

這篇文章主要介紹了.Net Core實(shí)現(xiàn)健康檢查的示例代碼，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

ASP.NET Core 提供運(yùn)行狀況檢查中間件和庫(kù)，以用于報(bào)告應(yīng)用基礎(chǔ)結(jié)構(gòu)組件的運(yùn)行狀況。

運(yùn)行狀況檢查由應(yīng)用程序作為 HTTP 終結(jié)點(diǎn)公開(kāi)。可以為各種實(shí)時(shí)監(jiān)視方案配置運(yùn)行狀況檢查終結(jié)點(diǎn)：

運(yùn)行狀況探測(cè)可以由容器業(yè)務(wù)流程協(xié)調(diào)程和負(fù)載均衡器用于檢查應(yīng)用的狀態(tài)。例如，容器業(yè)務(wù)流程協(xié)調(diào)程序可以通過(guò)停止?jié)L動(dòng)部署或重新啟動(dòng)容器來(lái)響應(yīng)失敗的運(yùn)行狀況檢查。負(fù)載均衡器可以通過(guò)將流量從失敗的實(shí)例路由到正常實(shí)例，來(lái)應(yīng)對(duì)不正常的應(yīng)用。
可以監(jiān)視內(nèi)存、磁盤(pán)和其他物理服務(wù)器資源的使用情況來(lái)了解是否處于正常狀態(tài)。
運(yùn)行狀況檢查可以測(cè)試應(yīng)用的依賴項(xiàng)（如數(shù)據(jù)庫(kù)和外部服務(wù)終結(jié)點(diǎn)）以確認(rèn)是否可用和正常工作。

這個(gè)示例展示數(shù)據(jù)庫(kù)的運(yùn)行狀態(tài),他在其驗(yàn)證數(shù)據(jù)庫(kù)連接并返回相應(yīng)的結(jié)果

 [Route("health")]
    public ActionResult Health()
    {
      using (var connection = new SqlConnection("Server=.;Initial Catalog=master;Integrated Security=true"))
      {
        try
        {
          connection.Open();
        }
        catch (SqlException)
        {
          return new StatusCodeResult(503);
        
        }
      }

      return new EmptyResult();
    }

當(dāng)我們請(qǐng)求該地址的時(shí)候時(shí)，如果連接到數(shù)據(jù)庫(kù)時(shí)出現(xiàn)任何連接問(wèn)題，它將顯示一條包含200狀態(tài)代碼和503狀態(tài)代碼的空消息。

現(xiàn)在基于這些結(jié)果狀態(tài)碼,我們可以監(jiān)視系統(tǒng)采取相關(guān)的操作。

從.NET Core2.2開(kāi)始，我們不需要為運(yùn)行狀態(tài)在去自定義檢查控制器和接口，而是框架本身已經(jīng)為我們提供了運(yùn)行狀況的檢查服務(wù)。

安裝和運(yùn)行

Install-Package Microsoft.Extensions.Diagnostics.HealthChecks

安裝后，我們需要在Startup.cs文件的ConfigureServices()和Configure()方法中添加。

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

我們?cè)赾onfigure()方法中配置完端點(diǎn)后，我們就可以通過(guò) /health 來(lái)請(qǐng)求查看我們的應(yīng)用程序的健康程度的。

但是這樣對(duì)于我們剛才的需求是滿足不了的,那么我們?nèi)绾巫远x我們的健康度檢查呢？

兩種方式來(lái)處理

option 1

   public void ConfigureServices(IServiceCollection services)
    {
      services.AddHealthChecks()
 .AddCheck("sql", () =>
 {

   using (var connection = new SqlConnection("Server=.;Initial Catalog=master;Integrated Security=true"))
   {
     try
     {
       connection.Open();
     }
     catch (SqlException)
     {
       return HealthCheckResult.Unhealthy();
     }
   }

   return HealthCheckResult.Healthy();

 });
    }

在這里我們使用匿名方法AddCheck(),來(lái)編寫(xiě)我們的自定義的驗(yàn)證邏輯,結(jié)果是HealthCheckResult對(duì)象,該對(duì)象包含3個(gè)選項(xiàng)

Healthy 健康
Unhealthy 不良
Degraded 降級(jí)

option 2

實(shí)現(xiàn)IHealthCheck接口并實(shí)現(xiàn)CheckHealthAsync()方法，如下所示：

 public class DatabaseHealthCheck : IHealthCheck
    {
      public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken =
       default)
      {
        using (var connection = new SqlConnection("Server=.;Initial Catalog=master;Integrated Security=true"))
        {
          try
          {
            connection.Open();
          }
          catch (SqlException)
          {
            return Task.FromResult(HealthCheckResult.Unhealthy());
          }
        }

        return Task.FromResult(HealthCheckResult.Healthy());

      }
    }

創(chuàng)建該類(lèi)之后，我們需要通過(guò)使用一些有效的唯一名稱，AddCheck ()方法在ConfigureServices()方法中提及該類(lèi)，如下所示。

  public void ConfigureServices(IServiceCollection services)
    {
      services.AddHealthChecks() 
     .AddCheck<DatabaseHealthCheck>("sql");
    }

現(xiàn)在我們的代碼就寫(xiě)完了，我們可以像上面那樣添加任意數(shù)量的Health Task，它將按照我們?cè)诖颂幝暶鞯捻樞蜻\(yùn)行。

自定義狀態(tài)碼

在之前我們也說(shuō)過(guò)200為健康,503為不健康那么Healthcheck服務(wù)甚至通過(guò)以下方式使用其options對(duì)象提供自定義狀態(tài)代碼，為我們提供了更改此默認(rèn)的狀態(tài)碼。

config.MapHealthChecks("/health", new HealthCheckOptions
           {
            ResultStatusCodes = new Dictionary<HealthStatus, int> { { HealthStatus.Unhealthy, 420 }, { HealthStatus.Healthy, 200 }, { HealthStatus.Degraded, 419 } }

             
           });

自定義輸出

我們可以自定義輸出，以獲取有關(guān)每個(gè)運(yùn)行狀況檢查任務(wù)的更清晰詳細(xì)的信息。如果我們有多個(gè)運(yùn)行狀況檢查任務(wù)來(lái)分析哪個(gè)任務(wù)使整個(gè)服務(wù)健康狀態(tài)變?yōu)椤辈徽！埃@將非常有用。

我們可以通過(guò)HealthCheckOptions ResponseWriter屬性來(lái)實(shí)現(xiàn)。

   public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
      app
         .UseRouting()
         .UseEndpoints(config =>
         {
           config.MapHealthChecks("/health", new HealthCheckOptions
           {
            ResponseWriter=CustomResponseWriter
            
           }); 

         });

    }
    private static Task CustomResponseWriter(HttpContext context, HealthReport healthReport)
    {
      context.Response.ContentType = "application/json";

      var result = JsonConvert.SerializeObject(new
      {
        status = healthReport.Status.ToString(),
        errors = healthReport.Entries.Select(e => new
        {
          key = e.Key,
          value = e.Value.Status.ToString()
        })
      });
      return context.Response.WriteAsync(result);

    }

現(xiàn)在以json顯示我們的詳細(xì)信息，完成了健康狀態(tài)的檢查.

健康檢查界面

Install-Package AspNetCore.HealthChecks.UI

安裝完成后，需要相應(yīng)地在ConfigureServices（）和Configure（）方法中調(diào)用相應(yīng)的服務(wù)方法。

public void ConfigureServices(IServiceCollection services) 
{ 
  services.AddHealthChecksUI(); 
} 
 
public void Configure(IApplicationBuilder app, IHostingEnvironment env) 
{ 
  app.UseHealthChecksUI(); 
}

配置完成后，您可以運(yùn)行應(yīng)用程序并指向/ healthchecks-ui地址，該端點(diǎn)顯示如下的UI.

但是界面上沒(méi)有我們剛才自定義的，那我們?cè)谶M(jìn)行配置

Appsetting.json

{
 "ApplicationInsights": {
  "InstrumentationKey": "your-instrumentation-key"
 },
 "Logging": {
  "LogLevel": {
   "Default": "Warning"
  }
 },
 "AllowedHosts": "*",
 "HealthChecksUI": {
  "HealthChecks": [
   {
    "Name": "Test Health",
    "Uri": "https://localhost:44342/health"
   }
  ],
  "EvaluationTimeinSeconds": 10,
  "MinimumSecondsBetweenFailureNotifications": 60
 }
}