2. 程式人生 > >.NET Core 3.0之深入原始碼理解HealthCheck（一）

.NET Core 3.0之深入原始碼理解HealthCheck（一）

阿新 • • 發佈：2019-12-02

寫在前面

我們的系統可能因為正在部署、服務異常終止或者其他問題導致系統處於非健康狀態，這個時候我們需要知道系統的健康狀況，而健康檢查可以幫助我們快速確定系統是否處於正常狀態。一般情況下，我們會提供公開的HTTP介面，用於專門化健康檢查。

NET Core提供的健康檢查庫包括Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions和Microsoft.Extensions.Diagnostics.HealthChecks。這兩個庫共同為我們提供了最基礎的健康檢查的解決方案，後面擴充套件的元件主要有下面幾個，本文不作其他說明。

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

原始碼探究

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions是.NET Core健康檢查的抽象基礎，從中我們可以看出這個庫的設計意圖。它提供了一個統一的介面IHealthCheck，用於檢查應用程式中各個被監控元件的狀態，包括後臺服務、資料庫等。這個介面只有一個方法CheckHealthAsync，

該方法有一個引數是HealthCheckContext，它表示當前健康檢查執行時所關聯的上下文物件，它的返回值HealthCheckResult表示當前健康檢查結束後所產生的被監控元件的執行狀態。

原始碼如下所示：

   1:  public interface IHealthCheck
   2:  {
   3:      Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default);
   4:  }

HealthCheckRegistration

HealthCheckContext裡面只有一個成員就是HealthCheckRegistration例項。

而HealthCheckRegistration是一個相當重要的物件，它體現了健康檢查需要關注和注意的地方，其內部涉及到五個屬性，分別用於：

  • 標識健康檢查名稱
  • 建立IHealthCheck例項
  • 健康檢查的超時時間（防止我們因為健康檢查而過多佔用資源）
  • 失敗狀態標識
  • 一個標籤集合（可用於健康檢查過濾）

這五個屬性的相關原始碼如下：

   1:  public Func<IServiceProvider, IHealthCheck> Factory
   2:  {
   3:      get => _factory;
   4:      set
   5:      {
   6:          if (value == null)
   7:          {
   8:              throw new ArgumentNullException(nameof(value));
   9:          }
  10:      
  11:          _factory = value;
  12:      }
  13:  }
  14:      
  15:  public HealthStatus FailureStatus { get; set; }
  16:      
  17:  public TimeSpan Timeout
  18:  {
  19:      get => _timeout;
  20:      set
  21:      {
  22:          if (value <= TimeSpan.Zero && value != System.Threading.Timeout.InfiniteTimeSpan)
  23:          {
  24:              throw new ArgumentOutOfRangeException(nameof(value));
  25:          }
  26:      
  27:          _timeout = value;
  28:      }
  29:  }
  30:      
  31:  public string Name
  32:  {
  33:      get => _name;
  34:      set
  35:      {
  36:          if (value == null)
  37:          {
  38:              throw new ArgumentNullException(nameof(value));
  39:          }
  40:      
  41:          _name = value;
  42:      }
  43:  }
  44:      
  45:  public ISet<string> Tags { get; }

 

HealthCheckResult

HealthCheckResult是一個結構體，可以看出這裡更多的是基於承擔資料儲存和效能問題的考量。

HealthCheckResult用於表示健康檢查的相關結果資訊，同樣的，通過該類，我們知道了健康檢查需要關注的幾個點：

  • 元件的當前狀態
  • 異常資訊
  • 友好的描述資訊（不管是異常還是正常）
  • 額外可描述當前元件的鍵值對，這是一個開放式的屬性，方面我們記錄更多資訊

該類含有四個公共屬性，和三個方法，相關原始碼如下：

   1:  public struct HealthCheckResult
   2:  {
   3:      private static readonly IReadOnlyDictionary<string, object> _emptyReadOnlyDictionary = new Dictionary<string, object>();
   4:   
   5:      public HealthCheckResult(HealthStatus status, string description = null, Exception exception = null, IReadOnlyDictionary<string, object> data = null)
   6:      {
   7:          Status = status;
   8:          Description = description;
   9:          Exception = exception;
  10:          Data = data ?? _emptyReadOnlyDictionary;
  11:      }
  12:   
  13:      public IReadOnlyDictionary<string, object> Data { get; }
  14:   
  15:      public string Description { get; }
  16:   
  17:      public Exception Exception { get; }
  18:   
  19:      public HealthStatus Status { get; }
  20:   
  21:      public static HealthCheckResult Healthy(string description = null, IReadOnlyDictionary<string, object> data = null)
  22:      {
  23:          return new HealthCheckResult(status: HealthStatus.Healthy, description, exception: null, data);
  24:      }
  25:   
  26:      public static HealthCheckResult Degraded(string description = null, Exception exception = null, IReadOnlyDictionary<string, object> data = null)
  27:      {
  28:          return new HealthCheckResult(status: HealthStatus.Degraded, description, exception: exception, data);
  29:      }
  30:      
  31:      public static HealthCheckResult Unhealthy(string description = null, Exception exception = null, IReadOnlyDictionary<string, object> data = null)
  32:      {
  33:          return new HealthCheckResult(status: HealthStatus.Unhealthy, description, exception, data);
  34:      }
  35:  }

可以看出這個三個方法都是基於HealthStatus這個列舉而建立不同狀態的HealthCheckResult例項，這個列舉表達了健康檢查需要關注的幾種狀態，健康、異常以及降級。

HealthStatus的原始碼如下：

   1:  public enum HealthStatus
   2:  {
   3:      Unhealthy = 0,
   4:   
   5:      Degraded = 1,
   6:   
   7:      Healthy = 2,
   8:  }

IHealthCheckPublisher

健康檢查功能本質上是一種輪詢功能，需要定期執行，.NET Core 抽象定期執行的介面，即IHealthCheckPublisher，我們可以通過實現這個介面，並與我們自定義的定時功能相結合。

同時，作為一次健康檢查，我們還需要關注相關的健康檢查報告，那麼我們需要關注那些點呢？

  • 額外可描述當前元件的鍵值對，這是一個開放式的屬性，方面我們記錄更多資訊
  • 友好的描述資訊（不管是異常還是正常）
  • 元件的當前狀態
  • 異常資訊
  • 當前這次檢查所耗費的時間
  • 相關的標籤資訊

HealthReportEntry表示單個健康檢查報告，HealthReport表示一組健康檢查報告。HealthReport內部維護了一個HealthReportEntry的字典資料，HealthReport原始碼如下所示：

   1:  public sealed class HealthReport
   2:  {
   3:      public HealthReport(IReadOnlyDictionary<string, HealthReportEntry> entries, TimeSpan totalDuration)
   4:      {
   5:          Entries = entries;
   6:          Status = CalculateAggregateStatus(entries.Values);
   7:          TotalDuration = totalDuration;
   8:      }
   9:   
  10:      public IReadOnlyDictionary<string, HealthReportEntry> Entries { get; }
  11:   
  12:      public HealthStatus Status { get; }
  13:   
  14:      public TimeSpan TotalDuration { get; }
  15:   
  16:      private HealthStatus CalculateAggregateStatus(IEnumerable<HealthReportEntry> entries)
  17:      {
  18:          var currentValue = HealthStatus.Healthy;
  19:          foreach (var entry in entries)
  20:          {
  21:              if (currentValue > entry.Status)
  22:              {
  23:                  currentValue = entry.Status;
  24:              }
  25:   
  26:              if (currentValue == HealthStatus.Unhealthy)
  27:              {
  28:                  // Game over, man! Game over!
  29:                  // (We hit the worst possible status, so there's no need to keep iterating)
  30:                  return currentValue;
  31:              }
  32:          }
  33:   
  34:          return currentValue;
  35:      }
  36:  }

總結

通過以上內容，我們知道了，一個完整的健康檢查需要關注健康檢查上下文、健康狀態的維護、健康檢查結果、健康檢查報告，同時，為了更好的維護健康檢查，我們可以將健康檢查釋出抽象出來，並與外部的定時器相結合，共同守護健康檢查程

相關推薦

.NET Core 3.0之深入原始碼理解HealthCheck（一）

寫在前面 我們的系統可能因為正在部署、服務異常終止或者其他問題導致系統處於非健康狀態，這個時候我們需要知道系統的健康狀況，而健康檢查可以幫助我們快速確定系統是否處於正常狀態。一般情況下，我們會提供公開的HTTP介面，用於專門化健康檢查。 NET Core提供的健康檢查庫包括Microsoft.Extensio

.NET Core 3.0之深入原始碼理解ObjectPool（一）

寫在前面 物件池是一種比較常用的提高系統性能的軟體設計模式，它維護了一系列相關物件列表的容器物件，這些物件可以隨時重複使用，物件池節省了頻繁建立物件的開銷。 它使用取用/歸還-重複取用的操作模式，如下圖所示： 本文將主要介紹物件池的基本概念、物件池的優勢及其工作機制，下一篇文件將從原始碼角度介紹.NET

.NET Core 3.0之深入原始碼理解ObjectPool（二）

寫在前面 前文主要介紹了ObjectPool的一些理論基礎，本文主要從原始碼角度理解Microsoft.Extensions.ObjectPool是如何實現的。下圖為其三大核心元件圖： 核心元件 ObjectPool ObjectPool是一個泛型抽象類，裡面只有兩個抽象方法，Get和Return。它從底

.NET Core 3.1之深入原始碼理解HealthCheck（二）

寫在前面前文討論了HealthCheck的理論部分，本文將討論有關HealthCheck的應用內容。可以監視記憶體、磁碟和其他物理伺服器資源的使用情況來了解是否處於正常狀態。執行狀況檢查可以測試應用的依賴項（如資料庫和外部服務終結點）以確認是否可用和正常工作。執行狀況探測可以由容器業務流程協調程式和負載均衡器

.NET Core 3.0之深入原始碼理解Configuration(二)

檔案型配置基本內容 上一篇文章討論了Configuration的幾個核心物件，本文繼續討論Configuration中關於檔案型配置的相關內容。相比較而言，檔案型配置的使用場景更加廣泛，使用者自定義配置擴充套件也可以基於檔案型配置進行擴充套件。如果需要檢視上一篇文章，可以點選移步。 .NET Core檔案型配

.NET Core 3.0之深入原始碼理解Configuration(三)

寫在前面 上一篇文章討論了檔案型配置的基本內容，本篇內容討論JSON型配置的實現方式，理解了這一種配置型別的實現方式，那麼其他型別的配置實現方式基本可以觸類旁通。看過了上一篇文章的朋友，應該看得出來似曾相識。此圖主要表達了檔案型配置的實現，當然其他配置，包括自定義配置，都會按照這樣的方式去實現。 JSON

.NET Core 3.0之深入原始碼理解Kestrel的整合與應用(一)

  寫在前面 ASP.NET Core 的 Web 伺服器預設採用Kestrel，這是一個基於libuv(一個跨平臺的基於Node.js非同步I/O庫)的跨平臺、輕量級的Web伺服器。 在開始之前，先回顧一下.NET Core 3.0預設的main()方法模板中，我們會呼叫Host.CreateDe

.NET Core 3.0之深入原始碼理解Kestrel的整合與應用(二)

  前言 前一篇文章主要介紹了.NET Core繼承Kestrel的目的、執行方式以及相關的使用，接下來將進一步從原始碼角度探討.NET Core 3.0中關於Kestrel的其他內容，該部分內容，我們無需掌握，依然可以用好Kestrel，本文只是將一些內部的技術點揭露出來，供自己及大家有一個較

.NET Core 3.0之深入原始碼理解HttpClientFactory(一)

寫在前面 建立HttpClient例項的時候，在內部會建立HttpMessageHandler鏈，我們知道HttpMessageHandler是負責建立連線的抽象處理程式，所以HttpClient的維護實際上就是維護HttpMessageHandler的使用，釋放HttpClient並不會及時釋放連線，而通

.NET Core 3.0之深入原始碼理解HttpClientFactory(二)

  寫在前面 上一篇文章討論了通過在ConfigureServices中呼叫services.AddHttpClient()方法，並基於此進一步探討了DefaultHttpClientFactory是如何建立HttpClient例項和HttpMessageHandler例項的，並瞭解了Defau

.NET Core 3.0之深入原始碼理解Host(二)

  寫在前面 停了近一個月的技術部落格，隨著正式脫離996的魔窟，接下來也正式恢復了。本文從原始碼角度進一步討論.NET Core 3.0 中關於Host擴充套件的一些技術點，主要討論Long Run Program的建立與守護。 關於Host，我們最容易想到的就是程式的啟動與停止，而其中隱藏著非常

.NET Core 3.0之Configuration原始碼探究(一)

Configuration總體介紹 微軟在.NET Core裡設計出了全新的配置體系，並以非常靈活、可擴充套件的方式實現。從其原始碼來看，其執行機制大致是，根據其Source，建立一個Builder例項，並會向其新增Provider，在我們使用配置資訊的時候，會從記憶體中獲取相應的Provider例項。 .N

ASP.NET Core 3.x啟動時執行非同步任務（一）

這是一個大的題目，需要用幾篇文章來說清楚。這是第一篇。   一、前言 在我們的專案中，有時候我們需要在應用程式啟動前執行一些一次性的邏輯。比方說：驗證配置的正確性、填充快取、或者執行資料庫清理/遷移等。 如何合理、有效、優雅地完成這個任務，是這個文章討論的主要內容。   要實現這樣一個功能，其實我們有幾

.NET Core 3.0 之初識Host原始碼

寫在前面 ASP .NET Core中的通用主機構建器是在v2.1中引入的，應用在啟動時構建主機，主機作為一個物件用於封裝應用資源以及應用程式啟動和生存期管理。其主要功能包括配置初始化(包括載入配置以及配置轉換為通用的鍵值對格式)，建立託管環境和Host通用上下文、依賴注入等。 在.NET Core 3.

.NET Core 3.0之建立基於Consul的Configuration擴充套件元件

寫在前面 經過前面三篇關於.NET Core Configuration的文章之後，本篇文章主要討論如何擴充套件一個Configuration元件出來。如果前面三篇文章沒有看到，可以點選如下地址訪問 .NET Core 3.0之深入原始碼理解Configuration(一) .NET C

net core 3.0 之Grpc新特性小試牛刀

  　　相信微服務大傢伙都有聽說和知道，好處弊端咱也不多說了，Grpc算是一個比較全面的微服務框架，也得到微軟的支援 　　總結下來就是，跨平臺，可靠，通訊快，擴充套件性強，網路消耗小，模板多語言通用  　　 　　光說好處，沒有弊端嗎，自然是有的 　　最大的問題可能就是無法直接通過瀏覽器呼叫

ASP.NET Core 3.x啟動時執行非同步任務（二）

這一篇是接著前一篇在寫的。如果沒有看過前一篇文章，建議先去看一下前一篇，這兒是傳送門   一、前言 前一篇文章，我們從應用啟動時非同步執行任務開始，說到了必要性，也說到了幾種解決方法，及各自的優缺點。最後，還提出了一個比較合理的解決方法：通過在Program.cs里加入程式碼，來實現IWebHost啟動

ASP.NET Core 打造一個簡單的圖書館管理系統（一） 基本模型以及數據庫的建立

allow shel 系列 sqlserver rar 刪除數據庫 mvc 5 字段 約定 前言： 本系列文章主要為我之前所學知識的一次微小的實踐，以我學校圖書館管理系統為雛形所作。 本系列文章主要參考資料： 微軟文檔：https://docs.microsoft.c

ASP.NET Core 打造一個簡單的圖書館管理系統（一） 基本模型以及資料庫的建立

前言： 本系列文章主要為我之前所學知識的一次微小的實踐，以我學校圖書館管理系統為雛形所作。 本系列文章主要參考資料： 微軟文件：https://docs.microsoft.com/zh-cn/aspnet/core/getting-started/?view=aspnetcore-2.1&ta

spring cloud+.net core搭建微服務架構：服務註冊（一）

背景 公司去年開始使用dotnet core開發專案。公司的總體架構採用的是微服務，那時候由於對微服務的理解並不是太深，加上各種元件的不成熟，只是把專案的各個功能通過業務層面拆分，然後通過nginx代理，專案最終上線。但是這遠遠沒達到微服務的要求，其中服務治理，斷路器都沒有。我個人理解，我們談微服務實際上更多